{ "openapi": "3.0.1", "info": { "title": "Facebook Marketplace Listing & Price Extractor", "description": "Extract public Facebook Marketplace listings by city feed, category, keyword search, or direct item URL, with price, location, photos, delivery method, seller, and listing status per item.", "version": "1.0", "x-build-id": "hZnF0rAlhJEPRa5AQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~facebook-marketplace-listing-and-price-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-facebook-marketplace-listing-and-price-extractor", "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/nimbryxo-studio~facebook-marketplace-listing-and-price-extractor/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-facebook-marketplace-listing-and-price-extractor", "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/nimbryxo-studio~facebook-marketplace-listing-and-price-extractor/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-facebook-marketplace-listing-and-price-extractor", "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": { "mode": { "title": "Mode", "enum": [ "auto", "search", "urls", "items" ], "type": "string", "description": "What to scrape. auto uses startUrls when present and otherwise builds a keyword search. search builds a search from searchQueries plus location. urls scrapes the given Marketplace search, category, or city-feed URLs. items fetches direct item URLs or numeric IDs.", "default": "auto" }, "startUrls": { "title": "Marketplace URLs or Item IDs", "type": "array", "description": "Marketplace search, city-category, global-category, city-feed, or /marketplace/item/ URLs. In mode=items, a bare numeric listing ID is also accepted.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL", "description": "A valid Facebook Marketplace URL or a listing ID in mode=items." } } }, "default": [] }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "One to 20 keywords or phrases (mode=search or mode=auto without URLs). Each query becomes one source.", "default": [], "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Marketplace location slug, city, postal code, or address used by keyword search (mode=search or mode=auto without URLs). Examples: nyc, Austin, Texas, 90210, London." }, "country": { "title": "Country", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string", "description": "ISO 3166-1 alpha-2 country used when resolving a human location. Use GB for London, CA for Toronto, and so on.", "default": "US" }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Optional search center latitude. Provide longitude too." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Optional search center longitude. Provide latitude too." }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Search radius in kilometres for keyword or category search. URL mode keeps the radius in the URL unless you set this explicitly.", "default": 65 }, "category": { "title": "Category", "enum": [ "all", "vehicles", "electronics", "furniture", "home", "tools", "sports", "toys", "appliances", "jewelry", "autoparts", "garden", "pets", "books", "shoes", "games", "motorcycles", "boats", "antiques", "arts", "health", "cell-phones", "computers", "video-games", "cameras" ], "type": "string", "description": "Marketplace category. If searchQueries is empty, the actor opens the city category feed (or the global category feed for a human location). Books, shoes, games, motorcycles, cell-phones, computers, video-games, and cameras were verified as category feeds but expose no server category ID, so they are not usable as keyword filters; use categoryId or a category URL for those.", "default": "all" }, "categoryId": { "title": "Category ID", "type": "string", "description": "Advanced numeric Facebook category ID. Takes precedence over category when set." }, "sortBy": { "title": "Sort Order", "enum": [ "relevance", "newest", "oldest", "price_asc", "price_desc", "distance" ], "type": "string", "description": "Server-side sort where Marketplace supports it, plus a client-side re-sort by price or posting time. Rows without a price sort last.", "default": "relevance" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "number", "description": "Only listings at or above this price. Rows without a price are dropped." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Only listings at or below this price. Rows without a price are dropped." }, "condition": { "title": "Condition", "enum": [ "any", "new", "used_like_new", "used_good", "used_fair" ], "type": "string", "description": "Server-side condition filter in search/category modes. In deep mode the detail condition is checked too; fast URL rows without condition data are kept.", "default": "any" }, "deliveryMethod": { "title": "Delivery Method", "enum": [ "all", "shipping", "local" ], "type": "string", "description": "Client-side filter over the listing's delivery types. Listings without delivery data are dropped when this filter is active. Legacy local_pickup is accepted as local.", "default": "all" }, "daysSinceListed": { "title": "Listed Within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only listings created within this many days. Rows without a posting time are dropped." }, "availability": { "title": "Availability", "enum": [ "all", "available", "sold", "pending" ], "type": "string", "description": "Client-side status filter. Search feeds are mostly available; sold and pending are more common on direct item pages.", "default": "all" }, "exactMatch": { "title": "Exact Keyword Match", "type": "boolean", "description": "Keep only rows whose title (and description in deep mode) contains every query word.", "default": false }, "maxItems": { "title": "Maximum Listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Global output limit across all sources.", "default": 50 }, "maxItemsPerUrl": { "title": "Maximum Listings Per URL", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Per-source output limit.", "default": 50 }, "maxPagesPerUrl": { "title": "Maximum Pages Per URL", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cost guard for cursor pagination. The actor stops earlier on source exhaustion, a repeated cursor, two empty pages, or maxItems. There is no fixed row cap: a Phase 6 probe reached 1,694 unique search rows across 71 pages before Facebook returned an empty page 72.", "default": 100 }, "scrapeMode": { "title": "Scrape Mode", "enum": [ "fast", "deep", "auto" ], "type": "string", "description": "fast streams feed rows. deep fetches each listing page for description, condition, attributes, seller, coordinates, and photos. auto follows includeListingDetails and includeAllPhotos.", "default": "fast" }, "includeListingDetails": { "title": "Include Listing Details", "type": "boolean", "description": "Compatibility alias that enables deep mode unless scrapeMode=fast is explicit.", "default": false }, "includeAllPhotos": { "title": "Include All Photos", "type": "boolean", "description": "Enables deep mode and adds the full photo gallery.", "default": false }, "rehostImages": { "title": "Rehost Images", "type": "boolean", "description": "Copy primary photos and seller avatars into the actor key-value store so the emitted URLs do not expire. The original Facebook URL is kept in primaryPhotoUrlOriginal. When off, mediaUrlTemporary is emitted.", "default": true }, "deduplicateAcrossInputs": { "title": "Deduplicate Across Inputs", "type": "boolean", "description": "Emit each listing ID once across sources. Disable to preserve repeats from repeated input URLs.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional advanced override. The actor works without a proxy and automatically escalates only when Facebook blocks a request. A missing value never stops a run." } } }, "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 } } } } } } } } } }