{ "openapi": "3.0.1", "info": { "title": "Hacker News Scraper: Stories, Search, Comments & Users", "description": "Scrape Hacker News front page and new story lists, full-text search across every story and comment, whole comment threads, and user profiles. Uses the official Firebase and Algolia APIs. No key, no login.", "version": "0.0", "x-build-id": "E2OiqmT7fRQCjANTF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winterlock~hacker-news-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winterlock-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/winterlock~hacker-news-scraper/runs": { "post": { "operationId": "runs-sync-winterlock-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/winterlock~hacker-news-scraper/run-sync": { "post": { "operationId": "run-sync-winterlock-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", "required": [ "mode" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "stories", "search", "item", "user" ], "type": "string", "description": "A ranked story list, a full-text search, one item with its comment thread, or user profiles.", "default": "stories" }, "storyLists": { "title": "Story lists", "type": "array", "description": "Which ranked lists to read.", "items": { "type": "string", "enum": [ "top", "new", "best", "ask", "show", "job" ], "enumTitles": [ "Front page (top)", "Newest", "Best", "Ask HN", "Show HN", "Jobs" ] }, "default": [ "top" ] }, "searchTerms": { "title": "Search terms", "type": "array", "description": "For Search. One query per line. Leave empty and set an author to list everything that account posted.", "items": { "type": "string" } }, "items": { "title": "Items", "type": "array", "description": "For Item + comments. Use numeric ids (8863) or links (https://news.ycombinator.com/item?id=8863).", "items": { "type": "string" } }, "users": { "title": "Users", "type": "array", "description": "For Users. Use usernames (pg) or profile links.", "items": { "type": "string" } }, "maxStoriesPerList": { "title": "Max stories per list", "minimum": 1, "maximum": 500, "type": "integer", "description": "Each story is one extra request, so 500 stories means 500 calls. Hacker News publishes at most 500 ids per list.", "default": 30 }, "contentType": { "title": "Search content type", "enum": [ "all", "story", "comment", "poll", "askHn", "showHn", "frontPage" ], "type": "string", "description": "Restrict a search to one kind of item.", "default": "story" }, "author": { "title": "Author (optional)", "type": "string", "description": "Restrict a search to one username." }, "newestFirst": { "title": "Sort search by newest instead of relevance", "type": "boolean", "description": "Best for monitoring a keyword over time.", "default": false }, "minPoints": { "title": "Minimum points", "minimum": 0, "type": "integer", "description": "Only return search results with at least this score." }, "minComments": { "title": "Minimum comments", "minimum": 0, "type": "integer", "description": "Only return search results with at least this many comments." }, "postedAfter": { "title": "Posted after", "type": "string", "description": "A date (2026-01-31) or a unix timestamp. Search only." }, "postedBefore": { "title": "Posted before", "type": "string", "description": "A date (2026-12-31) or a unix timestamp. Search only." }, "maxResultsPerSearch": { "title": "Max results per search term", "minimum": 1, "maximum": 1000, "type": "integer", "description": "The search index returns at most 1,000 hits for one query.", "default": 100 }, "includeComments": { "title": "Include the comment thread", "type": "boolean", "description": "For Item + comments. Walks the reply tree below each item.", "default": true }, "commentDepth": { "title": "Comment depth", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many reply levels to walk.", "default": 5 }, "maxCommentsPerItem": { "title": "Max comments per item", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Each comment is one request, so busy threads get expensive.", "default": 500 }, "maxItems": { "title": "Max items in total", "minimum": 1, "type": "integer", "description": "Stop the run after saving this many items. Leave empty for no limit." }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Lower this if you see rate-limit retries in the log.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most runs. Both APIs are open and generous.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }