{ "openapi": "3.0.1", "info": { "title": "phpBB Forum Scraper", "description": "Generic scraper for phpBB-powered forums. Crawls forums, topics and posts, and outputs structured post data.", "version": "0.1", "x-build-id": "WefO6hyefSHXm2gcf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rl1987~phpbb-forum-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rl1987-phpbb-forum-scraper", "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/rl1987~phpbb-forum-scraper/runs": { "post": { "operationId": "runs-sync-rl1987-phpbb-forum-scraper", "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/rl1987~phpbb-forum-scraper/run-sync": { "post": { "operationId": "run-sync-rl1987-phpbb-forum-scraper", "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": [ "mode" ], "properties": { "forumUrl": { "title": "Forum URL", "type": "string", "description": "Base URL of any phpBB-powered forum, e.g. https://forum.cyclos.org" }, "mode": { "title": "Mode", "enum": [ "forums", "latest", "forum", "search", "topicUrls" ], "type": "string", "description": "What to crawl. 'forums' lists the board's forums/sub-forums (use this to discover a forumId for mode=forum). 'latest' pulls the board's active-topics list, 'forum' pulls one forum, 'search' pulls search results, 'topicUrls' scrapes only the topics you list.", "default": "latest" }, "forumId": { "title": "Forum ID or URL", "type": "string", "description": "Required when mode=forum. The forum's numeric id (the 'f=' value), or a full viewforum.php URL." }, "searchQuery": { "title": "Search query", "type": "string", "description": "Required when mode=search. Uses the board's search.php?keywords= endpoint." }, "topicUrls": { "title": "Topic URLs", "type": "array", "description": "Required when mode=topicUrls. Direct URLs to phpBB topics (viewtopic.php).", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includePosts": { "title": "Include full posts", "type": "boolean", "description": "If true, fetch every topic's full post stream (original post + all replies) in addition to the topic metadata. If false, only topic-level metadata is scraped (much faster, fewer requests).", "default": true }, "maxTopics": { "title": "Max topics", "minimum": 0, "type": "integer", "description": "Maximum number of topics to scrape. 0 = unlimited.", "default": 100 }, "maxPostsPerTopic": { "title": "Max posts per topic", "minimum": 0, "type": "integer", "description": "Maximum number of posts to fetch per topic (only used when includePosts is true). 0 = unlimited.", "default": 0 }, "maxRequestsPerCrawl": { "title": "Max HTTP requests", "minimum": 0, "type": "integer", "description": "Safety cap on the total number of HTTP requests made during the run. 0 = unlimited.", "default": 2000 }, "requestDelaySecs": { "title": "Delay between requests (seconds)", "minimum": 0, "type": "integer", "description": "Polite delay between outgoing requests to avoid overloading the forum's server.", "default": 1 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of concurrent HTTP requests.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Recommended if scraping many pages, or if the target forum blocks/geo-restricts direct traffic.", "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 } } } } } } } } } }