> 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`.

# eBay Listings

Structured eBay data: send `url`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/ebay-listing/` · 1 credit per successful call · Cursor-paginated

## Overview

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

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/ebay-listing/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "url=https://www.ebay.com/sch/i.html?_nkw=shoe&_sop=12" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/ebay-listing/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"url": "https://www.ebay.com/sch/i.html?_nkw=shoe&_sop=12"},
    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. |
| `url` | string | yes | e.g. `https://www.ebay.com/sch/i.html?_nkw=shoe&_sop=12` | eBay search URL containing /sch/ (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. |
| `timeout` | integer | no | `30` | HTTP timeout in seconds (5–120) |
| `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": {
    "url": "https://www.ebay.com/sch/i.html?_nkw=iphone",
    "page": 1,
    "page_size": 60,
    "listings": [
      {
        "item_id": "123456789012",
        "title": "Apple iPhone 15 Pro 256GB Natural Titanium - Unlocked",
        "url": "https://www.ebay.com/itm/123456789012",
        "price": "999.99",
        "currency": "USD",
        "condition": "Brand New",
        "shipping": "Free Shipping",
        "image_url": "https://i.ebayimg.com/images/g/example/s-l1600.jpg",
        "input_url": "https://www.ebay.com/sch/i.html?_nkw=iphone",
        "position": 1
      }
    ],
    "next_cursor": "eyJoIjoiYWJjMTIzIiwicCI6MiwidSI6Imh0dHBzOi8vd3d3LmViYXkuY29tL3NjaC9pLmh0bWw_X25rdz1pcGhvbmUifQ"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `url` | string | `https://www.ebay.com/sch/i.html?_nkw=iphone` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `60` |  |
| `listings` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJoIjoiYWJjMTIzIiwicCI6MiwidSI6Imh0dHBzOi8vd…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `listings[].item_id` | string | `123456789012` |  |
| `listings[].title` | string | `Apple iPhone 15 Pro 256GB Natural Titanium - …` |  |
| `listings[].url` | string | `https://www.ebay.com/itm/123456789012` |  |
| `listings[].price` | string | `999.99` |  |
| `listings[].currency` | string | `USD` |  |
| `listings[].condition` | string | `Brand New` |  |
| `listings[].shipping` | string | `Free Shipping` |  |
| `listings[].image_url` | string | `https://i.ebayimg.com/images/g/example/s-l160…` |  |
| `listings[].input_url` | string | `https://www.ebay.com/sch/i.html?_nkw=iphone` |  |
| `listings[].position` | integer | `1` |  |

## 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/ebay-listing/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"url": "https://www.ebay.com/sch/i.html?_nkw=shoe&_sop=12"}
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

- Nothing special: send the inputs, read the result.

## Related

- [eBay Product Details Scraper](https://docs.scrapier.io/api-reference/ebay/ebay-product-details-scraper.md): Structured eBay data: send `urls`. Single lookup, 1 credit per successful call.
- [eBay Review Scraper](https://docs.scrapier.io/api-reference/ebay/ebay-review-scraper.md): Structured eBay data: send `urls`. Cursor-paginated, 1 credit per successful call.
