{ "openapi": "3.0.1", "info": { "title": "Brand Mention Scraper API — News, Reddit & Hacker News", "description": "Scrape brand and competitor mentions across Google News, Reddit, Hacker News, Product Hunt and YouTube. Blocked sources are reported as partial coverage, never as silence. Unofficial — not affiliated with any source named.", "version": "0.1", "x-build-id": "YKuQl4sutrxLiPbMK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quarry~brand-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quarry-brand-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/quarry~brand-monitor/runs": { "post": { "operationId": "runs-sync-quarry-brand-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/quarry~brand-monitor/run-sync": { "post": { "operationId": "run-sync-quarry-brand-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Keywords to monitor", "type": "array", "description": "Brands, products, competitors or topics. Each is searched across every enabled source.", "items": { "type": "string" } }, "sources": { "title": "Sources", "type": "array", "description": "Which surfaces to watch. Each enabled source is searched for every keyword, so adding one multiplies the mentions found — and the cost.", "items": { "type": "string", "enum": [ "googlenews", "reddit", "hackernews", "producthunt", "youtube" ] }, "default": [ "googlenews", "reddit", "hackernews" ] }, "onlyNew": { "title": "Only new mentions", "type": "boolean", "description": "Suppress anything reported in a previous run. Leave on for scheduled monitoring; turn off for a one-time backfill.", "default": true }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Names the history this run remembers. Leave empty and each distinct keyword list gets its own, so your separate brand monitors never suppress each other. Set it to keep one history across a changing keyword list, or change it to start clean." }, "maxAgeHours": { "title": "Max age (hours)", "minimum": 0, "type": "integer", "description": "Ignore mentions older than this. 0 = no limit.", "default": 168 }, "excludeTerms": { "title": "Exclude terms", "type": "array", "description": "Drop mentions containing any of these — the cheapest way to kill recurring false positives.", "items": { "type": "string" } }, "youtubeChannels": { "title": "YouTube channels", "type": "array", "description": "Channel IDs (UC…) to watch, when the youtube source is enabled.", "items": { "type": "string" } }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code used for news search, e.g. en, de, fr.", "default": "en" }, "region": { "title": "Region", "type": "string", "description": "Two-letter country code used for news search, e.g. US, GB, DE. Changes which outlets are surfaced.", "default": "US" }, "maxPerSource": { "title": "Max per source per keyword", "minimum": 1, "type": "integer", "description": "Cap on mentions taken from each source, per keyword. Bounds cost when a keyword trends.", "default": 100 }, "maxItems": { "title": "Max items total", "minimum": 0, "type": "integer", "description": "Hard ceiling on billable mentions for the whole run. 0 = no limit.", "default": 0 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many sources to fetch in parallel. Raise for speed, lower if a source rate-limits you.", "default": 4 } } }, "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 } } } } } } } } } }