{ "openapi": "3.0.1", "info": { "title": "Hacker News Data Scraper", "description": "Collect public Hacker News stories and posts by feed, topic, user, date, or listing. Export structured fields such as titles, links, authors, scores, ranks, publication times, and optional top-level comments to an Apify dataset.", "version": "0.0", "x-build-id": "fGmd8R5gT4aG7v4p7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~hacker-news-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-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/maximedupre~hacker-news-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-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/maximedupre~hacker-news-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-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": [ "discoveryMethod" ], "properties": { "discoveryMethod": { "title": "Find stories by", "enum": [ "feed", "search", "user", "date", "listing" ], "type": "string", "description": "Choose how to find stories. Use one method per run. Fields for other methods are ignored." }, "feed": { "title": "Feed", "enum": [ "front", "top", "new", "best", "ask", "show", "jobs" ], "type": "string", "description": "Choose a public Hacker News feed: Front page, Top stories, Newest stories, Best stories, Ask HN, Show HN, or Jobs.", "default": "front" }, "searchQuery": { "title": "Topic or phrase", "type": "string", "description": "Enter a topic or phrase for full-text search. This field is used only for Topic search." }, "searchOrder": { "title": "Order search results by", "enum": [ "relevance", "newest" ], "type": "string", "description": "Choose how Topic search results are ordered. Relevance puts closer matches first; Newest first uses publication time.", "default": "relevance" }, "searchStartDate": { "title": "Start date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optionally enter the first publication date for Topic search. Use YYYY-MM-DD. Leave empty to start without a date filter." }, "searchEndDate": { "title": "End date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optionally enter the last publication date for Topic search. Use YYYY-MM-DD. Leave empty to end without a date filter." }, "minScore": { "title": "Minimum score", "minimum": 0, "type": "integer", "description": "Keep Topic search stories with at least this many points. Leave empty to use no score filter." }, "minComments": { "title": "Minimum comments", "minimum": 0, "type": "integer", "description": "Keep Topic search stories with at least this many comments. Leave empty to use no comment filter." }, "userHandle": { "title": "Hacker News username", "type": "string", "description": "Enter one Hacker News username to collect that user's public story submissions. This field is used only for User submissions." }, "historyStartDate": { "title": "Start date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Enter the first publication date to collect for Historical content. Use YYYY-MM-DD. This field is required for that method." }, "historyEndDate": { "title": "End date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optionally enter the last publication date for Historical content. Use YYYY-MM-DD. Use the same date as Start date for one day." }, "listingTargets": { "title": "Hacker News listings", "minItems": 1, "type": "array", "description": "Add one or more public Hacker News item IDs or URLs, such as 8863 or https://news.ycombinator.com/item?id=8863. This field is used only for Specific listings.", "items": { "type": "string" } }, "includeComments": { "title": "Include top-level comments", "type": "boolean", "description": "Include available top-level public comments with their author, text, posting time, and reply relationships.", "default": false }, "maxItems": { "title": "Maximum stories", "minimum": 1, "type": "integer", "description": "Stop after this many stories. Leave empty to collect all available results until the source is exhausted." } } }, "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 } } } } } } } } } }