API reference

eBay Listings Search API

Search live eBay listings by keyword: title, price, condition, seller, shipping, and thumbnails, with filters for price, condition, and buying format.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/ebay/searchlive · proven3 credits

Try in Playground

Parameters

Query parameters

Useful optional inputs

country — Select the documented market or country filter.
Read this endpoint’s country semantics; filtering and source request location can differ.
cursor — Continue the same source traversal with the complete returned cursor.
Saved-result retrieval and a new source page can have different prices; quote the next call.
dry_run — Read a free estimate before fetching sources or scheduling paid work.
Zero credits; cache status and availability are snapshots rather than guarantees.

Name	Required	Description	Example
`query`	yes	Keywords to search listing titles for	`iphone 11`
`country`	no	Marketplace: a country code (us, gb, de, au, ca, fr…) or a raw eBay marketplace id (EBAY_US). Default us.	`us`
`page`	no	1-based page number (mapped to offset = (page-1)*limit); use cursor to paginate reliably	`1`
`sort_by`	no	Best-effort sort: price_asc, price_desc, newest, or distance (unrecognized values are ignored) Accepted values: price, price_asc, price+shipping, -price, price_desc, newly_listed, newest, new, distance. Case, spaces, hyphens and underscores are interchangeable.	`price_asc`
`condition`	no	Item condition filter, comma-separated: new, used, refurbished, open_box, for_parts Accepted values (comma-separated): new, used, refurbished, open_box, for_parts, seller refurbished. Case, spaces, hyphens and underscores are interchangeable.	`new`
`buying_format`	no	Buying format filter, comma-separated: fixed_price, auction, best_offer, classified_ad Accepted values (comma-separated): fixed, fixed_price, buy_it_now, bin, auction, best_offer, classified, classified_ad. Case, spaces, hyphens and underscores are interchangeable.	`auction`
`show_only`	no	Extra filters, comma-separated: free_shipping, returns_accepted, authenticity_guarantee Accepted values (comma-separated): free_shipping, returns_accepted, authenticity_guarantee. Case, spaces, hyphens and underscores are interchangeable.	`free_shipping`
`min_price`	no	Minimum price in the marketplace currency	`50`
`max_price`	no	Maximum price in the marketplace currency	`500`
`aspects`	no	Raw eBay aspect_filter expression to narrow by item aspects	`Brand:{Apple}`
`cursor`	no	Opaque pagination cursor returned by the previous page (a stringified offset)	`25`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/ebay/search?query=iphone%2011" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/ebay/search?query=iphone%2011",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/ebay/search?query=iphone%2011",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "ebay",
  "endpoint": "/v1/ebay/search",
  "data": {
    "_warnings": [
      "example"
    ],
    "count": 0,
    "cursor": null,
    "dropped": 0,
    "items": [
      {
        "adult_only": false,
        "bid_count": 0,
        "buying_options": [
          "example"
        ],
        "categories": [
          {}
        ],
        "condition": "example",
        "condition_id": "example",
        "current_bid_price": {
          "currency": "example",
          "value": 0
        },
        "epid": "example",
        "id": "example",
        "image_url": "https://example.com/example",
        "item_location": {
          "country": "example",
          "postal_code": "example"
        },
        "legacy_id": "example",
        "marketplace_id": "example",
        "price": {
          "currency": "example",
          "value": 0
        },
        "seller": {
          "feedback_percentage": 0,
          "feedback_score": 0,
          "username": "example"
        },
        "shipping": {
          "cost": {},
          "type": "example"
        },
        "thumbnail_url": "https://example.com/example",
        "title": "example",
        "url": "https://example.com/example"
      }
    ],
    "marketplace_id": "example",
    "query": "example",
    "total": 0
  },
  "credits_used": 3,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`_warnings`	`array \| null`	Optional warnings supplied by this operation. Null means unknown.
`count`	`number \| null`	Number of records in this response, not lifetime or total matches.
`cursor`	`string \| null`	Opaque next-page token; pass it back unchanged. Null does not prove complete history.
`dropped`	`number \| null`	Optional dropped supplied by this operation. Null means unknown.
`items`	`array \| null`	Returned records. Source coverage and completeness vary.
`items[].adult_only`	`boolean \| null`	Optional adult only supplied by this operation. Null means unknown.
`items[].bid_count`	`number \| null`	Optional bid count supplied by this operation. Null means unknown.
`items[].buying_options`	`array \| null`	Optional buying options supplied by this operation. Null means unknown.
`items[].categories`	`array \| null`	Optional categories supplied by this operation. Null means unknown.
`items[].condition`	`string \| null`	Optional condition supplied by this operation. Null means unknown.
`items[].condition_id`	`string \| null`	Optional condition id supplied by this operation. Null means unknown.
`items[].current_bid_price`	`object \| null`	Optional current bid price supplied by this operation. Null means unknown.
`items[].current_bid_price.currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`items[].current_bid_price.value`	`number \| null`	Optional value supplied by this operation. Null means unknown.
`items[].epid`	`string \| null`	Optional epid supplied by this operation. Null means unknown.
`items[].id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`items[].image_url`	`string \| null`	Optional image url supplied by this operation. Null means unknown.
`items[].item_location`	`object \| null`	Optional item location supplied by this operation. Null means unknown.
`items[].item_location.country`	`string \| null`	Optional country supplied by this operation. Null means unknown.
`items[].item_location.postal_code`	`string \| null`	Optional postal code supplied by this operation. Null means unknown.
`items[].legacy_id`	`string \| null`	Optional legacy id supplied by this operation. Null means unknown.
`items[].marketplace_id`	`string \| null`	Optional marketplace id supplied by this operation. Null means unknown.
`items[].price`	`object \| null`	Source price. Currency, taxes and availability depend on the listing.
`items[].price.currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`items[].price.value`	`number \| null`	Optional value supplied by this operation. Null means unknown.
`items[].seller`	`object \| null`	Optional seller supplied by this operation. Null means unknown.
`items[].seller.feedback_percentage`	`number \| null`	Optional feedback percentage supplied by this operation. Null means unknown.
`items[].seller.feedback_score`	`number \| null`	Optional feedback score supplied by this operation. Null means unknown.
`items[].seller.username`	`string \| null`	Optional username supplied by this operation. Null means unknown.
`items[].shipping`	`object \| null`	Optional shipping supplied by this operation. Null means unknown.
`items[].shipping.cost`	`object \| null`	Optional cost supplied by this operation. Null means unknown.
`items[].shipping.type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`items[].thumbnail_url`	`string \| null`	Optional thumbnail url supplied by this operation. Null means unknown.
`items[].title`	`string \| null`	Source title when supplied.
`items[].url`	`string \| null`	Original source URL when supplied.
`marketplace_id`	`string \| null`	Optional marketplace id supplied by this operation. Null means unknown.
`query`	`string \| null`	Optional query supplied by this operation. Null means unknown.
`total`	`number \| null`	Source-reported total; null is unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

eBay Listings Search API

Query parameters

Make the request

Response fields and example

Useful next calls

First call in under a minute