Resolve a Marketplace location

Try in Playground

Resolve a city or location query into public Marketplace search coordinates.

GET/v1/facebook/marketplace/location/searchx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

querystringrequiredquery

Public keyword/location query, 1–512 characters.

min 1 chars · max 512 chars

ExampleLondon

Response fields

dataobjectoptional

Normalized result with author, post, event or listing data and per-item coverage where applicable.

When include is requested: total rows, successfully enriched rows and failed rows.

hydration.totalinteger

Always included.

hydration.enrichedinteger

Always included.

hydration.failedinteger

Always included.

successboolean

True when usable public data is returned.

statusenum

success or partial on HTTP 200; failed or challenged on failure.

one of: success, partial

requestIdstring

Request correlation UUID.

sourceUrlstring

Canonical public Facebook page used for retrieval.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Completeness of this bounded response. Warnings name restricted, missing, interrupted or unavailable optional data.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

Counted upstream requests, decoded response bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsinteger

Always included.

≥ 0

locationsobject[]

Public source locations; null or empty when no value is exposed.

up to 100 items

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
200	`partial`	Usable data with explicit missing/failed auxiliary coverage.
400	`invalid_request`	Malformed, duplicate, conflicting or unsupported parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The resource is private or restricted.
404	`not_found`	Unknown route or missing resource.
429	`upstream_rate_limited`	Facebook throttled retrieval.
502	`upstream_challenged` `upstream_error` `unsupported_page`	Source challenge, failure or unsupported/mismatched structure.
502	`response_too_large` `payload_too_complex` `request_limit` `unsafe_redirect`	Bounded retrieval or fixed-origin policy failed.
503	`busy`	All Facebook worker slots are occupied.
504	`timeout`	Request deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/facebook/marketplace/location/search?query=London" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/facebook/marketplace/location/search?query=London",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/facebook/marketplace/location/search?query=London",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Facebook Marketplace request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/facebook/marketplace/location/search",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "query": "London"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/facebook/marketplace/location/search?query=London", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/facebook/marketplace/location/search?query=London"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "partial",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://www.facebook.com/synthetic.page/",
  "fetchedAt": "2026-09-12T00:00:00.000Z",
  "coverage": {
    "source": "public_web",
    "complete": false,
    "warnings": [
      "synthetic_example"
    ]
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 1200,
    "durationMs": 500
  },
  "locations": []
}

Malformed, duplicate, conflicting or unsupported parameters.

{
  "success": false,
  "status": "failed",
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  },
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  }
}