{ "openapi": "3.0.1", "info": { "title": "Facebook Marketplace Scraper with Sold Tracker", "description": "Facebook Marketplace scraper, no login: search by words, city, ZIP or category, browse a city, or paste links. Rows carry price, place, date, photo and seller; add details, vehicle and rental facts, a sold tracker for price drops, a memory for new listings and alerts.", "version": "0.2", "x-build-id": "OeGorFTu4Csupl0GE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~facebook-marketplace-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-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/automation_craft~facebook-marketplace-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-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/automation_craft~facebook-marketplace-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-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": "Search words", "type": "array", "description": "What to search for, one search per line (\"iphone 15\", \"sofa\", \"honda civic\"). Every word is searched in every place below. Up to 300 searches per run (words times places times categories).", "items": { "type": "string" } }, "locations": { "title": "Places", "type": "array", "description": "Where to search, one place per line: as Facebook names it (\"Austin, Texas\", \"London, United Kingdom\", \"Toronto, Ontario\"), as coordinates (\"30.2672,-97.7431\"), as a Marketplace city slug (\"nyc\", \"sanfrancisco\", from facebook.com/marketplace/sanfrancisco) or location id (\"108424279189115\"), as a US ZIP code (\"10001\") or as a postal code with its country (\"10115, Germany\", \"M5V, Canada\", \"SW1A, United Kingdom\", \"2000, Australia\"). A place Facebook writes another way, or two places of the same name, get a free row with Facebook's own suggestions and are not searched. A place whose name ends in one of 53 countries the Actor knows (the README lists them), or in a state or province of the United States, Canada, Australia, India, Mexico or Brazil, is searched from an exit in that country, as a local visitor sees it; other places and coordinates from the US (each coverage row names the exit). A place without search words is browsed: the newest listings near it.", "items": { "type": "string" } }, "searchRadiusKm": { "title": "Search area radius (km)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Facebook shows a visitor who is not logged in the listings of about 65 km around one point and ignores a wider radius. Above 65 km, each place is searched at several points of a lattice covering this radius (100 km: 7 points, 200 km: 19, 300 km: 61, 500 km: 127), each its own search with its own coverage row; a listing found from two points is delivered and charged once. Up to 300 searches a run. Leave it out for one point per place." }, "categories": { "title": "Categories", "type": "array", "description": "Search (or browse) inside these Marketplace categories; each category is its own search in every place. Free stuff searches listings priced 0. Property for sale is not shown to visitors who are not logged in and is not offered.", "items": { "type": "string", "enum": [ "vehicles", "propertyrentals", "apparel", "electronics", "entertainment", "family", "free", "garden", "hobbies", "home", "home-improvements", "instruments", "office-supplies", "pets", "sports", "toys", "classifieds" ], "enumTitles": [ "Vehicles", "Property rentals", "Apparel", "Electronics", "Entertainment", "Family", "Free stuff", "Garden and outdoor", "Hobbies", "Home goods", "Home improvement supplies", "Musical instruments", "Office supplies", "Pet supplies", "Sporting goods", "Toys and games", "Classifieds" ] } }, "searches": { "title": "Search rows", "type": "array", "description": "One search per row, each with its own place and filters: [{ \"query\": \"sofa\", \"location\": \"Austin, Texas\", \"maxPrice\": 300 }, { \"location\": \"nyc\", \"category\": \"garden\" }]. Keys: query (none browses), location (required), category, minPrice, maxPrice, daysSinceListed. Rows run in addition to the words times places above." }, "countryPreset": { "title": "Country preset (every Marketplace city of a country)", "type": "string", "description": "A two letter country code (US, CA, GB, AU, IN, MX, BR, NZ and others): every city Facebook's own Marketplace directory lists for the country is searched (or browsed, without words), up to 300 searches a run (the US directory lists 117 cities). Each city is searched from an exit in that country." }, "startUrls": { "title": "Marketplace links", "type": "array", "description": "Facebook Marketplace links to read, one per line: a search link (facebook.com/marketplace/nyc/search?query=bike&maxPrice=300), a category link (facebook.com/marketplace/nyc/electronics) or an item link (facebook.com/marketplace/item/123...). A search link keeps its own place and filters; a filter you set below replaces the link's. An item link is read in full (Listing plus Listing detail). A category link (vehicles and rentals included) reads the sample Facebook shows on that page for that place.", "items": { "type": "string" } }, "watchListings": { "title": "Sold tracker: listings to watch", "type": "array", "description": "Listing ids or item links (facebook.com/marketplace/item/123...) to check on every run: each gets one row saying whether it is available, sold, pending or removed, and whether that or its price changed since the last run (old price, new price, change), against the last seen state the Actor keeps in its memory. One Listing check event per listing checked; an id Facebook never showed is free. Without a memory name a watch only run keeps its state under the name \"watchlist\"; with searches or links too, set a memory name.", "items": { "type": "string" } }, "sortBy": { "title": "Order", "enum": [ "newest", "best_match", "price_low", "price_high", "distance", "oldest", "distance_far", "mileage_low", "mileage_high", "year_new", "year_old" ], "type": "string", "description": "The order Facebook lists the results in. Newest first when left out (each listing's date is on every row either way). Newest first, Facebook fills up with unrelated new listings once the listings with your words run out (after 100 to 250 rows in our runs); a search stops there by itself. Best match stays on topic much deeper: choose it for large searches. The orders marked browsing only are served by Facebook only for places or categories browsed without words, and with them Facebook applies a price range only." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only listings at or above this price, a whole number in the currency of the place searched." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only listings at or below this price, a whole number in the currency of the place searched." }, "daysSinceListed": { "title": "Listed in the last (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only listings Facebook says were listed in the last N days (1 to 365)." }, "listedAfter": { "title": "Listed after", "type": "string", "description": "Only listings created after this moment: a date (2026-10-01), a date and time (2026-10-01T08:00:00Z) or a span back from the run's start (\"24 hours\", \"7 days\", \"2 weeks\"). Older listings are dropped free; newest first, the search stops at the first page that is entirely older." }, "deliveryMethod": { "title": "Delivery", "enum": [ "all", "local_pickup", "shipping" ], "type": "string", "description": "Local pickup, shipping, or both (all, when left out)." }, "itemCondition": { "title": "Condition", "type": "array", "description": "Only listings in these conditions (Facebook's own filter; search rows carry no condition field, the details carry it).", "items": { "type": "string", "enum": [ "new", "used_like_new", "used_good", "used_fair" ], "enumTitles": [ "New", "Used, like new", "Used, good", "Used, fair" ] } }, "availability": { "title": "Availability", "enum": [ "available", "sold" ], "type": "string", "description": "Available listings (when left out), or only listings already sold or pending (Facebook's out of stock filter), for price research. Searches with words or categories." }, "exactMatch": { "title": "Exact match", "type": "boolean", "description": "Ask Facebook to match the search words more strictly (its own exact filter). In our tests it changed little; titleMatchOnly below keeps only titles with every word." }, "vehicleMake": { "title": "Vehicle make", "enum": [ "acura", "alfa_romeo", "aston_martin", "audi", "bmw", "bentley", "buick", "coda", "cadillac", "chevrolet", "chrysler", "daewoo", "daihatsu", "dodge", "eagle", "ferrari", "fiat", "fisker", "ford", "freightliner", "gmc", "genesis", "geo", "honda", "hummer", "hyundai", "infiniti", "isuzu", "jaguar", "jeep", "kia", "lamborghini", "land_rover", "lexus", "lincoln", "lotus", "lucid", "mini", "maserati", "maybach", "mazda", "mclaren", "mercedes_benz", "mercury", "mitsubishi", "nissan", "oldsmobile", "plymouth", "polestar", "pontiac", "porsche", "ram", "rivian", "rolls_royce", "srt", "saab", "saturn", "scion", "smart", "subaru", "suzuki", "tesla", "toyota", "volkswagen", "volvo" ], "type": "string", "description": "Vehicles of this make only (Facebook's own make filter, each make checked live). Without search words the make's name is searched." }, "transmission": { "title": "Transmission", "enum": [ "automatic", "manual" ], "type": "string", "description": "Vehicles with this transmission only (Facebook's own filter)." }, "vehicleSellerType": { "title": "Vehicle seller", "enum": [ "private", "dealer" ], "type": "string", "description": "Vehicles from private sellers or from dealers only (Facebook's own filter). In our tests Facebook showed visitors who are not logged in no dealer listing (Houston, Dallas): dealers only can answer nothing." }, "minYear": { "title": "Vehicle year from", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Vehicles only: the earliest model year (Facebook's vehicle filter; listings that are not vehicles drop out of a search that sets it)." }, "maxYear": { "title": "Vehicle year to", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Vehicles only: the latest model year." }, "minMileage": { "title": "Vehicle mileage from", "minimum": 0, "type": "integer", "description": "Vehicles only: the lowest odometer reading, in the units the listing uses (miles in the US)." }, "maxMileage": { "title": "Vehicle mileage up to", "minimum": 0, "type": "integer", "description": "Vehicles only: the highest odometer reading." }, "titleMatchOnly": { "title": "Only listings whose title has every search word", "type": "boolean", "description": "Facebook adds related listings to a search (a bike for bicycle; a word it does not know can return unrelated listings). On: a listing whose title lacks one of the search words is dropped free and does not count toward \"Listings per search\"; a search stops after three pages in a row without such a listing. Off when left out: every row says whether its title has every word (queryInTitle). Search links read from the link's own words." }, "includeKeywords": { "title": "Title must contain one of", "type": "array", "description": "Keep only listings whose title carries one of these words or phrases (every word of a phrase, any order). Others are dropped free and do not count toward the number per search.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Title must not contain", "type": "array", "description": "Drop, free, every listing whose title carries one of these words or phrases (\"broken\", \"for parts\").", "items": { "type": "string" } }, "sameCityOnly": { "title": "Only the searched city", "type": "boolean", "description": "Drop, free, listings Facebook places in another city than the place searched (Facebook adds nearby towns). For places Facebook names, ZIP codes and the cities of a country preset; not for coordinates, links or a bare city slug." }, "maxDistanceKm": { "title": "Maximum distance (km)", "minimum": 1, "maximum": 20000, "type": "integer", "description": "With details only (a listing's coordinates come with them): every row says withinDistance; with the distance filter on drop, rows farther than this are dropped free. Facebook ignores a search radius for visitors who are not logged in." }, "distanceFilter": { "title": "Distance filter", "enum": [ "mark", "drop" ], "type": "string", "description": "Mark (when left out) or drop the rows beyond the maximum distance." }, "maxListingsPerSearch": { "title": "Listings per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many listings each search (or search link) reads, in Facebook's order; 50 when left out. A listing already delivered in this run, or known to the memory, counts as read and is free." }, "maxListings": { "title": "Listing rows per run", "minimum": 1, "type": "integer", "description": "The cap of listing rows for the whole run, across every search. No cap when left out: the per search number and your charge limit bound the run." }, "includeDetails": { "title": "Add each listing's details", "type": "boolean", "description": "Read each delivered listing's own page too: description, every photo, condition and attributes, coordinates, the seller's join date and rating, vehicle facts and property facts (the Listing detail event, on top of the Listing). Off when left out." }, "includePhotos": { "title": "Every photo with the details", "type": "boolean", "description": "Read every photo of a listing with its details (on when left out). Off saves a call per listing; the main photo stays on every row." }, "extractContacts": { "title": "Contacts from the description", "type": "boolean", "description": "With details: list the e-mail addresses and phone numbers written in the description (contactEmails, contactPhones). Off when left out. These are personal data: use them under the rules that apply to you." }, "memoryName": { "title": "Memory name (only new listings)", "type": "string", "description": "A short name (letters, digits, spaces, . _ , : # ( ) -). Listings delivered under this name are never delivered or charged again in later runs with the same name: schedule the run and get only new listings. The memory belongs to this Actor; two runs on one name at the same time: the second runs free." }, "resetMemory": { "title": "Reset the memory", "type": "boolean", "description": "Forget every listing the memory holds before this run (it needs a memory name). Only a fresh run resets; a run the platform restarts never resets again." }, "reportChanges": { "title": "Report changed listings", "type": "boolean", "description": "With a memory name: a listing delivered before whose price, or sold or pending state, changed is delivered again (changeType UPDATED, with the previous price and state) and charged as a Listing. New rows say changeType NEW." }, "emitUnchanged": { "title": "Include unchanged listings", "type": "boolean", "description": "With a memory name: also deliver the listings the memory knows and that did not change (changeType UNCHANGED), free and without details." }, "stopAtKnownPage": { "title": "Stop at the first page of known listings", "type": "boolean", "description": "With a memory name: a search stops at the first page whose listings the memory all knows (newest first, the rest is older)." }, "descriptionMaxLength": { "title": "Description length", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cut descriptions to this many characters (0 or left out: the whole description; a cut row says descriptionTruncated)." }, "descriptionFormat": { "title": "Description format", "enum": [ "text", "html", "markdown", "all" ], "type": "string", "description": "The description as Facebook's plain text (when left out), or as HTML (descriptionHtml) or Markdown (descriptionMarkdown), or all." }, "compactOutput": { "title": "Compact rows", "type": "boolean", "description": "Only the core fields per row (title, price, place, date, photo, seller, description, link, the search), for AI agents and small exports." }, "excludeEmptyFields": { "title": "Leave out empty fields", "type": "boolean", "description": "Drop fields that are empty (null, empty text, empty lists) from each row." }, "flattenOutput": { "title": "Flat rows", "type": "boolean", "description": "Turn the vehicle and property objects into top level fields (vehicleMake, vehicleMileage, propertyStreet), for spreadsheets and CSV." }, "webhookUrl": { "title": "Webhook address", "type": "string", "description": "After the run, a JSON POST with the run's listings (up to the notification limit) to this https address (Make, Zapier, n8n or your own server)." }, "webhookHeaders": { "title": "Webhook headers", "type": "object", "description": "Extra headers for the webhook ({\"Authorization\": \"Bearer ...\"}); their values are masked in the run's rows and logs." }, "discordWebhookUrl": { "title": "Discord webhook", "type": "string", "description": "A Discord channel webhook (https://discord.com/api/webhooks/...): the run's listings as messages." }, "slackWebhookUrl": { "title": "Slack webhook", "type": "string", "description": "A Slack incoming webhook (https://hooks.slack.com/services/...)." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "A Telegram bot token from @BotFather; goes with the chat id." }, "telegramChatId": { "title": "Telegram chat id", "type": "string", "description": "The chat or channel to post in (a number, or @channelname)." }, "whatsappAccessToken": { "title": "WhatsApp access token", "type": "string", "description": "A WhatsApp Cloud API access token (Meta for Developers); goes with the phone number id and the recipient." }, "whatsappPhoneNumberId": { "title": "WhatsApp phone number id", "type": "string", "description": "Your WhatsApp Business phone number id." }, "whatsappTo": { "title": "WhatsApp recipient", "type": "string", "description": "The recipient's number in international form, digits only (14155552671); WhatsApp delivers only if the recipient wrote to your number in the last 24 hours." }, "notificationLimit": { "title": "Listings per notification", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many listings a notification names (10 when left out); the total is always said." }, "notifyOnlyChanges": { "title": "Notify only new and changed", "type": "boolean", "description": "With a memory name or a sold tracker: name only new and changed listings (and checks that changed)." }, "exitCountry": { "title": "Exit country", "type": "string", "description": "A two letter country code: search every place from an Apify residential exit in this country instead of the country the place name says." } } }, "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 } } } } } } } } } }