{ "openapi": "3.0.1", "info": { "title": "Hacker News Scraper", "description": "Stories from the Hacker News front page lists and full-text search with points, comment count, link and time, plus whole comment threads as rows on request. Filter search by date, points and comments, and get only new stories and comments on each scheduled run.", "version": "0.1", "x-build-id": "RELBcQsa2Iqec24Sq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deriverge~hacker-news-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deriverge-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/deriverge~hacker-news-scraper/runs": { "post": { "operationId": "runs-sync-deriverge-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/deriverge~hacker-news-scraper/run-sync": { "post": { "operationId": "run-sync-deriverge-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": { "lists": { "title": "Lists", "type": "array", "description": "Which front page lists to read: top, new, best, ask, show, jobs. Leave empty when you only search or name stories.", "items": { "type": "string" } }, "maxPerList": { "title": "Maximum stories per list", "minimum": 1, "type": "integer", "description": "Top and new go to 500, best to 200, the others as far as Hacker News lists them.", "default": 100 }, "queries": { "title": "Search terms", "type": "array", "description": "Full-text search over titles, links and text. An empty term with a tag or date filter returns everything that matches the filter.", "items": { "type": "string" } }, "searchTags": { "title": "What to search", "enum": [ "story", "ask_hn", "show_hn", "job", "poll", "front_page" ], "type": "string", "description": "Ask HN and Show HN are subsets of stories; front page means stories that reached the front page.", "default": "story" }, "sortBy": { "title": "Order", "enum": [ "relevance", "date" ], "type": "string", "description": "Relevance ranks by match and popularity; newest first is what a monitor wants. An empty search term always uses newest first.", "default": "relevance" }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Only items created after this date (YYYY-MM-DD)." }, "publishedBefore": { "title": "Published before", "type": "string", "description": "Only items created before this date (YYYY-MM-DD)." }, "minPoints": { "title": "Minimum points", "minimum": 1, "type": "integer", "description": "Only items with at least this many points." }, "minComments": { "title": "Minimum comments", "minimum": 1, "type": "integer", "description": "Only items with at least this many comments." }, "maxResultsPerQuery": { "title": "Maximum results per search term", "minimum": 1, "type": "integer", "description": "Results are read a hundred at a time from the top of the ranking.", "default": 100 }, "stories": { "title": "Stories", "type": "array", "description": "Hacker News item links (news.ycombinator.com/item?id=...) or numeric ids. With Include comments on, a link to a single comment returns that comment and the replies under it.", "items": { "type": "string" } }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Return the comment tree of every story as rows with author, date, text, depth and parent. Charged per comment.", "default": false }, "maxCommentsPerStory": { "title": "Maximum comments per story", "minimum": 1, "type": "integer", "description": "Replies count towards the cap; the tree is walked from the top.", "default": 100 }, "keywords": { "title": "Keywords (any of)", "type": "array", "description": "Keep only stories whose title, text or link contain at least one of these words, case-insensitive. Dropped stories are never charged.", "items": { "type": "string" } }, "newOnly": { "title": "Return only rows new since the last run", "type": "boolean", "description": "Keeps a snapshot per watch name (or per saved task) and returns only stories and comments that were not there before. Schedule it hourly or daily and you have a Hacker News alert that bills only for what is new.", "default": false }, "watchName": { "title": "Watch name", "type": "string", "description": "Name of the snapshot used by the new-only mode, for example \"ai-alert\". Runs from a saved task get a snapshot automatically even without a name." }, "maxItems": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "Hard cap on returned rows in the run.", "default": 10000 } } }, "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 } } } } } } } } } }