{ "openapi": "3.0.1", "info": { "title": "Facebook Marketplace Scraper", "description": "Extract data from Facebook Marketplace listings. Scrape items for sale, apartments, categories, search results with prices, locations, seller info, and more. Export data in JSON, CSV, or Excel.", "version": "1.0", "x-build-id": "xCabViCaZTXZAnN12" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~facebook-marketplace-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-facebook-marketplace-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~facebook-marketplace-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-facebook-marketplace-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~facebook-marketplace-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-facebook-marketplace-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", "properties": { "startUrls": { "title": "Marketplace URLs", "type": "array", "description": "One or more Facebook Marketplace search, category, location, or direct item URLs. Use this or searchQuery plus location.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL", "description": "A valid Facebook Marketplace URL, such as a city feed, search, category, or /marketplace/item/ page." } } } }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Keyword or phrase for structured Marketplace discovery, for example laptop, furniture, or used bicycle. Requires location when startUrls is omitted." }, "location": { "title": "Location", "type": "string", "description": "Marketplace location slug or city/state value, for example nyc, seattle, or New York, NY." }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Optional structured-search center latitude." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Optional structured-search center longitude." }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Optional search radius around the structured location." }, "categoryId": { "title": "Category ID", "type": "string", "description": "Optional Facebook Marketplace category ID." }, "sortBy": { "title": "Sort Order", "enum": [ "relevance", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Requested Marketplace sort order; the actor also sorts by verified output values when applicable.", "default": "relevance" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "number", "description": "Optional minimum listing price. Listings without a verifiable price are excluded when this filter is used." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Optional maximum listing price." }, "condition": { "title": "Condition", "enum": [ "any", "new", "used_like_new", "used_good", "used_fair" ], "type": "string", "description": "Optional verified item-condition filter.", "default": "any" }, "deliveryMethod": { "title": "Delivery Method", "enum": [ "all", "shipping", "local" ], "type": "string", "description": "Optional verified delivery-method filter.", "default": "all" }, "daysSinceListed": { "title": "Listed Within (days)", "minimum": 0, "type": "integer", "description": "Optional age filter. Listings without a verifiable creation time are excluded when enabled." }, "maxItems": { "title": "Maximum Listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Global output limit across all sources.", "default": 50 }, "maxItemsPerUrl": { "title": "Maximum Listings Per URL", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Per-source output limit.", "default": 50 }, "resultsLimit": { "title": "Legacy Results Limit", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Legacy per-source limit retained for existing integrations. maxItemsPerUrl takes precedence when supplied." }, "scrapeMode": { "title": "Scrape Mode", "enum": [ "fast", "deep", "auto" ], "type": "string", "description": "Fast streams search-page records. Deep visits listing pages for additional fields. Auto follows the detail compatibility setting.", "default": "fast" }, "includeListingDetails": { "title": "Include Listing Details", "type": "boolean", "description": "Compatibility alias that enables deep detail enrichment.", "default": false }, "includeAllPhotos": { "title": "Include All Photos", "type": "boolean", "description": "Enables deep mode so all photo data exposed by Facebook can be retained.", "default": false }, "deduplicateAcrossInputs": { "title": "Deduplicate Across Inputs", "type": "boolean", "description": "Emit each listing ID once across sources. Disable to preserve repeated results from repeated input URLs.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "US residential Apify Proxy is used by default and enforced whenever Apify Proxy is selected because Marketplace access is proxy-dependent.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }