{ "openapi": "3.0.1", "info": { "title": "Facebook Marketplace Scraper: Listings, Prices, Sellers", "description": "Scrape Facebook Marketplace by keyword and city or coordinates, or by search, category and listing links: title, price, currency, location, seller, listed time, condition, category, photos and description. No login.", "version": "0.1", "x-build-id": "GtDbN7dGozAaLZacZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~facebook-marketplace-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-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/themineworks~facebook-marketplace-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-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/themineworks~facebook-marketplace-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-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": { "searchQueries": { "title": "Keywords", "type": "array", "description": "What to search for, one keyword per line, as you would type it in the Marketplace search box. Example: iphone 15, sofa, honda civic. Each keyword is one search around the location below.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "The city to search around, for example \"Austin, Texas\", \"London, United Kingdom\" or \"Mumbai\". A Marketplace city slug such as nyc or la works too, and so do coordinates written as \"40.71,-74.00\". Ignored when latitude and longitude are set.", "default": "New York, New York" }, "latitude": { "title": "Latitude (optional)", "type": "number", "description": "Search around this point instead of a city name. Give longitude too. Example: 30.2672." }, "longitude": { "title": "Longitude (optional)", "type": "number", "description": "Search around this point instead of a city name. Give latitude too. Example: -97.7431." }, "radiusKm": { "title": "Radius in km", "minimum": 1, "maximum": 500, "type": "integer", "description": "Search radius sent to Facebook, 1 to 500 km. Facebook's logged out search mostly ignores it and returns listings around the place, nearest areas first. With details on, each row has distance_km from the search point, so you can filter exactly.", "default": 65 }, "startUrls": { "title": "Marketplace links (optional)", "type": "array", "description": "Links copied from your browser: a search (https://www.facebook.com/marketplace/nyc/search/?query=guitar, filters in the link are kept), a category (https://www.facebook.com/marketplace/nyc/vehicles/) or one listing (https://www.facebook.com/marketplace/item/1234567890/). A bare listing id works too.", "items": { "type": "string" } }, "maxListingsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The most listings to return for each keyword, search link or category link, 1 to 5,000. Facebook shows a logged out visitor about 1,700 to 2,200 listings per search, then ends the list. Listing links always return their one listing.", "default": 50 }, "includeDetails": { "title": "Read each listing's details (description, condition, all photos)", "type": "boolean", "description": "On: each listing's details are read too, for the description, condition, category name, all photos, exact coordinates and distance, currency, seller rating and join date, and vehicle fields (make, model, mileage, transmission). Off: rows come from the search results only (title, price, city, seller name, listed time, one photo), which is faster. Same price either way.", "default": true }, "minPrice": { "title": "Min price (optional)", "minimum": 0, "type": "integer", "description": "Lowest price, in the local currency of the place you search. Example: 100." }, "maxPrice": { "title": "Max price (optional)", "minimum": 0, "type": "integer", "description": "Highest price, in the local currency of the place you search. Example: 500." }, "sortBy": { "title": "Sort by", "enum": [ "best_match", "newest", "price_low_to_high", "price_high_to_low", "distance_nearest", "vehicle_year_newest", "vehicle_mileage_lowest" ], "type": "string", "description": "Order of the results. Newest first is the one to use for monitoring new listings.", "default": "best_match" }, "daysSinceListed": { "title": "Listed in the last", "enum": [ "any", "1", "7", "30" ], "type": "string", "description": "Only listings posted in this window.", "default": "any" }, "itemCondition": { "title": "Condition", "type": "array", "description": "Only listings in these conditions. Leave empty for any condition.", "items": { "type": "string", "enum": [ "new", "used_like_new", "used_good", "used_fair" ], "enumTitles": [ "New", "Used, like new", "Used, good", "Used, fair" ] } }, "deliveryMethod": { "title": "Delivery", "enum": [ "all", "local_pick_up", "shipping" ], "type": "string", "description": "Local pickup only, shipping only, or both.", "default": "all" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Facebook Marketplace is read through Apify residential proxy (United States by default); Facebook refuses Marketplace queries from datacenter proxies. Pick a residential country close to the place you search if you like; any country works for any place.", "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 }, "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 } } } } } } } } } }