{ "openapi": "3.0.1", "info": { "title": "Hacker News Scraper & Change Monitor", "description": "Search Hacker News, export ranked stories and comments, inspect public author submissions, and track new or updated observations with clear coverage.", "version": "0.5", "x-build-id": "uVPAfBRQYjv7dHPiA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luminar~hackernews-scraper-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luminar-hackernews-scraper-monitor", "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/luminar~hackernews-scraper-monitor/runs": { "post": { "operationId": "runs-sync-luminar-hackernews-scraper-monitor", "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/luminar~hackernews-scraper-monitor/run-sync": { "post": { "operationId": "run-sync-luminar-hackernews-scraper-monitor", "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": { "workflow": { "title": "What would you like to do?", "enum": [ "collect", "monitor" ], "type": "string", "description": "Get current data, or compare repeated runs of the same watch.", "default": "collect" }, "mode": { "title": "Where should the data come from?", "enum": [ "search", "feed", "items", "user" ], "type": "string", "description": "Search topics, read a ranked feed, look up known item IDs, or inspect a public author.", "default": "search" }, "query": { "title": "Search words", "maxLength": 300, "type": "string", "description": "Words or a phrase to find in Hacker News. Used for keyword search. Empty searches are allowed.", "default": "kubernetes" }, "feed": { "title": "Feed", "enum": [ "top", "new", "best", "ask", "show", "jobs" ], "type": "string", "description": "Used for ranked feed mode. The source publishes a limited current list; Best is not an all-time archive.", "default": "top" }, "username": { "title": "Public username", "maxLength": 32, "type": "string", "description": "Required for User submissions. For example pg. Story submissions are included by default.", "default": "" }, "itemIds": { "title": "Item IDs", "maxItems": 500, "type": "array", "description": "For Known items. Paste the numbers after id= in Hacker News discussion links. Up to 500 IDs.", "items": { "type": "string" }, "default": [] }, "sort": { "title": "Search order", "enum": [ "date", "relevance" ], "type": "string", "description": "Newest supports time-window pagination beyond the first 1,000 indexed matches. Relevance remains limited to the first 1,000.", "default": "date" }, "itemTypes": { "title": "Search item types", "minItems": 1, "maxItems": 6, "type": "array", "description": "Types for keyword search. Include Comments here to include comments in User submissions too.", "items": { "type": "string", "enum": [ "story", "comment", "poll", "job", "ask_hn", "show_hn" ], "enumTitles": [ "Stories", "Comments", "Polls", "Jobs", "Ask HN", "Show HN" ] }, "default": [ "story" ] }, "author": { "title": "Author filter", "maxLength": 32, "type": "string", "description": "Keep items posted by this public username.", "default": "" }, "minPoints": { "title": "Minimum points", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Keep items with at least this many visible points. Zero disables this filter.", "default": 0 }, "minComments": { "title": "Minimum comment count", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Keep stories with at least this many reported comments. Zero disables this filter.", "default": 0 }, "domain": { "title": "Linked website domain", "maxLength": 200, "type": "string", "description": "Optional domain such as github.com. Includes its subdomains. Linked pages are not visited.", "default": "" }, "dateFrom": { "title": "Published on or after", "maxLength": 24, "type": "string", "description": "Optional YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ in UTC.", "default": "" }, "dateTo": { "title": "Published on or before", "maxLength": 24, "type": "string", "description": "Optional UTC date. A date without a time includes that full day.", "default": "" }, "includeComments": { "title": "Include comments inside each item", "type": "boolean", "description": "Include public comments with IDs, authors, text and parent links. These nested comments are included in the item price.", "default": false }, "maxCommentsPerItem": { "title": "Comments per item", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum nested comments in each item, across all selected depths. Default five. Total nested comments are limited to 10,000 per run.", "default": 5 }, "commentDepth": { "title": "Comment depth", "minimum": 1, "maximum": 10, "type": "integer", "description": "One includes direct replies only. Up to ten levels; count and time limits still apply.", "default": 1 }, "includeUserProfile": { "title": "Include the public profile", "type": "boolean", "description": "User submissions mode can include one extra paid profile row with public karma, biography and submission count.", "default": true }, "stateNamespace": { "title": "Watch name", "maxLength": 50, "type": "string", "description": "Keep the same name and inputs for sequential repeat runs. Changing them starts a separate watch. Use letters, digits, hyphens or underscores.", "default": "default" }, "firstRunBehavior": { "title": "First monitoring run", "enum": [ "seed_only", "emit_current_as_new" ], "type": "string", "description": "Save the starting observations quietly, or label existing matches as new to this watch.", "default": "seed_only" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum paid items. User profile mode may add one profile. Feed size and source limits still apply.", "default": 200 }, "maxBuyerChargeUsd": { "title": "Maximum buyer charge (USD)", "minimum": 0.000001, "maximum": 100, "type": "number", "description": "Reject a run before collection if its maximum requested charge exceeds this amount. Failed unverified data is free.", "default": 1 }, "maxRuntimeSecs": { "title": "Collection time budget (seconds)", "minimum": 15, "maximum": 240, "type": "integer", "description": "Maximum time for source collection. Additional time is reserved for safely finishing delivery. A time-limited result has incomplete coverage.", "default": 180 } } }, "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 } } } } } } } } } }