Example
curl -G 'https://socialtap.dev/v1/facebook/listing' \
--data-urlencode 'url=https://www.facebook.com/marketplace/item/1456476040872340/' \
-H "x-api-key: $SOCIALTAP_API_KEY"import { SocialTap } from "socialtap";
const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY
const res = await client.facebook.listing.get({ url: "https://www.facebook.com/marketplace/item/1456476040872340/" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
url: "https://www.facebook.com/marketplace/item/1456476040872340/",
});
const res = await fetch(`https://socialtap.dev/v1/facebook/listing?${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, meta } = body;
console.log(data, meta.credits_charged);import os
import requests
res = requests.get(
"https://socialtap.dev/v1/facebook/listing",
params={"url": "https://www.facebook.com/marketplace/item/1456476040872340/"},
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, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"net/url"
"os"
)
func main() {
q := url.Values{}
q.Set("url", "https://www.facebook.com/marketplace/item/1456476040872340/")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/facebook/listing?"+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"`
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
$query = http_build_query([
'url' => 'https://www.facebook.com/marketplace/item/1456476040872340/',
]);
$ch = curl_init('https://socialtap.dev/v1/facebook/listing?' . $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;require "json"
require "net/http"
uri = URI("https://socialtap.dev/v1/facebook/listing")
uri.query = URI.encode_www_form('url' => 'https://www.facebook.com/marketplace/item/1456476040872340/')
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"]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 = "url=" + encode("https://www.facebook.com/marketplace/item/1456476040872340/");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/facebook/listing?" + 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);
}
}using System.Text.Json;
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));
var query = string.Join("&",
"url=" + Uri.EscapeDataString("https://www.facebook.com/marketplace/item/1456476040872340/"));
var res = await http.GetAsync("https://socialtap.dev/v1/facebook/listing?" + 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"));// 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/listing")
.query(&[("url", "https://www.facebook.com/marketplace/item/1456476040872340/")])
.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(())
}{
"data": {
"approximate_fields": [
"platform_specific.facebook.latitude",
"platform_specific.facebook.longitude"
],
"attributes": [
{
"name": "Condition",
"value": "Used - like new"
},
{
"name": "Material",
"value": "Steel"
},
{
"name": "Bicycle Type",
"value": "Cruiser Bike"
}
],
"availability": "in_stock",
"category": "Bicycles",
"category_id": "1658310421102081",
"condition": "used",
"condition_label": "Used - like new",
"country_code": null,
"currency": "USD",
"description": "Barely used, 24\" steel Huffy Bike perfect for outdoor terrain and everyday rides \n\n-Fully functional brakestyle with progressive sizing and clean seat cover \n\n-If needed, I am willing to deliver the bike to your home or flexible for an at-home pick-up",
"id": "1456476040872340",
"max_price": 45,
"media": [
{
"alt_text": null,
"duration_ms": null,
"expires_at": "2026-10-25T18:00:00Z",
"height": 720,
"thumbnail_url": null,
"type": "image",
"url": "https://scontent-atl3-2.xx.fbcdn.net/v/t39.84726-6/796968328_2328210001329072_7831806606744114668_n.jpg?stp=dst-jpg_p720x720_tt6&_nc_cat=101&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=7b289&oh=SCRUBBE…",
"width": 960
},
{
"alt_text": null,
"duration_ms": null,
"expires_at": "2026-10-25T18:00:00Z",
"height": 960,
"thumbnail_url": null,
"type": "image",
"url": "https://scontent-atl3-1.xx.fbcdn.net/v/t45.5328-4/800796705_2129037657962264_2251174291161391522_n.jpg?stp=dst-jpg_p720x720_tt6&_nc_cat=109&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=23&_nc_ht=scontent-atl3-1.xx&_nc_gid=SCRUBBED&_nc_ss=7b289&oh=SCRUBBED…",
"width": 720
}
],
"original_price": null,
"platform": "facebook",
"platform_specific": {
"facebook": {
"delivery_types": [
"in_person",
"door_pickup",
"door_dropoff"
],
"is_buy_now_enabled": false,
"is_local_pickup": true,
"latitude": 40.663146972656,
"location": "Rockville Centre, NY",
"location_id": null,
"longitude": -73.635864257812,
"postal_code": null,
"price_period": null,
"published_at": "2026-09-09T13:45:37Z",
"seller_joined_at": "2026-09-09T13:20:08Z",
"seller_rating": null,
"seller_rating_count": null
}
},
"price": 45,
"seller": {
"avatar_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t39.30808-1/795438461_122093964159482116_3880964857956452102_n.jpg?stp=c334.0.1380.1380a_cp6_dst-jpg_tt6&cstp=mx1380x1380&ctp=s100x100&_nc_cat=110&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=24&_nc_ht=scontent-atl3-…",
"display_name": "Meredith Hall",
"id": "pfbid0bhJ8iBQwR4XVDCyEgQU4hKBvHyZPUVgJuBYVSa4henf9QvFwHycKvjgyYX3imnYCl",
"is_verified": false,
"url": null,
"username": null
},
"shipping": {
"fee": null,
"is_offered": false
},
"thumbnail_url": "https://scontent-atl3-2.xx.fbcdn.net/v/t39.84726-6/796968328_2328210001329072_7831806606744114668_n.jpg?stp=dst-jpg_p720x720_tt6&_nc_cat=101&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=7b289&oh=SCRUBBE…",
"title": "Barely Used, \"26 Turquoise Huffy Bike",
"type": "listing",
"unknown_fields": [],
"url": "https://www.facebook.com/marketplace/item/1456476040872340/"
},
"meta": {
"request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
"platform": "facebook",
"source": "api",
"is_cached": false,
"credits_charged": 1,
"latency_ms": 2624,
"fetched_at": "2026-10-25T12:00:00Z",
"input": {
"kind": "product",
"id": "1456476040872340",
"url": "https://www.facebook.com/marketplace/item/1456476040872340/"
},
"credits_remaining": 9999,
"client_request_id": null,
"warnings": []
}
}Long arrays and strings are shortened for display; real responses are complete.
Facebook Marketplace listing URL (/marketplace/item/<id>, also under a city's or category's path, or the older /commerce/listing/<id>; www., m. and web. hosts, any query string), or the listing's numeric ID.
Examplehttps://www.facebook.com/marketplace/item/1456476040872340/
url takes Facebook Marketplace product links; another kind of link, or another platform's, fails free with invalid_input. Unknown parameters are rejected with a suggestion, never ignored (Requests).
Parameters every endpoint accepts
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.
fieldsstringReturn 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
200
{data, meta}. data is a product object; meta describes the request (meta). Fields only Facebook Marketplace has are under platform_specific.facebook.
platformstringPlatform ID (tiktokshop, facebook, …).
idstringPlatform-native product or listing ID (string).
urlstring uriCanonical product page URL.
typestringproduct: 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
titlestringProduct name or listing title, as the seller wrote it.
descriptionstringnullableDescription as plain text (paragraphs separated by blank lines); null when it has none or the source does not show it (lists and search results).
categorystringnullableThe platform's most specific category label (Bicycles, Vitamins & Supplements), as shown; not normalized across platforms.
category_idstringnullableThe platform's ID of that category (what its category browsing and filters take).
sellerobjectnullableThe shop or account selling it; null only when the source does not show it.
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
pricenumbernullableCurrent 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_pricenumbernullableHighest 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_pricenumbernullablePrice 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).
currencystringnullableISO 4217 code of every amount of this product (USD); null when no amount is shown.
availabilitystringnullablein_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
conditionstringnullableItem 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_labelstringnullableThe condition as the platform labels it (Used - Like New, Used - Good, Pre-owned).
thumbnail_urlstring urinullableMain 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.
ShowHide 8 child fields
typestringKind of file. New values may be added; treat unknown values as other.
One ofimagevideoaudiogif
urlstring urinullableDirect 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-timenullableWhen url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.
thumbnail_urlstring urinullablePoster or preview image URL.
widthintegernullableWidth in pixels.
heightintegernullableHeight in pixels.
duration_msintegernullableDuration in milliseconds (video and audio only).
alt_textstringnullableAccessibility text provided by the author or platform.
attributesobject[]The product's specifications as name/value pairs, in the platform's order; [] when none.
ShowHide 2 child fields
namestringSpecification name, as shown (Brand, Material, Condition).
valuestringIts value, as shown.
shippingobjectDelivery terms as shown to a buyer in the product's market; each null when not shown.
ShowHide 2 child fields
is_offeredbooleannullableThe seller ships it (false: local pickup only).
feenumbernullableStandard shipping fee in major units of the product's currency; 0 = free shipping.
country_codestringnullableISO 3166-1 alpha-2 market the product is offered in; prices, stock and shipping are that market's.
platform_specificobjectFields 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.
ShowHide 1 child field
facebookobjectnullableA Facebook Marketplace listing's own fields.
ShowHide 13 child fields
locationstringnullableWhere the item is (a city or area, Austin, TX), as Marketplace shows it; null when not shown.
location_idstringnullableMarketplace's ID of the city the item is in: a Marketplace search takes it as its location; null when not shown.
published_atstring date-timenullableWhen it was listed, RFC 3339 UTC; null when not shown.
is_local_pickupbooleannullableThe buyer can pick it up from the seller in person.
latitudenumbernullableWGS 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.
longitudenumbernullableWGS 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_enabledbooleannullableThe item can be bought on Facebook with Marketplace checkout (Buy now); false: the buyer arranges payment with the seller.
seller_ratingnumbernullableThe 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_countintegernullableRatings behind seller_rating; null when the seller's ratings are private.
price_periodstringnullableThe 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_codestringnullablePostal code of the listing's area, as Marketplace shows it (homes and rentals); null when not shown.
seller_joined_atstring date-timenullableWhen 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: 1 error code. Free: errors cost nothing.
invalid_inputNo retryA 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.
401
401 Unauthorized: 1 error code. Free: errors cost nothing.
unauthorizedNo retryThe 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 retryThe 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 retryThe 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 retryThe 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.
404
404 Not Found: 1 error code. Free: errors cost nothing.
not_foundNo retryThe 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, laterThe 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, laterAn 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, laterThe 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, laterThe platform refused every attempt, our own retries included.
Retry later with backoff. Failed requests are free.
overloadedYes, laterSocialTap 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.
From 1 credit per request. Charged only for successful requests. 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 request | Per 1,000 requests |
|---|---|---|
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.listing · operationId facebook.listing.get · Product overview