{ "openapi": "3.0.1", "info": { "title": "Facebook Marketplace Vehicles Scraper", "description": "Scrape Facebook Marketplace vehicle listings by city/radius or US state metro hubs.", "version": "0.1", "x-build-id": "nd2ZnypWbeMxtcXwj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fmchisti~facebook-marketplace-vehicles-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fmchisti-facebook-marketplace-vehicles-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/fmchisti~facebook-marketplace-vehicles-scraper/runs": { "post": { "operationId": "runs-sync-fmchisti-facebook-marketplace-vehicles-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/fmchisti~facebook-marketplace-vehicles-scraper/run-sync": { "post": { "operationId": "run-sync-fmchisti-facebook-marketplace-vehicles-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": { "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Vehicle keywords such as Toyota Camry or Ford F-150. Each keyword creates a separate Marketplace search.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Facebook Marketplace search or item detail URLs. When provided, the Actor crawls only these URLs and ignores locationSlug / keywords / state hubs. Existing filters in the URL are preserved.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locationScope": { "title": "Location scope", "enum": [ "location", "state" ], "type": "string", "description": "Used only when Start URLs are empty. Marketplace is radius-based. Use a city location slug, or expand a US state across curated metro hubs with deduplication.", "default": "location" }, "locationSlug": { "title": "Location slug", "type": "string", "description": "Used only when Start URLs are empty. Facebook Marketplace city slug when Location scope is City / location slug. Examples: dallas, austin, new-york, los-angeles." }, "state": { "title": "State", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "DC" ], "type": "string", "description": "Required when Location scope is Specific state. Results are verified against listing location before being saved." }, "radiusMiles": { "title": "Search radius (miles)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Marketplace search radius around each location hub. Allowed values: 1, 2, 5, 10, 20, 40, 60, 80, 100, 250, 500.", "default": 40 }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum listings to save across all searches. Set to 0 for no item limit.", "default": 100 }, "maxPagesPerSearch": { "title": "Max scrolls per search", "minimum": 1, "type": "integer", "description": "How many scroll batches to process for each keyword or location hub. Marketplace uses infinite scroll instead of page numbers.", "default": 3 }, "maxListingAgeDays": { "title": "Only listings from the last (days)", "minimum": 1, "type": "integer", "description": "Optional. Save only listings with a known creation time within this many days. Listings without a date are excluded." }, "scrapeItemDetails": { "title": "Scrape item details", "type": "boolean", "description": "Open each listing for description, VIN, mileage, specs, seller (when available), and images. Recommended for state filtering.", "default": true }, "duplicateCheck": { "title": "Skip existing listings", "type": "boolean", "description": "When enabled, skip detail scraping for listing URLs already known from your duplicate-check API and/or a named Apify Key-Value store. Saves proxy and compute cost on re-runs.", "default": false }, "duplicateCheckApiUrl": { "title": "Duplicate check API URL", "type": "string", "description": "Optional. POST endpoint that accepts { \"listingUrls\": string|string[] } and returns { \"existing\": string[], \"missing\": string[] }. Leave empty to use Apify Key-Value store only." }, "duplicateCheckStoreName": { "title": "Duplicate check store name", "type": "string", "description": "Named Apify Key-Value store that remembers listing URLs across runs. Used whenever Skip existing listings is enabled.", "default": "vehicle-listing-urls" }, "duplicateCheckLeadingStop": { "title": "Stop after consecutive duplicates", "minimum": 1, "maximum": 1000, "type": "integer", "description": "When Skip existing listings is enabled, stop that search after this many consecutive listing URLs are known duplicates (in a row). Default 20. Lower to stop sooner; raise to keep scanning longer.", "default": 20 }, "cookies": { "title": "Facebook cookies (optional)", "type": "array", "description": "Optional session cookies exported from your browser (EditThisCookie / Cookie-Editor JSON). Anonymous mode works for public listings; cookies can deepen pagination and unlock seller identity. Never share cookies publicly." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "US residential proxies are strongly recommended. Facebook blocks many datacenter IPs.", "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 } } } } } } } } } }