/facebook/marketplace/listings/category

POST /api/facebook/marketplace/listings/category

Price: 20 credits

Browse Facebook Marketplace (facebook.com/marketplace) listings by category and location

How to use it

Browse Facebook Marketplace (facebook.com/marketplace) listings by category slug within a location. Returns id, url, title, price, location (city/state), category_id, image, delivery_types, is_live/is_sold/is_pending for each listing.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string required — Marketplace category slug to browse (e.g. 'electronics', 'vehicles', 'apparel') (examples: "electronics", "vehicles"; minLength: 1)
• location string — Marketplace location slug to browse within (default: "sanfrancisco"; examples: "sanfrancisco"; minLength: 1)
• count integer required — Max result count (examples: 24; min: 1)

Response

• @type string (default: "FacebookMarketplaceListing")
• id string required
• url string required
• description string nullable
• price string nullable
• formatted_price string nullable
• currency string nullable
• condition string nullable
• city string nullable
• state string nullable
• location_text string nullable
• latitude number nullable
• longitude number nullable
• category_id string nullable
• category_name string nullable
• category_path string nullable
• listing_status string nullable
• is_live boolean nullable
• is_sold boolean nullable
• is_pending boolean nullable
• delivery_types array (default: [])
• attributes array (default: [])
  • @type string (default: "FacebookMarketplaceListingAttribute")
  • name string required
  • value string nullable
  • label string nullable
• image string nullable
• photos array (default: [])
  • @type string (default: "FacebookMarketplaceListingPhoto")
  • image string nullable
  • width integer nullable
  • height integer nullable
  • caption string nullable
• share_uri string nullable
• created_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.