{ "openapi": "3.0.1", "info": { "title": "Hacker News Data Scraper & Activity Monitoring", "description": "Unofficial Hacker News API to extract data from all Hacker News categories. You can filter posts based on specific keywords, track trends using the unique activity monitoring feature, and receive updates directly in your Slack channel.", "version": "0.0", "x-build-id": "ThHNIXPWzjHxahNod" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lucen_data~hacker-news-data-scraper-activity-monitoring/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lucen_data-hacker-news-data-scraper-activity-monitoring", "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/lucen_data~hacker-news-data-scraper-activity-monitoring/runs": { "post": { "operationId": "runs-sync-lucen_data-hacker-news-data-scraper-activity-monitoring", "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/lucen_data~hacker-news-data-scraper-activity-monitoring/run-sync": { "post": { "operationId": "run-sync-lucen_data-hacker-news-data-scraper-activity-monitoring", "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", "required": [ "proxyConfig" ], "properties": { "hnDataSource": { "title": "Hacker News data source", "enum": [ " ", "newest", "ask", "show", "jobs" ], "type": "string", "description": "Select Hacker News data source.", "default": " " }, "filterValues": { "title": "Filter Values", "type": "array", "description": "Filter criteria to refine the monitoring results you wish to track. It will return true if any of the specified filter values is found in either the URL or the Title of the extracted Hacker News post.", "items": { "type": "string" } }, "ignoreValues": { "title": "Ignore Results Containing", "type": "array", "description": "Ignore results containing the specified keyword in either the URL or the Title of the extracted Hacker News post.", "items": { "type": "string" } }, "hnPostMonitoring": { "title": "HackerNews Activity Monitor (Actor Task Required)", "type": "boolean", "description": "If enabled, this feature will track new posts on HackerNews and store any new findings in the Actor's KeyValueStore. It can work with specific filter values or full scrapes. To function correctly, an Actor Task needs to be set up. Please refer to the 'Information' tab of the Actor for guidance on setting up your Actor Task for post monitoring.", "default": false }, "slackChannel": { "title": "Slack channel name", "type": "string", "description": "Provide the name of the channel you want your message to be sent to. (e.g., marketing-media-mentions)" }, "slackBotToken": { "title": "Slack Bot Token", "type": "string", "description": "Provide your Slack App's Bot User OAuth Token (find it under your App's OAuth & Permissions tab)" }, "slackSignInSecret": { "title": "Slack Signin Secret", "type": "string", "description": "Provide your Slack App's Signin Secret (in your App's page, go to Basic information -> App Credentials)" }, "proxyConfig": { "title": "Proxy configuration", "type": "object", "description": "It's recommended to leave the 'Automatic Proxy you can use automatic Apify proxies, Residentials or your own proxies.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }