{ "openapi": "3.0.1", "info": { "title": "Forum Search API - Reddit, Reviews, Blogs, News, BoardReader", "description": "Search licensed message board, forum, Reddit, blog, news, review, video, Quora, TikTok and VK posts, as far back as your key allows. Filter by date, language, country, domain and author; get text, URL, author, site and engagement. Read only. Bring your own Socialgist BoardReader API key.", "version": "0.1", "x-build-id": "3GjYSxoPRyZxq54ml" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~forum-search-boardreader-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-forum-search-boardreader-api", "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/nabeelbaghoor~forum-search-boardreader-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-forum-search-boardreader-api", "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/nabeelbaghoor~forum-search-boardreader-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-forum-search-boardreader-api", "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": { "source": { "title": "Source", "enum": [ "boards", "reddit", "blogs", "news", "reviews", "video", "quora", "tiktok", "vk", "keyInfo" ], "type": "string", "description": "Which BoardReader index to search. Message boards and forums is the default. Key info needs no query and shows the limits and sources your key allows.", "default": "boards" }, "query": { "title": "Search query", "type": "string", "description": "Keywords in the provider's extended query syntax: quotes for phrases, | for OR, - for NOT, and @field to search one field, for example \"electric bike\" (battery|range) -ebay or @subject recall. Needed by every source except key info." }, "startDate": { "title": "Start date", "type": "string", "description": "Earliest publication date, as YYYY-MM-DD (start of the day, UTC) or a Unix timestamp. With no dates the provider searches the last 3 months. For message boards the Eastern time offset the provider asks for is applied for you." }, "endDate": { "title": "End date", "type": "string", "description": "Latest publication date, as YYYY-MM-DD (end of the day, UTC) or a Unix timestamp." }, "languages": { "title": "Languages", "type": "array", "description": "Keep only posts in these languages, as names or codes such as English or en. Leave empty for all.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Message boards, blogs, news and reviews. Keep only sources from these countries, as ISO 3166 two-letter codes such as US or DE.", "items": { "type": "string" } }, "domains": { "title": "Domains", "type": "array", "description": "Message boards, blogs, news, reviews and video. Keep only posts from these domains and their subdomains, such as example.com. Prefix one with - to exclude it.", "items": { "type": "string" } }, "authorName": { "title": "Author", "type": "string", "description": "Keep only posts by this author name (for VK, the author ID). Not available for news." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "time_desc", "time_asc", "time_relevance", "inserted_desc", "inserted_asc", "random" ], "type": "string", "description": "Relevance is the provider default. Newest first suits monitoring; recently indexed first suits incremental exports. TikTok does not sort by indexed time.", "default": "relevance" }, "comments": { "title": "Comments", "enum": [ "default", "off", "on", "only" ], "type": "string", "description": "Blogs, news and video. Whether to include comments alongside posts. The provider default is posts only for blogs and news, and posts plus comments for video.", "default": "default" }, "redditThing": { "title": "Reddit item type", "enum": [ "all", "link", "comment" ], "type": "string", "description": "Reddit only. Posts, comments or both.", "default": "all" }, "fullText": { "title": "Full text", "type": "boolean", "description": "Return the full text of each post instead of a snippet, where your key allows full posts.", "default": false }, "detail": { "title": "Detail level", "enum": [ "full", "basic" ], "type": "string", "description": "Full adds author details, thread and site identifiers and engagement fields. Basic returns fewer fields per post.", "default": "full" }, "extraParams": { "title": "Extra parameters", "type": "object", "description": "Any other parameter the chosen source documents, such as {\"filter_score\": \"gte100\"} for Reddit, {\"filter_item_name\": \"^Example Hotel$\"} for reviews, or {\"filter_region\": \"Europe\"} for message boards. Undocumented names are refused." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Row cap for the run. Matches are read 100 per request. Your key may cap matches per query lower (1,000 by default).", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 120, "type": "integer", "description": "Pacing ceiling for calls to the provider. Lower it if your key has a small daily request limit shared with other jobs.", "default": 60 }, "apiKey": { "title": "BoardReader API key", "type": "string", "description": "Your own Socialgist BoardReader API key. Stored as a secret and sent only to api.boardreader.com. You can also set it as the DATA_API_KEY environment secret." } } }, "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 } } } } } } } } } }