Endpoint
GET/v1/ebay/searchlive · proven3 creditsParameters
Query parameters
| 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) | price_asc |
condition | no | Item condition filter, comma-separated: new, used, refurbished, open_box, for_parts | new |
buying_format | no | Buying format filter, comma-separated: fixed_price, auction, best_offer, classified_ad | auction |
show_only | no | Extra filters, comma-separated: free_shipping, returns_accepted, authenticity_guarantee | 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 |
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
One envelope across every endpoint
This illustrative envelope is not a live response or a payload schema. 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": { "…": "platform-specific fields" },
"credits_used": 3,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}Failures return the shared typed error envelope and cost nothing. Response contract · Error reference