API reference
eBay Listing API
Look up one eBay listing by item id or ebay.com/itm URL: full price, condition, seller, item specifics, availability, shipping, returns, and ratings.
Endpoint
/v1/ebay/productlive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
product_id | yes | eBay item id: a numeric legacy id, a v1|…|… RESTful id, or an ebay.com/itm/ URL | 327256602116 |
country | no | Marketplace: a country code (us, gb, de…) or a raw eBay marketplace id (EBAY_US). Default us. | us |
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. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/ebay/product?product_id=327256602116" \ -H "x-api-key: mn_your_key_here"
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/product?product_id=327256602116",
{ 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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/ebay/product?product_id=327256602116",
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.
{
"success": true,
"platform": "ebay",
"endpoint": "/v1/ebay/product",
"data": {
"_warnings": [
"example"
],
"additional_image_urls": [
"example"
],
"adult_only": false,
"aspects": [
{
"name": "example",
"value": "example"
}
],
"availability_status": "example",
"brand": "example",
"buying_options": [
"example"
],
"category_id": "example",
"category_path": "example",
"condition": "example",
"condition_id": "example",
"epid": "example",
"gtin": "example",
"id": "example",
"image_url": "https://example.com/example",
"item_creation_date": "2026-09-01T12:00:00Z",
"item_location": {
"city": "example",
"country": "example",
"postal_code": "example",
"state": "example"
},
"legacy_id": "example",
"marketplace_id": "example",
"mpn": "example",
"price": {
"currency": "example",
"value": 0
},
"quantity_sold": 0,
"rating": {
"average": 0,
"count": 0
},
"returns_accepted": false,
"seller": {
"feedback_percentage": 0,
"feedback_score": 0,
"username": "example"
},
"shipping": {
"cost": {
"currency": "example",
"value": 0
},
"service": "example",
"type": "example"
},
"short_description": "example",
"title": "example",
"top_rated": false,
"url": "https://example.com/example"
},
"credits_used": 1,
"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. |
additional_image_urls | array | null | Optional additional image urls supplied by this operation. Null means unknown. |
adult_only | boolean | null | Optional adult only supplied by this operation. Null means unknown. |
aspects | array | null | Optional aspects supplied by this operation. Null means unknown. |
aspects[].name | string | null | Optional name supplied by this operation. Null means unknown. |
aspects[].value | string | null | Optional value supplied by this operation. Null means unknown. |
availability_status | string | null | Optional availability status supplied by this operation. Null means unknown. |
brand | string | null | Optional brand supplied by this operation. Null means unknown. |
buying_options | array | null | Optional buying options supplied by this operation. Null means unknown. |
category_id | string | null | Optional category id supplied by this operation. Null means unknown. |
category_path | string | null | Optional category path supplied by this operation. Null means unknown. |
condition | string | null | Optional condition supplied by this operation. Null means unknown. |
condition_id | string | null | Optional condition id supplied by this operation. Null means unknown. |
epid | string | null | Optional epid supplied by this operation. Null means unknown. |
gtin | string | null | Optional gtin supplied by this operation. Null means unknown. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
image_url | string | null | Optional image url supplied by this operation. Null means unknown. |
item_creation_date | string | null | Optional item creation date supplied by this operation. Null means unknown. |
item_location | object | null | Optional item location supplied by this operation. Null means unknown. |
item_location.city | string | null | Optional city supplied by this operation. Null means unknown. |
item_location.country | string | null | Optional country supplied by this operation. Null means unknown. |
item_location.postal_code | string | null | Optional postal code supplied by this operation. Null means unknown. |
item_location.state | string | null | Optional state supplied by this operation. Null means unknown. |
legacy_id | string | null | Optional legacy id supplied by this operation. Null means unknown. |
marketplace_id | string | null | Optional marketplace id supplied by this operation. Null means unknown. |
mpn | string | null | Optional mpn supplied by this operation. Null means unknown. |
price | object | null | Source price. Currency, taxes and availability depend on the listing. |
price.currency | string | null | Optional currency supplied by this operation. Null means unknown. |
price.value | number | null | Optional value supplied by this operation. Null means unknown. |
quantity_sold | number | null | Optional quantity sold supplied by this operation. Null means unknown. |
rating | object | null | Source rating; read its accompanying scale and vote count. |
rating.average | number | null | Optional average supplied by this operation. Null means unknown. |
rating.count | number | null | Number of records in this response, not lifetime or total matches. |
returns_accepted | boolean | null | Optional returns accepted supplied by this operation. Null means unknown. |
seller | object | null | Optional seller supplied by this operation. Null means unknown. |
seller.feedback_percentage | number | null | Optional feedback percentage supplied by this operation. Null means unknown. |
seller.feedback_score | number | null | Optional feedback score supplied by this operation. Null means unknown. |
seller.username | string | null | Optional username supplied by this operation. Null means unknown. |
shipping | object | null | Optional shipping supplied by this operation. Null means unknown. |
shipping.cost | object | null | Optional cost supplied by this operation. Null means unknown. |
shipping.cost.currency | string | null | Optional currency supplied by this operation. Null means unknown. |
shipping.cost.value | number | null | Optional value supplied by this operation. Null means unknown. |
shipping.service | string | null | Optional service supplied by this operation. Null means unknown. |
shipping.type | string | null | Optional type supplied by this operation. Null means unknown. |
short_description | string | null | Optional short description supplied by this operation. Null means unknown. |
title | string | null | Source title when supplied. |
top_rated | boolean | null | Optional top rated supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
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