{ "openapi": "3.0.1", "info": { "title": "Facebook marketplace scraper", "description": "Scrape facebook marketplace listings and export data to CSV, JSON or use as API", "version": "1.3", "x-build-id": "8iVHvXKth2DagAKgR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/curious_coder~facebook-marketplace/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-curious_coder-facebook-marketplace", "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/curious_coder~facebook-marketplace/runs": { "post": { "operationId": "runs-sync-curious_coder-facebook-marketplace", "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/curious_coder~facebook-marketplace/run-sync": { "post": { "operationId": "run-sync-curious_coder-facebook-marketplace", "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": [ "urls" ], "properties": { "urls": { "title": "Facebook marketplace URLs", "type": "array", "description": "Search URLs (e.g. [marketplace search](https://www.facebook.com/marketplace/nyc/cars)) or individual listing URLs (e.g. https://www.facebook.com/marketplace/item/3195892660712281/). Open in incognito to verify accessibility.", "items": { "type": "string" } }, "getListingDetails": { "title": "Get listing details", "type": "boolean", "description": "Scraper will visit details page and extract more information", "default": false }, "getAllListingPhotos": { "title": "Get all listing photos", "type": "boolean", "description": "When get listing details is enabled, fetch listing media (images). Set to false to skip media API calls and reduce requests by ~33%", "default": true }, "strictFiltering": { "title": "Strict filtering", "type": "boolean", "description": "Exclude listings that are broad matches (outside location, similar items, etc.)", "default": false }, "maxPagesPerUrl": { "title": "Max pages per URL", "minimum": 1, "type": "integer", "description": "Maximum number of search pages to scrape per search URL." }, "untilDate": { "title": "Until date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Scrape listings until this date (YYYY-MM-DD). Only works if Get listing details is enabled and search url is sorted by newest first or url contains `sortBy=creation_time_descend`" }, "proxy": { "title": "Set proxy country", "type": "object", "description": "Set proxy country to your target marketplace region (e.g. US, IN, UK). Results depend on proxy region. Proxies are managed internally you only need to set proxy country in proxy input field." }, "cookies": { "title": "Cookies", "type": "string", "description": "Facebook cookies for authenticated scraping. \n\nWhen provided, enables seller details scraping. \n\nRequires logged-in session cookies. \n\nConcurrency is set to 1 and random delays are added when using cookies. Follow these steps to get the cookies:
  1. Install [Cookie-Editor](https://chromewebstore.google.com/detail/cookie-editor/hlkenndednhfkekhgcdicdfddnkalmdm) chrome extension
  2. Login to your facebook account
  3. Click on the extension icon > Export > Header string
  4. Paste the copied contents here

Video - How to get cookies (0:14)" } } }, "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 } } } } } } } } } }