/v1/facebook/marketplace/search
Marketplace Search
Search Facebook Marketplace listings
| Credit cost | Default: 1 credit How charges are determinedCost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute. |
|---|---|
| Cache support | Not specified in the published contract. |
| Pagination | No explicit pagination metadata in the published contract. Consult the parameters and response fields below. |
Parameters
| Name | Location / required | Schema |
|---|---|---|
querySearch keyword. Required unless category_id is provided. | query / optional |
|
latLatitude for the search location | query / required |
|
lngLongitude for the search location | query / required |
|
category_idUse an ID below to browse without a keyword. Other category IDs require a keyword. | query / optional |
|
radius_kmSearch radius in kilometers | query / optional |
|
min_priceMinimum listing price | query / optional |
|
max_priceMaximum listing price | query / optional |
|
sort_byFacebook Marketplace sort option. creation_time_descend usually orders the first pages newest first, but Facebook can insert newer listings on later cursor pages. | query / optional |
Allowed values |
delivery_methodDelivery filter | query / optional |
Allowed values |
conditionCondition filter | query / optional |
Allowed values |
date_listedFacebook Marketplace date filter. Uses the same calendar-day buckets as the UI, so last_24_hours can include listings from the prior calendar day. | query / optional |
Allowed values |
availabilityAvailability filter | query / optional |
Allowed values |
cursorOpaque pagination cursor returned from the previous response. Pass it back as-is. | query / optional |
|
Request examples
Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.
cURL
curl --request GET 'https://api.fetchproof.com/v1/facebook/marketplace/search?lat=YOUR_LAT&lng=YOUR_LNG' \
--header 'x-api-key: YOUR_API_KEY'JavaScript
const response = await fetch("https://api.fetchproof.com/v1/facebook/marketplace/search?lat=YOUR_LAT&lng=YOUR_LNG", {
method: 'GET',
headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());Python
import os
import requests
response = requests.get("https://api.fetchproof.com/v1/facebook/marketplace/search?lat=YOUR_LAT&lng=YOUR_LNG",
headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)Responses
200Success. Envelope: success / credits_remaining / credits_charged.
application/json
object
successrequired
boolean
credits_remainingrequired
integer
credits_chargedrequired
integer
listingsrequired
array
Array items
object
idrequired
string
urlrequired
string
titlerequired
string
creation_timerequired
null
listing_date_textrequired
null
pricerequired
object
formatted_amountrequired
string
amount_with_offset_in_currencyrequired
integer
amountrequired
integer
strikethrough_pricerequired
null
locationrequired
object
cityrequired
string
staterequired
string
display_namerequired
string
city_page_idrequired
string
primary_photorequired
object
idrequired
string
urlrequired
string
category_idrequired
string
is_hiddenrequired
boolean
is_liverequired
boolean
is_pendingrequired
boolean
is_soldrequired
boolean
is_viewer_sellerrequired
boolean
delivery_typesrequired
array
Array items
string
story_typerequired
string
story_keyrequired
string
cursorrequired
string
has_next_pagerequired
boolean