Skip to content

SocQAPI/facebook-marketplace-location-search-api

Repository files navigation

Facebook Marketplace Location Search API examples for SocQ

Facebook Marketplace Location Search API API documentation License: MIT Check examples

Find Facebook Marketplace location candidates from a city, region, neighborhood, or place query, returning names, place types, addresses, and coordinates as normalized records.

Try Facebook Marketplace Location Search API · Get an API key · Documentation · All SocQ examples

Use cases

  • Listing search center resolution: Select a candidate latitude and longitude to provide the geographic center required by Facebook Marketplace Search.
  • Same-name place disambiguation: Compare subtitles, city, postal code, address, and coordinates before choosing among candidates with similar names.
  • Reusable location picker data: Store the location ID, display name, place type, and coordinates behind a picker for later local listing queries.
  • Maintain approved search centers: Store selected location IDs, display names, place types, addresses, and coordinates for repeatable Marketplace listing searches.

API behavior

  • query accepts one non-empty city, region, neighborhood, or place name.
  • The endpoint does not accept results_limit; it stores every location candidate returned for the lookup.
  • Compare names, place types, addresses, cities, postal codes, and coordinates when multiple candidates share a similar name.
  • An empty result means the submitted place query was not resolved; it does not establish Marketplace availability for the area.

All requests use the shared asynchronous flow:

submit -> task_id -> poll task -> read every cursor page -> save results

Quick start

cp .env.example .env
export SOCQ_API_KEY="your-api-key"

Run the complete Node.js workflow:

cd node
npm start

Run the complete Python workflow:

python3 -m pip install -r python/requirements.txt
python3 python/main.py

Both examples load payload.example.json, retry transient API responses, wait for task completion, read every cursor page, and save a normalized public Marketplace location-candidate dataset with coordinate context to output/results.json.

Never expose SOCQ_API_KEY in browser code, mobile apps, public repositories, screenshots, fixtures, or logs.

Request

POST https://api.socq.ai/v1/facebook-marketplace/location-search
Authorization: Bearer <SOCQ_API_KEY>
Content-Type: application/json
{
  "query": "Austin"
}

The submit response contains data.task_id. Poll the task endpoint until data.status becomes succeeded or failed, then continue with data.results.next_cursor while data.results.has_more is true.

Complete workflow example

The Node.js and Python programs implement the production-shaped happy path:

  1. Load and validate configuration.
  2. Submit the endpoint-specific payload.
  3. Retry rate-pressure and transient server responses with bounded backoff.
  4. Poll the asynchronous task with a ten-minute application timeout.
  5. Stop cleanly on a failed task and surface the public error message.
  6. Read all cursor pages instead of silently returning only the first page.
  7. Write a stable JSON artifact containing task metadata and normalized records.

Use the synthetic files in fixtures/ for tests and documentation. They do not contain customer, account, or production data.

Production notes

See docs/production-notes.md for validation, retry, timeout, pagination, deduplication, logging, and endpoint-specific guidance.

Responsible use and platform scope

  • Use only publicly accessible Facebook Marketplace locations, listing search results, item pages, and fields supported by the selected endpoint.
  • Do not use the examples to access private seller information, restricted listings, login-only surfaces, or authentication controls.
  • SocQ is not an official API of the represented social platform and is not affiliated with or endorsed by that platform.
  • Before production use, assess the laws, platform terms, privacy obligations, and retention requirements that apply to your organization and use case.
  • Collect only the fields needed for a defined purpose, restrict access, set retention periods, and support correction or deletion workflows where required.
  • Platform names and trademarks belong to their respective owners.

This section describes the public-data boundary; it is not legal advice or a guarantee that every use case is permitted in every jurisdiction.

Repository contents

Path Purpose
curl/request.md Copy-paste submit, poll, and pagination requests
node/index.mjs Complete Node.js workflow
python/main.py Complete Python workflow
payload.example.json Safe endpoint-specific request body
fixtures/ Synthetic submit and task response shapes
docs/production-notes.md Production integration guidance

Releases

Packages

Used by

Contributors

Languages