Facebook Marketplace

Facebook Marketplace Search API

Searches public Facebook Marketplace listings by keyword around a place, given as coordinates or a Marketplace location. Each result has its title, price with the struck-through earlier one, currency, availability, main photo, seller, city, category, the day it was listed and delivery options, and vehicles their mileage. Filter by radius, price, condition, days listed, availability, delivery method and category, and sort by relevance, newest, distance or price.

GET /v1/facebook/search_listings

Try it

Example

cURL

curl 'https://socialtap.dev/v1/facebook/search_listings?lat=30.2677&lng=-97.7475&query=couch' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

TypeScript SDK

import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.facebook.searchListings.list({ query: "couch", lat: 30.2677, lng: -97.7475 });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);

Node.js (fetch)

const params = new URLSearchParams({
  lat: "30.2677",
  lng: "-97.7475",
  query: "couch",
});
const res = await fetch(`https://socialtap.dev/v1/facebook/search_listings?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);

Python (requests)

import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/facebook/search_listings",
    params={"lat": "30.2677", "lng": "-97.7475", "query": "couch"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])

Go (net/http)

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("lat", "30.2677")
	q.Set("lng", "-97.7475")
	q.Set("query", "couch")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/facebook/search_listings?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Page  json.RawMessage `json:"page"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}

PHP

<?php

$query = http_build_query([
    'lat' => '30.2677',
    'lng' => '-97.7475',
    'query' => 'couch',
]);
$ch = curl_init('https://socialtap.dev/v1/facebook/search_listings?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;

Ruby

require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/facebook/search_listings")
uri.query = URI.encode_www_form('lat' => '30.2677', 'lng' => '-97.7475', 'query' => 'couch')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]

Java

import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "lat=" + encode("30.2677")
            + "&lng=" + encode("-97.7475")
            + "&query=" + encode("couch");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/facebook/search_listings?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}

.NET

using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "lat=" + Uri.EscapeDataString("30.2677"),
    "lng=" + Uri.EscapeDataString("-97.7475"),
    "query=" + Uri.EscapeDataString("couch"));
var res = await http.GetAsync("https://socialtap.dev/v1/facebook/search_listings?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));

Rust

// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/facebook/search_listings")
        .query(&[("lat", "30.2677"), ("lng", "-97.7475"), ("query", "couch")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}

200 OK

{
  "data": [
    {
      "approximate_fields": [],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": "1583634935226685",
      "condition": null,
      "condition_label": null,
      "country_code": null,
      "currency": "USD",
      "description": null,
      "id": "2453157098823358",
      "max_price": 150,
      "media": [],
      "original_price": 199,
      "platform": "facebook",
      "platform_specific": {
        "facebook": {
          "delivery_types": [
            "in_person"
          ],
          "is_buy_now_enabled": null,
          "is_local_pickup": true,
          "latitude": null,
          "location": "Austin, TX",
          "location_id": "106224666074625",
          "longitude": null,
          "postal_code": null,
          "price_period": null,
          "published_at": "2026-08-08T23:19:48Z",
          "seller_joined_at": null,
          "seller_rating": null,
          "seller_rating_count": null
        }
      },
      "price": 150,
      "seller": {
        "avatar_url": null,
        "display_name": "Emma Lacayo",
        "id": "pfbid028Sb5xn7vbqx7e9FMM94r2aYCMPpRvZ3tqQrtarsZFL3C4J9qjTrG5yKqfHATwFV7l",
        "is_verified": null,
        "url": null,
        "username": null
      },
      "shipping": {
        "fee": null,
        "is_offered": false
      },
      "thumbnail_url": "https://scontent-atl3-2.xx.fbcdn.net/v/t39.84726-6/770825152_1048174351401284_1140858447926294965_n.jpg?stp=c0.87.526.526a_dst-jpg_p526x395_tt6&_nc_cat=104&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=14&_nc_ht=scontent-atl3-2.xx&_nc_gid=SCRUBBED&_nc_ss=7…",
      "title": "Couch",
      "type": "listing",
      "unknown_fields": [
        "attributes",
        "media"
      ],
      "url": "https://www.facebook.com/marketplace/item/2453157098823358/"
    },
    {
      "approximate_fields": [],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": "1583634935226685",
      "condition": null,
      "condition_label": null,
      "country_code": null,
      "currency": "USD",
      "description": null,
      "id": "2058904701477440",
      "max_price": 0,
      "media": [],
      "original_price": 50,
      "platform": "facebook",
      "platform_specific": {
        "facebook": {
          "delivery_types": [
            "in_person"
          ],
          "is_buy_now_enabled": null,
          "is_local_pickup": true,
          "latitude": null,
          "location": "Austin, TX",
          "location_id": "106224666074625",
          "longitude": null,
          "postal_code": null,
          "price_period": null,
          "published_at": "2026-10-30T22:41:54Z",
          "seller_joined_at": null,
          "seller_rating": null,
          "seller_rating_count": null
        }
      },
      "price": 0,
      "seller": {
        "avatar_url": null,
        "display_name": "Joseph Nelson",
        "id": "pfbid02LXiNxAkFuVeVVp6m2pNoHNMKLHXNfewhx35WhL5p3DJTrxZEnmKBiEUGxhHqnexl",
        "is_verified": null,
        "url": null,
        "username": null
      },
      "shipping": {
        "fee": null,
        "is_offered": false
      },
      "thumbnail_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t39.84726-6/865992404_2598858703877779_3582095600555384707_n.jpg?stp=c123.0.540.540a_dst-jpg_p180x540_tt6&_nc_cat=106&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=14&_nc_ht=scontent-atl3-1.xx&_nc_gid=SCRUBBED&_nc_ss=…",
      "title": "Sectional couch",
      "type": "listing",
      "unknown_fields": [
        "attributes",
        "media"
      ],
      "url": "https://www.facebook.com/marketplace/item/2058904701477440/"
    },
    {
      "approximate_fields": [],
      "attributes": [],
      "availability": "in_stock",
      "category": null,
      "category_id": "1583634935226685",
      "condition": null,
      "condition_label": null,
      "country_code": null,
      "currency": "USD",
      "description": null,
      "id": "1074423591747937",
      "max_price": 300,
      "media": [],
      "original_price": null,
      "platform": "facebook",
      "platform_specific": {
        "facebook": {
          "delivery_types": [
            "in_person",
            "public_meetup"
          ],
          "is_buy_now_enabled": null,
          "is_local_pickup": true,
          "latitude": null,
          "location": "Austin, TX",
          "location_id": "106224666074625",
          "longitude": null,
          "postal_code": null,
          "price_period": null,
          "published_at": "2026-08-31T16:04:49Z",
          "seller_joined_at": null,
          "seller_rating": null,
          "seller_rating_count": null
        }
      },
      "price": 300,
      "seller": {
        "avatar_url": null,
        "display_name": "Jayden Collon",
        "id": "pfbid0k18cWpao4WmR78cmx1CL23UERiW9rwJXQ3xLJgMu1ktX7xtacBKxFb8EakqyUA9ul",
        "is_verified": null,
        "url": null,
        "username": null
      },
      "shipping": {
        "fee": null,
        "is_offered": false
      },
      "thumbnail_url": "https://scontent-atl3-2.xx.fbcdn.net/v/t39.84726-6/789581205_1093657659864910_5715105961279626720_n.jpg?stp=c0.87.526.526a_dst-jpg_p526x395_tt6&_nc_cat=104&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=14&_nc_ht=scontent-atl3-2.xx&_nc_gid=SCRUBBED&_nc_ss=7…",
      "title": "grey sofa/loveseat,couch with hidden compartments and can oull out to make longer",
      "type": "listing",
      "unknown_fields": [
        "attributes",
        "media"
      ],
      "url": "https://www.facebook.com/marketplace/item/1074423591747937/"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "c1.EXAMPLE_CURSOR",
    "next_cursor_expires_at": "2026-10-26T12:00:00Z",
    "end_reason": null
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "facebook",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 1593,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": null,
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

Long arrays and strings are shortened for display; real responses are complete.

Good to know

Every search needs a place: lat and lng, or location.
Results show what a Marketplace results page shows. Description, condition, more photos, coordinates and the seller's rating come from the Facebook Marketplace Listing API, sent each result's url.
Each listing's currency is read from its price as shown, since a price can be in another currency than the place's.
A page holds as many listings as Marketplace served, which varies: fewer than limit is not the end of the list, and has_more says whether more follow.
A limit below the default splits one Marketplace page over several requests, and Marketplace can reorder that page in between, so a walk with a small limit can repeat or skip a listing. The default limit avoids it.
Marketplace widens a search with few results, so results can be close matches of the keywords and from beyond radius_km.
newest sorts by day, so later pages can hold listings newer than earlier ones.
period is Marketplace's own filter, which counts more than the day a listing was first posted: a result's published_at can be earlier than the window.

Authorizations

x-api-keystringheaderrequired

Your API key. Authentication

Query parameters

querystringrequiredmax 200 chars

Keywords to search listings for. Marketplace also returns close matches.

Examplecouch

latnumbermin -90max 90

Latitude of the place to search around (WGS 84 degrees), with lng; or use location.

Example30.2677

lngnumbermin -180max 180

Longitude of the place to search around (WGS 84 degrees), with lat; or use location.

Example-97.7475

locationstringmax 300 chars

The place to search around, instead of lat and lng: a Marketplace place ID (platform_specific.facebook.location_id of a listing there, such as 106224666074625), the city name in Marketplace's links (austin, nyc, paris) or such a link (https://www.facebook.com/marketplace/austin/). An unknown one returns not_found.

Exampleaustin

radius_kmintegermin 1max 805

How far around the place to search, in kilometers (default 65). Marketplace widens a search with few results near the place.

min_pricenumbermin 0max 2,147,483,647

Only listings at this price or above, in major units of the local currency.

max_pricenumbermin 0max 2,147,483,647

Only listings at this price or below, in major units of the local currency. Omitted or 0 means no upper bound, so it cannot select only free listings.

sortstring

Order of the results. relevance (default): Marketplace's Suggested order. newest: the latest listed first. nearest: the closest to the place first. price_asc, price_desc: the lowest or the highest price first.

One ofrelevancenewestnearestprice_ascprice_desc

periodstring

The window the ranking counts over, in days back from the platform's latest update (each endpoint lists its own). Only listings Marketplace counts as listed in the last 1, 7 or 30 days, in whole calendar days (today counts, so 1 can include yesterday's). All dates when omitted.

One of1730

Example7

conditionstringmax 60 chars

Only listings in these conditions, comma-separated: new, used_like_new, used_good, used_fair. All when omitted.

Examplenew,used_good

availabilitystring

available (default): listings for sale now. sold: listings marked sold or with a sale pending.

One ofavailablesold

delivery_methodstring

all (default), only listings the buyer can pick up (local_pickup), or only those the seller ships (shipping), which can come from far away.

One ofalllocal_pickupshipping

category_idstringmax 25 chars

Only listings in this Marketplace category (data[].category_id of a listing, such as 1658310421102081 for Bicycles).

limitintegermin 1max 30

Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.

Example30

cursorstring

page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.

Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.

Parameters every endpoint accepts

max_ageintegermin 0

Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.

fieldsstring

Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.

Response

application/json

200

{data, page, meta}. data is an array of up to 30 product objects, Marketplace's Suggested order; page says how to get the next page; meta describes the request (meta). Fields only Facebook Marketplace has are under platform_specific.facebook.

platformstring

Platform ID (tiktokshop, facebook, …).

idstring

Platform-native product or listing ID (string).

urlstring uri

Canonical product page URL.

typestring

product: a catalog product a shop sells in many units, often in variants (TikTok Shop, Instagram and YouTube shopping); listing: a single item a person or business lists for sale (Facebook Marketplace). New values may be added; treat unknown values as product.

One ofproductlisting

titlestring

Product name or listing title, as the seller wrote it.

descriptionstringnullable

Description as plain text (paragraphs separated by blank lines); null when it has none or the source does not show it (lists and search results).

categorystringnullable

The platform's most specific category label (Bicycles, Vitamins & Supplements), as shown; not normalized across platforms.

category_idstringnullable

The platform's ID of that category (what its category browsing and filters take).

sellerobjectnullable

The shop or account selling it; null only when the source does not show it.

Show 6 child fields

idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

pricenumbernullable

Current price in major units of currency (58.47), discounts applied; for a product whose variants cost different amounts, the lowest (the platform's "from" price). Coupons and shipping excluded. 0 = free; null when not shown.

max_pricenumbernullable

Highest current variant price, in major units of currency; equal to price when every variant costs the same; null when unknown (a source that shows one price).

original_pricenumbernullable

Price before the discount (the struck-through list price), in major units of currency; null when the platform shows no earlier price (not discounted, or not shown).

currencystringnullable

ISO 4217 code of every amount of this product (USD); null when no amount is shown.

availabilitystringnullable

in_stock: can be bought now; out_of_stock: sold out for now (a product can be restocked); pre_order: ships later; pending: a listing with a sale pending; sold: a listing marked sold. Null when the platform does not say. New values may be added; treat unknown values as null.

One ofin_stockout_of_stockpre_orderpendingsold

conditionstringnullable

Item condition, coarse: new, used (any grade) or refurbished; null when the platform does not say. The platform's own grade is condition_label. New values may be added; treat unknown values as used.

One ofnewusedrefurbished

condition_labelstringnullable

The condition as the platform labels it (Used - Like New, Used - Good, Pre-owned).

thumbnail_urlstring urinullable

Main product image URL. Platform CDN URLs can expire within hours.

mediaobject[]

Product images in the platform's order (main image first), then any product video; [] when none.

Show 8 child fields

typestring

Kind of file. New values may be added; treat unknown values as other.

One ofimagevideoaudiogif

urlstring urinullable

Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.

thumbnail_urlstring urinullable

Poster or preview image URL.

widthintegernullable

Width in pixels.

heightintegernullable

Height in pixels.

duration_msintegernullable

Duration in milliseconds (video and audio only).

alt_textstringnullable

Accessibility text provided by the author or platform.

attributesobject[]

The product's specifications as name/value pairs, in the platform's order; [] when none.

Show 2 child fields

namestring

Specification name, as shown (Brand, Material, Condition).

valuestring

Its value, as shown.

shippingobject

Delivery terms as shown to a buyer in the product's market; each null when not shown.

Show 2 child fields

is_offeredbooleannullable

The seller ships it (false: local pickup only).

feenumbernullable

Standard shipping fee in major units of the product's currency; 0 = free shipping.

country_codestringnullable

ISO 3166-1 alpha-2 market the product is offered in; prices, stock and shipping are that market's.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>): TikTok Shop's brand, rating, variants, stock and units sold; Marketplace's location and listing date. Each null when unknown.

Show 1 child field

facebookobjectnullable

A Facebook Marketplace listing's own fields.

Show 13 child fields

locationstringnullable

Where the item is (a city or area, Austin, TX), as Marketplace shows it; null when not shown.

location_idstringnullable

Marketplace's ID of the city the item is in: a Marketplace search takes it as its location; null when not shown.

published_atstring date-timenullable

When it was listed, RFC 3339 UTC; null when not shown.

is_local_pickupbooleannullable

The buyer can pick it up from the seller in person.

latitudenumbernullable

WGS 84 latitude of the listing's area in degrees (Facebook shows an area, not the seller's address: always listed in approximate_fields); set together with longitude.

longitudenumbernullable

WGS 84 longitude of the listing's area in degrees (always listed in approximate_fields); set together with latitude.

delivery_typesstring[]

How the item changes hands, as Marketplace lists it: in_person (local pickup), shipping, door_pickup, door_dropoff, public_meetup. [] when not shown (listed in unknown_fields). New values may be added.

is_buy_now_enabledbooleannullable

The item can be bought on Facebook with Marketplace checkout (Buy now); false: the buyer arranges payment with the seller.

seller_ratingnumbernullable

The seller's average Marketplace rating as a seller, 1 to 5 stars; null when the seller's ratings are private or there are none.

seller_rating_countintegernullable

Ratings behind seller_rating; null when the seller's ratings are private.

price_periodstringnullable

The period price pays for: month for a property rental's monthly rent (Marketplace shows $914 / Month); null for a sale price. New values may be added.

One ofmonth

postal_codestringnullable

Postal code of the listing's area, as Marketplace shows it (homes and rentals); null when not shown.

seller_joined_atstring date-timenullable

When the seller joined Facebook, RFC 3339 UTC; null when not shown.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text ("10K+ sold"), and of Facebook's coarse listing coordinates. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a list or search result that does not show attributes or variants); null already means unknown for every other field. [] when every list is known.

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

400

400 Bad Request: 2 error codes. Free: errors cost nothing.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

invalid_cursorNo retry

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized: 1 error code. Free: errors cost nothing.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

402

402 Payment Required: 2 error codes. Free: errors cost nothing.

insufficient_creditsNo retry

The account does not have enough credits for this request.

Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.

spend_limit_reachedNo retry

The API key reached its spend limit for this period. The account may still have credits.

Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.

403

403 Forbidden: 2 error codes. Free: errors cost nothing.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

private_or_unavailableNo retry

The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.

Only public items can be fetched. Do not retry.

404

404 Not Found: 1 error code. Free: errors cost nothing.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

500

500 Internal Error: 1 error code. Free: errors cost nothing.

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

upstream_errorYes, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

503

503 Unavailable: 2 error codes. Free: errors cost nothing.

upstream_blockedYes, later

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, later

SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.

Retry after the seconds in the retry-after header. Failed requests are free.

Pagination

Items come in pages, Marketplace's Suggested order. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).

Order: sort=relevance (the default): Marketplace's Suggested order; sort=nearest: the closest to the place first; sort=newest: the latest listed first, by the day: later pages can hold newer listings; sort=price_asc: the lowest price first; sort=price_desc: the highest price first
Page size: Up to 30 listings (the default; limit lowers it)
Cursor lifetime: 3 hours; don't store cursors
Price: Per page, 1 credit

The `page` object

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

cURL: next page

curl 'https://socialtap.dev/v1/facebook/search_listings?lat=30.2677&lng=-97.7475&query=couch&cursor=c1.EXAMPLE_CURSOR' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

The price is per page: each successful page costs the same, whatever limit is and however many items it has. Empty pages are charged too (an empty page with has_more: true is not the end).
A limit below 30 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting limit is the cheapest way to walk the list.
Errors are free, including a rejected cursor.
Pages served from the cache are free.
An expired or altered cursor, or one sent with different parameters, fails with invalid_cursor (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

Pricing

From 1 credit per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as meta.source; sources are tried cheapest first: Platform API → Public page.

Source	Price per successful page	Per 1,000 pages
Platform API `api`	1 credit	$0.75–$1.97
Public page `page`	1 credit	$0.75–$1.97

Balance, sources and what you were charged

Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.source	Source	What it means
`api`	Platform API	The platform's public, logged-out API.
`page`	Public page	Data embedded in the platform's public web page.

meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs

Endpoint ID facebook.search_listings · operationId facebook.search_listings.list · Product overview