{ "openapi": "3.0.1", "info": { "title": "Hacker News Scraper: stories, comments and keyword search", "description": "Reads Hacker News top, new, best, Ask HN, Show HN and job lists, single items and comment trees through the official Hacker News API, and searches stories and comments by keyword, date and points.", "version": "0.1", "x-build-id": "Wi2uLX36B7CZ1tg4I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~hacker-news-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-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/examsens.ai~hacker-news-scraper/runs": { "post": { "operationId": "runs-sync-examsens.ai-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/examsens.ai~hacker-news-scraper/run-sync": { "post": { "operationId": "run-sync-examsens.ai-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": "Hacker News lists to read, in ranked order. Top and new hold up to 500 stories, best up to 200, Ask HN, Show HN and jobs up to 200.", "items": { "type": "string", "enum": [ "top", "new", "best", "ask", "show", "job" ], "enumTitles": [ "Top stories", "New stories", "Best stories", "Ask HN", "Show HN", "Jobs" ] } }, "maxItemsPerList": { "title": "Items per list", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many items to take from the top of each list.", "default": 30 }, "itemIds": { "title": "Item ids or URLs", "type": "array", "description": "Single stories, jobs, polls or comments, as an item id (such as 8863) or an item URL ending in id=8863.", "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords to search for. Each keyword runs as its own search. Put a phrase in double quotes to match it exactly.", "items": { "type": "string" } }, "searchTags": { "title": "Search in", "enum": [ "story", "comment", "ask_hn", "show_hn", "poll", "job", "front_page" ], "type": "string", "description": "The kind of item the search returns.", "default": "story" }, "searchSort": { "title": "Sort search results by", "enum": [ "relevance", "date" ], "type": "string", "description": "A search sorted by relevance returns at most 1,000 results per keyword. Sorted by date, it continues past 1,000 up to your maximum.", "default": "relevance" }, "dateFrom": { "title": "From date", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only items created on or after this day (UTC), written as YYYY-MM-DD." }, "dateTo": { "title": "To date", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only items created on or before this day (UTC), written as YYYY-MM-DD." }, "minPoints": { "title": "Minimum points", "minimum": 0, "type": "integer", "description": "Only stories with at least this many points." }, "minComments": { "title": "Minimum comments", "minimum": 0, "type": "integer", "description": "Only stories with at least this many comments." }, "maxResultsPerQuery": { "title": "Maximum results per keyword", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each keyword search after this many results.", "default": 100 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "For every story, job or poll from a list or an item id, also return its comments, one record per comment. Search results do not get comment trees.", "default": false }, "commentDepth": { "title": "Comment depth", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many reply levels to read. 1 returns only the direct replies to the story.", "default": 2 }, "maxCommentsPerItem": { "title": "Maximum comments per item", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop reading the comment tree of one item after this many comments.", "default": 100 } } }, "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 } } } } } } } } } }