{ "openapi": "3.0.1", "info": { "title": "Facebook Marketplace Scraper & API: Vehicles, Rentals, No Login", "description": "Facebook Marketplace scraper and API for listings data without login or account: search by words and place, or give links. Per listing the title, price, city, date, photo and seller; with details the description, condition, coordinates, all photos, vehicle and rental facts, seller rating.", "version": "0.1", "x-build-id": "LiJRKQI0eKDInykHf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hyperbach~facebook-marketplace-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hyperbach-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/hyperbach~facebook-marketplace-scraper/runs": { "post": { "operationId": "runs-sync-hyperbach-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/hyperbach~facebook-marketplace-scraper/run-sync": { "post": { "operationId": "run-sync-hyperbach-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 links or listing ids", "maxItems": 5000, "type": "array", "description": "One a line, as you copy it from Facebook: a search (`https://www.facebook.com/marketplace/nyc/search/?query=bike&maxPrice=300`), a category at a city (`…/marketplace/prague/home-improvements/`, `…/marketplace/austin/vehicles/?minYear=2016`), a city's page (`…/marketplace/london/`), a listing (`…/marketplace/item/1101734965941993/`) or a bare listing id (`1101734965941993`). Any facebook.com host (`m.`, `web.`), with or without `https://`, inside a redirect link (`l.facebook.com/l.php?u=…`) or an old `#!/` link. A link keeps the filters set on Facebook. A value with spaces, a share link, a seller's page, a link with no city or another site gets a free `invalid_input` row.", "default": [], "items": { "type": "string" } }, "searchQueries": { "title": "Search words", "maxItems": 1000, "type": "array", "description": "Search Marketplace for these words, one search a line (`bike`, `iphone 15`), at every city of Cities: each search × each city is one search. Needs Cities. Each search reads to Facebook's own end or Max results per search.", "default": [], "items": { "type": "string" } }, "locations": { "title": "Cities", "maxItems": 1000, "type": "array", "description": "The cities to search, one a line, as Facebook's own Marketplace link names them: the word after `/marketplace/` (`nyc`, `la`, `austin`, `london`, `berlin`, `prague`), the city page id (`108424279189115`) or a Marketplace link of the city. With search words, a point as `latitude,longitude` (`50.0755,14.4378`) searches around that point. Alone (no search words, no category), each city's own feed is read. Facebook does not read a place by a free name or a postal code when logged out: such a value gets a free `invalid_input` row that says so. A place Facebook does not publish gets a free `not_found` row.", "default": [], "items": { "type": "string" } }, "category": { "title": "Category (no search words)", "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-]*)?$", "type": "string", "description": "Browse one category at every city of Cities, with no search words: the word of the category's link (`vehicles`, `propertyrentals`, `home-improvements`). With search words, put the category into the words, or give the category's link in Marketplace links.", "default": "" }, "minPrice": { "title": "Min price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only listings at this price or above, in the city's own currency, whole units (0 = no bound). The filters below apply to Search words and Category, not to Marketplace links.", "default": 0 }, "maxPrice": { "title": "Max price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only listings at this price or below, in the city's own currency, whole units (0 = no bound).", "default": 0 }, "daysSinceListed": { "title": "Listed in the last", "enum": [ "", "1", "7", "30" ], "type": "string", "description": "Only listings listed in the last day, 7 days or 30 days.", "default": "" }, "sortBy": { "title": "Sort", "enum": [ "", "creation_time_descend", "price_ascend" ], "type": "string", "description": "Facebook's order of the list: its own best match, the newest first, or the lowest price first.", "default": "" }, "itemCondition": { "title": "Condition", "type": "array", "description": "Only listings in these conditions (empty = any).", "items": { "type": "string", "enum": [ "new", "used_like_new", "used_good", "used_fair" ], "enumTitles": [ "New", "Used - like new", "Used - good", "Used - fair" ] }, "default": [] }, "onlySold": { "title": "Sold listings only", "type": "boolean", "description": "Off: the listings for sale. On: only the listings marked sold (Facebook's 'out of stock').", "default": false }, "deliveryMethod": { "title": "Delivery", "enum": [ "", "local_pick_up", "shipping" ], "type": "string", "description": "Only local pickup, or only listings that ship. Facebook ships in the US only: elsewhere 'Shipping' lists nothing.", "default": "" }, "minYear": { "title": "Min year", "minimum": 0, "maximum": 2100, "type": "integer", "description": "Vehicles made in this year or later (0 = no bound). The vehicle filters go with search words (`car`, `truck`, `motorcycle`): Facebook applies them to a search; its vehicles category page ignores them for a logged-out visitor.", "default": 0 }, "maxYear": { "title": "Max year", "minimum": 0, "maximum": 2100, "type": "integer", "description": "Vehicles made in this year or earlier (0 = no bound).", "default": 0 }, "minMileage": { "title": "Min mileage", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Vehicles with at least this odometer reading, in the unit the city's listings show (0 = no bound).", "default": 0 }, "maxMileage": { "title": "Max mileage", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Vehicles with at most this odometer reading (0 = no bound).", "default": 0 }, "transmissionType": { "title": "Transmission", "enum": [ "", "manual", "automatic" ], "type": "string", "description": "Only vehicles with this transmission.", "default": "" }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Rentals with at least this many bedrooms (category propertyrentals; 0 = no bound).", "default": 0 }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Rentals with at least this many bathrooms (category propertyrentals; 0 = no bound).", "default": 0 }, "searchDetails": { "title": "Read each listing's item page", "type": "boolean", "description": "Off: the listing as the list shows it (id, link, title, price, city, primary photo, listing date, status, delivery, the seller's name and id). On: also the item page's fields (description, condition, coordinates, category, every photo and the video, vehicle fields, the shipping price, related listing ids); slower.", "default": false }, "tagListings": { "title": "Tag each listing with a model", "type": "boolean", "description": "Off: no tags. On: four labels a language model reads from the listing's words: what the post is (for sale, for rent, wanted, service, swap), what it is about (vehicles, property, electronics, furniture, …), who posts it (private, business or unclear; an unsure answer is unclear) and what the price means (real, a placeholder, free, none), with the model's confidence for each. Billed per tagged listing; a listing the model did not answer is not billed.", "default": false }, "includeKeywords": { "title": "Keep only titles with", "maxItems": 100, "type": "array", "description": "Keep only the listings whose title (and description, with item pages) holds at least one of these words, case aside. The others are dropped before any charge.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Drop titles with", "maxItems": 100, "type": "array", "description": "Drop the listings whose title (and description, with item pages) holds any of these words, case aside (`broken`, `parts only`). Dropped listings are not charged.", "default": [], "items": { "type": "string" } }, "strictLocation": { "title": "Only the city itself", "type": "boolean", "description": "Off: every listing Facebook shows for the city, nearby towns too (Facebook takes no radius logged out). On: only the listings in the city itself; the others are dropped before any charge.", "default": false }, "onlyNew": { "title": "Only new results (memory between runs)", "type": "boolean", "description": "Deliver only the results an earlier run with the same memory did not deliver (older ones it never delivered too: add daysSinceListed to keep a scheduled run to recent listings). For a scheduled task.", "default": false }, "stateStoreName": { "title": "Memory name", "pattern": "^([a-zA-Z0-9][a-zA-Z0-9._-]{0,63})?$", "type": "string", "description": "The name of the memory `onlyNew` keeps (letters, digits, '.', '_', '-'); empty = a name derived from the inputs.", "default": "" }, "maxResultsPerQuery": { "title": "Max results per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each link, search or city after this many listings (1 to 10,000). A listing another value of the run already delivered is skipped and not counted.", "default": 100 }, "maxItems": { "title": "Max results (whole run)", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "The most charged rows of the whole run; 0 = no cap beyond your charge limit.", "default": 0 }, "country": { "title": "Connection country", "enum": [ "", "us", "gb", "de", "cz" ], "type": "string", "description": "The country of the connection the Actor reads through. Empty: the cities' own country where the Actor knows it, else the US. Set it to your cities' country when they are outside the US.", "default": "" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }