> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Facebook Marketplace

Structured Facebook data: send `urls`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/facebook-marketplace/` · 1 credit per successful call · Cursor-paginated · Long-running

## Overview

Call `GET /api/v2/facebook-marketplace/` with `urls`. The results are in `data.listings`; send `data.next_cursor` back as `cursor` to get the next page. 3 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/facebook-marketplace/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=https://www.facebook.com/marketplace/108479165840750/search/?query=phone" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/facebook-marketplace/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "https://www.facebook.com/marketplace/108479165840750/search/?query=phone"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["listings"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `urls` | string | yes | e.g. `https://www.facebook.com/marketplace/108479165840750/search/?query=phone` | Marketplace search URL (with '?query=<term>') or category/browse URL (e.g. /marketplace/category/vehicles, no query needed) — both return real listings fully anonymously. Required first call. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `deepScrape` | boolean | no | `false` | Fetch detailed per-listing (PDP) data. Locked in cursor. |
| `cookie_string` | string | no | — | Optional Facebook session cookie ("c_user=...; xs=...") for a genuinely logged-in scrape. NOT required for baseline results. Locked in cursor. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.listings`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "urls": "https://www.facebook.com/marketplace/category/vehicles",
    "page": 1,
    "page_size": 24,
    "listings": [
      {
        "id": "l-1",
        "title": "2018 Honda Civic",
        "price": "$12,500",
        "location": "Brooklyn, NY"
      }
    ],
    "next_cursor": "eyJpIjoidXJsIiwicCI6Mn0"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `https://www.facebook.com/marketplace/category…` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `24` |  |
| `listings` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJpIjoidXJsIiwicCI6Mn0` | Pass back as `cursor` for the next page. `null` on the last page. |
| `listings[].id` | string | `l-1` |  |
| `listings[].title` | string | `2018 Honda Civic` |  |
| `listings[].price` | string | `$12,500` |  |
| `listings[].location` | string | `Brooklyn, NY` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/facebook-marketplace/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"urls": "https://www.facebook.com/marketplace/108479165840750/search/?query=phone"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("listings") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Locked into the cursor: `deepScrape`, `cookie_string`. Set them on the first call; later pages reuse them.
- This endpoint can take several minutes. Set your client timeout to at least 210 seconds.

## Related

- [Facebook Ad Library](https://docs.scrapier.io/api-reference/facebook/facebook-ad-library.md): Structured Facebook data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [Facebook Ad Library Leads](https://docs.scrapier.io/api-reference/facebook/facebook-ad-library-leads.md): Structured Facebook data: send `urls`. Cursor-paginated, 2 credits per successful call.
- [Facebook Ad Library Ad Transcript](https://docs.scrapier.io/api-reference/facebook/facebook-ad-library-transcript.md): Structured Facebook data: send `urls`. Single lookup, 3 credits per successful call.
- [Facebook Comment Replies](https://docs.scrapier.io/api-reference/facebook/facebook-comment-replies.md): Structured Facebook data: send `feedback_id`. Cursor-paginated, 1 credit per successful call.
