eBay Listings
Structured eBay data: send url. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “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
Section titled “Request”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 210const params = new URLSearchParams({ url: "https://www.ebay.com/sch/i.html?_nkw=shoe&_sop=12" });
const res = await fetch(`https://api.scrapier.io/api/v2/ebay-listing/?${params}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000),});const body = await res.json();if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
console.log(body.data.listings);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"])curl -X POST "https://api.scrapier.io/api/v2/ebay-listing/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"url":"https://www.ebay.com/sch/i.html?_nkw=shoe&_sop=12"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
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) |
Advanced
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | 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
Section titled “Response”{ "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" }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.listings.
Response fields
Section titled “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
Section titled “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. More in Pagination.
const url = "https://api.scrapier.io/api/v2/ebay-listing/";let params = { url: "https://www.ebay.com/sch/i.html?_nkw=shoe&_sop=12" };const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call const res = await fetch(`${url}?${new URLSearchParams(params)}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000), }); const body = await res.json(); if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`); const data = body.data; items.push(...(data.listings ?? [])); if (!data.next_cursor) break; // null = last page params = { cursor: data.next_cursor };}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
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- Nothing special: send the inputs, read the result.
Related
Section titled “Related”- eBay Product Details Scraper — Structured eBay data: send
urls. Single lookup, 1 credit per successful call. - eBay Review Scraper — Structured eBay data: send
urls. Cursor-paginated, 1 credit per successful call.