{ "openapi": "3.0.1", "info": { "title": "Hacker News API: Stories, Comments, Who Is Hiring", "description": "Hacker News scraper on the official Algolia and Firebase APIs: search stories by keyword, date and points, or read top/new/best/ask/show/job lists. Optional comments and 'Who is hiring' postings. E-mails and phones removed. Empty input = free demo. $1 per 1,000 items.", "version": "0.1", "x-build-id": "3yViZ0A8KnHU3Qzn4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ucchiii~hacker-news-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ucchiii-hacker-news-api", "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/ucchiii~hacker-news-api/runs": { "post": { "operationId": "runs-sync-ucchiii-hacker-news-api", "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/ucchiii~hacker-news-api/run-sync": { "post": { "operationId": "run-sync-ucchiii-hacker-news-api", "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": "Mode", "enum": [ "search", "list", "whoIsHiring" ], "type": "string", "description": "search = Algolia HN Search (keyword, dates, points). list = official top/new/best/ask/show/job lists. whoIsHiring = postings of the monthly 'Ask HN: Who is hiring?' thread. Leave everything empty for a free demo." }, "query": { "title": "Search query", "type": "string", "description": "Words to look for, e.g. 'apify'. In list and whoIsHiring modes all words must appear in the title or text. Empty = no keyword filter." }, "storyType": { "title": "Story type (search mode)", "enum": [ "story", "ask", "show", "job" ], "type": "string", "description": "Restrict the search to one kind of story: story (all regular stories), ask (Ask HN), show (Show HN) or job (job ads posted to HN). Empty = story." }, "sortBy": { "title": "Sort by (search mode)", "enum": [ "date", "relevance" ], "type": "string", "description": "date = newest first (Algolia search_by_date). relevance = best match first. Empty = date." }, "dateFrom": { "title": "Created from (UTC)", "type": "string", "description": "Only items created on or after this day, format YYYY-MM-DD, e.g. 2026-01-01. Empty = no limit." }, "dateTo": { "title": "Created until (UTC)", "type": "string", "description": "Only items created on or before this day (inclusive), format YYYY-MM-DD. Empty = no limit." }, "minPoints": { "title": "Minimum points", "minimum": 0, "type": "integer", "description": "Keep only stories with at least this many points. Empty or 0 = no limit." }, "list": { "title": "List (list mode)", "enum": [ "top", "new", "best", "ask", "show", "job" ], "type": "string", "description": "Which official Hacker News list to read: top, new, best, ask, show or job. Empty = top." }, "hiringMonth": { "title": "Hiring month (whoIsHiring mode)", "type": "string", "description": "Which 'Who is hiring?' thread to read: 'latest' or a month such as 2026-10 or 'October 2026'. Empty = latest." }, "remoteOnly": { "title": "Remote postings only (whoIsHiring mode)", "type": "boolean", "description": "Keep only postings whose header mentions remote work.", "default": false }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Add a 'comments' list to every story (comment text, createdAt, parent id, points, by). Not used in whoIsHiring mode. Comments are free.", "default": false }, "maxCommentsPerStory": { "title": "Max comments per story", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap on comments kept per story (depth-first, thread order). Between 1 and 500. Empty = 20." }, "maxItems": { "title": "Max stories or postings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on rows returned (and charged). Between 1 and 1000; Algolia serves at most 1000 hits per query. Empty = 10." } } }, "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 } } } } } } } } } }