{ "openapi": "3.0.1", "info": { "title": "Hacker News Search API: Stories and Comments", "description": "Search Hacker News stories and comments by keyword, author, date range, points and type through the official HN Search API. Small clean JSON for AI agents, optional comment threads, only-new mode for alerts. Pay per result.", "version": "0.1", "x-build-id": "JoBZfskxPdPUIiJvn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/itayozer9~hacker-news-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-itayozer9-hacker-news-search", "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/itayozer9~hacker-news-search/runs": { "post": { "operationId": "runs-sync-itayozer9-hacker-news-search", "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/itayozer9~hacker-news-search/run-sync": { "post": { "operationId": "run-sync-itayozer9-hacker-news-search", "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": { "query": { "title": "Keywords", "maxLength": 500, "type": "string", "description": "Words to find in titles, URLs, story text and comments. Use quotes for an exact phrase, for example \"vector database\". Leave empty to list everything that matches the other filters (for example the newest Show HN posts)." }, "type": { "title": "Type", "enum": [ "story", "comment", "show_hn", "ask_hn", "launch_hn", "job", "poll", "front_page", "all" ], "type": "string", "description": "What to search. all = stories, comments, polls and jobs together.", "default": "story" }, "author": { "title": "Author username", "maxLength": 32, "type": "string", "description": "Only posts by this Hacker News username (case-sensitive, for example pg)." }, "dateFrom": { "title": "From date", "maxLength": 40, "type": "string", "description": "Only posts created at or after this time: 2026-10-01, 2026-10-01T12:00:00Z, or relative such as \"24 hours\", \"7 days\", \"2 weeks\". Dates are UTC." }, "dateTo": { "title": "To date", "maxLength": 40, "type": "string", "description": "Only posts created at or before this time. A plain date includes the whole day (UTC)." }, "minPoints": { "title": "Minimum points", "minimum": 0, "type": "integer", "description": "Only posts with at least this many points (upvotes). 0 = no limit.", "default": 0 }, "minComments": { "title": "Minimum comments", "minimum": 0, "type": "integer", "description": "Only stories with at least this many comments. 0 = no limit.", "default": 0 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "date" ], "type": "string", "description": "relevance = best matches first (up to 1,000 results). date = newest first (up to 5,000 results).", "default": "relevance" }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Most results to return (1 to 5,000). You pay only for results returned.", "default": 50 }, "includeComments": { "title": "Include comment threads", "type": "boolean", "description": "Add each story's comments (plain text, thread order, with depth and parent id) to its result. No extra charge, but runs take longer.", "default": false }, "maxCommentsPerStory": { "title": "Max comments per story", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap on comments added to each story when comment threads are on (1 to 500).", "default": 100 }, "onlyNew": { "title": "Only new since last run", "type": "boolean", "description": "For schedules and alerts: return only results this same search has not returned before (remembered per search and per saved task). Sorts by date.", "default": false } } }, "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 } } } } } } } } } }