{ "openapi": "3.0.1", "info": { "title": "Hacker News Scraper — Stories, Search & Comments API", "description": "Scrape Hacker News front page, new, best, Ask HN and Show HN stories, search all of HN by keyword, points and date, and export full comment threads. Uses the official HN and Algolia APIs: fast, no blocking. Pay per result.", "version": "1.0", "x-build-id": "8jY2LtGHkJsKrpop7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reverend_sal~hacker-news-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reverend_sal-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/reverend_sal~hacker-news-scraper/runs": { "post": { "operationId": "runs-sync-reverend_sal-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/reverend_sal~hacker-news-scraper/run-sync": { "post": { "operationId": "run-sync-reverend_sal-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": { "mode": { "title": "What to scrape", "enum": [ "list", "search", "stories" ], "type": "string", "description": "A Hacker News list (front page, new, best, Ask HN, Show HN), a keyword search across all of HN, or specific stories by ID/URL.", "default": "list" }, "list": { "title": "List", "enum": [ "top", "new", "best", "ask", "show" ], "type": "string", "description": "Used when \"What to scrape\" is a story list.", "default": "top" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Keywords to search story titles, URLs and text, e.g. \"rust\" or \"apify\". Used in Search mode; leave empty to list all stories matching the filters.", "default": "" }, "searchType": { "title": "Search in", "enum": [ "story", "ask_hn", "show_hn", "front_page", "poll" ], "type": "string", "description": "Which posts to search.", "default": "story" }, "searchSort": { "title": "Sort search results by", "enum": [ "relevance", "date" ], "type": "string", "description": "Relevance (best matches, weighted by points) or date (newest first).", "default": "relevance" }, "storyIds": { "title": "Story IDs or URLs", "type": "array", "description": "Used in \"Specific stories\" mode: HN item IDs (8863) or links like https://news.ycombinator.com/item?id=8863.", "default": [], "items": { "type": "string" } }, "minPoints": { "title": "Minimum points", "minimum": 0, "type": "integer", "description": "Only keep stories with at least this many points.", "default": 0 }, "sinceDate": { "title": "Posted since", "type": "string", "description": "Only keep stories posted on or after this date (YYYY-MM-DD).", "default": "" }, "maxItems": { "title": "Max stories", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum stories to save (lists have up to 500, search up to 1,000).", "default": 30 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Add each story's comment thread (author, text, date, depth, parent) to the story. Charged per comment.", "default": false }, "maxCommentsPerStory": { "title": "Max comments per story", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Cap on comments saved per story (top-level comments in HN ranking order, replies follow their parent).", "default": 200 }, "maxCommentDepth": { "title": "Max comment depth", "minimum": 0, "maximum": 50, "type": "integer", "description": "1 = top-level comments only, 2 = plus direct replies, … 0 = unlimited.", "default": 0 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel API requests.", "default": 5 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }