{ "openapi": "3.0.1", "info": { "title": "Hacker News Scraper: Stories, Comments & Front Page", "description": "Scrape Hacker News through the official Firebase API: stories, scores, authors, comment trees, Ask HN, Show HN and job posts.", "version": "0.0", "x-build-id": "eSI2D4mnTZDl2PFFB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arman-bd~hacker-news-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arman-bd-hacker-news-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/arman-bd~hacker-news-scraper/runs": { "post": { "operationId": "runs-sync-arman-bd-hacker-news-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/arman-bd~hacker-news-scraper/run-sync": { "post": { "operationId": "run-sync-arman-bd-hacker-news-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "feeds": { "title": "Feeds", "type": "array", "description": "Which Hacker News lists to read. 'topstories' is the front page, 'newstories' is the /newest firehose, 'beststories' is the highest-scoring recent posts, 'askstories' is Ask HN, 'showstories' is Show HN and 'jobstories' is the YC job board. Short forms (top, new, best, ask, show, job) work too.", "items": { "type": "string", "enum": [ "topstories", "newstories", "beststories", "askstories", "showstories", "jobstories" ], "enumTitles": [ "Top (front page)", "New (newest)", "Best", "Ask HN", "Show HN", "Jobs" ] }, "default": [ "topstories" ] }, "maxItems": { "title": "Max items per feed", "minimum": 0, "maximum": 500, "type": "integer", "description": "Stop after this many items from each feed. Firebase serves one item per request, so this is also the main cost control. topstories, newstories and beststories hold up to 500 IDs; Ask HN and Show HN hold about 200; Jobs holds about 30. Set 0 to take everything the feed lists.", "default": 50 }, "includeComments": { "title": "Include comment trees", "type": "boolean", "description": "Fetch replies for each story and nest them under a 'comments' field. Every comment is its own request, so a busy front-page thread can add hundreds of calls. leave this off unless you need discussion text.", "default": false }, "commentDepth": { "title": "Comment depth", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many levels of replies to follow when 'Include comment trees' is on. 1 is top-level replies only, 2 adds replies to those replies, and so on. Each extra level multiplies the number of requests.", "default": 2 }, "minScore": { "title": "Minimum score", "minimum": 0, "type": "integer", "description": "Drop items scoring below this many points. Useful on 'newstories', where most submissions sit at 1-2 points. Leave at 0 to keep everything, including job posts, which have no meaningful score.", "default": 0 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }