{ "openapi": "3.0.1", "info": { "title": "Hacker News Scraper - Posts, Comments & Users", "description": "Search posts and comments by keyword, or pull the live front page with each post's rank. Every row has points, comment count, author, domain and date. Add full comment threads with reply depth, plus user profiles and karma.", "version": "0.0", "x-build-id": "NOW2M8E6FEhZhsZWg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/goat255~hackernews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-goat255-hackernews-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/goat255~hackernews-scraper/runs": { "post": { "operationId": "runs-sync-goat255-hackernews-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/goat255~hackernews-scraper/run-sync": { "post": { "operationId": "run-sync-goat255-hackernews-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search. One search per entry. Leave empty if you only want live lists, users or specific posts.", "items": { "type": "string" } }, "postType": { "title": "Post type", "enum": [ "any", "story", "comment", "ask", "show", "poll", "front_page" ], "type": "string", "description": "Which kind of post to search for.", "default": "story" }, "sort": { "title": "Sort", "enum": [ "relevance", "date" ], "type": "string", "description": "Relevance ranks by popularity but stops at 1000 results per term. Date walks backwards through time with no limit, so use it for large runs.", "default": "relevance" }, "maxResultsPerTerm": { "title": "Max results per search term", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap per search term. Above 1000 the run automatically switches to walking by date.", "default": 100 }, "minPoints": { "title": "Minimum points", "minimum": 0, "type": "integer", "description": "Only return posts with at least this many points." }, "minComments": { "title": "Minimum comments", "minimum": 0, "type": "integer", "description": "Only return posts with at least this many comments." }, "dateFrom": { "title": "Posted after", "type": "string", "description": "Only return posts created on or after this date. Format YYYY-MM-DD." }, "dateTo": { "title": "Posted before", "type": "string", "description": "Only return posts created on or before this date. Format YYYY-MM-DD." }, "lists": { "title": "Live lists", "type": "array", "description": "Pull the current live rankings. Every row carries its position in the list, so scheduling the run builds a ranking history.", "items": { "type": "string", "enum": [ "top", "best", "new", "ask", "show", "job" ], "enumTitles": [ "Front page", "Best", "Newest", "Ask posts", "Show posts", "Jobs" ] } }, "maxItemsPerList": { "title": "Max posts per list", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap per live list.", "default": 100 }, "usernames": { "title": "Usernames", "type": "array", "description": "User profiles to fetch: karma, account age, bio and submission count.", "items": { "type": "string" } }, "itemIds": { "title": "Post links or ids", "type": "array", "description": "Specific posts to fetch. Paste the full link or just the numeric id.", "items": { "type": "string" } }, "includeComments": { "title": "Include comment threads", "type": "boolean", "description": "Also pull the comment thread for every post the run collects. Each comment is its own row and carries its reply depth.", "default": false }, "maxCommentsPerPost": { "title": "Max comments per post", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on comments pulled per post.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Enable to spread requests across IP addresses." } } }, "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 } } } } } } } } } }