{ "openapi": "3.0.1", "info": { "title": "BiggerPockets Scraper", "description": "Scrape BiggerPockets, the largest real estate investing community. Pull forum topics, full post bodies + replies, and user profiles across 50+ investing categories. No login or proxy required.", "version": "1.0", "x-build-id": "UVwSyqx1gaQCUZEeW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~bigger-pockets-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-bigger-pockets-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/crawlerbros~bigger-pockets-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-bigger-pockets-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/crawlerbros~bigger-pockets-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-bigger-pockets-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": { "mode": { "title": "Mode", "enum": [ "forumLatest", "forumTrending", "forumUnanswered", "multiForum", "byTopicIds", "byTopicUrls", "byUsernames" ], "type": "string", "description": "What to scrape.", "default": "forumLatest" }, "forumId": { "title": "Forum (single)", "enum": [ "48", "311", "88", "12", "853", "922", "432", "62", "61", "67", "93", "30", "32", "530", "925", "44", "70", "960", "92", "79", "104", "41", "888", "921", "963", "50", "519", "95", "49", "51", "109", "926", "52", "899", "898", "897", "903", "22", "24", "21", "55", "517", "521", "927", "964", "961", "962", "904", "80", "56", "25" ], "type": "string", "description": "Forum to scan in forumLatest / forumTrending / forumUnanswered modes.", "default": "48" }, "forumIds": { "title": "Forums (multi)", "type": "array", "description": "Forums to scan in multiForum mode. Numeric forum IDs or full /forums/ URLs.", "default": [], "items": { "type": "string" } }, "sortBy": { "title": "Sort (multiForum mode)", "enum": [ "newest", "trending", "unanswered", "top", "votes", "replies" ], "type": "string", "description": "Sort order — only consumed in multiForum mode. Other forum modes use their built-in sort.", "default": "newest" }, "topicIds": { "title": "Topic IDs (byTopicIds)", "type": "array", "description": "Topic IDs (e.g. `1288127`) or /forums//topics/-slug paths.", "default": [], "items": { "type": "string" } }, "topicUrls": { "title": "Topic URLs (byTopicUrls)", "type": "array", "description": "Full BiggerPockets topic URLs.", "default": [], "items": { "type": "string" } }, "usernames": { "title": "Usernames (byUsernames)", "type": "array", "description": "BiggerPockets usernames (e.g. `sparkrental`) or full /users/ URLs.", "default": [], "items": { "type": "string" } }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "When true, push each forum reply as a separate record (recordType=`comment`).", "default": false }, "maxCommentsPerTopic": { "title": "Max comments per topic", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted comment records per topic when includeComments=true.", "default": 100 }, "minReplies": { "title": "Min reply count", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drop topics with fewer replies than this." }, "minVotes": { "title": "Min upvotes", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drop topics with fewer upvotes than this." }, "minViews": { "title": "Min views", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Drop topics with fewer views than this. Requires fetching topic detail pages." }, "containsKeyword": { "title": "Title or body contains", "type": "string", "description": "Case-insensitive substring filter on topic title + body." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on total emitted records (topics + comments).", "default": 50 }, "maxPagesPerForum": { "title": "Max pages per forum", "minimum": 1, "maximum": 50, "type": "integer", "description": "Page-limit when paginating a forum listing.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy. BiggerPockets works fine without proxy from datacenter IPs, but you can enable AUTO for extra IP rotation.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }