eBay API

Get eBay data as clean JSON with one key: 2 endpoints, 1 to 5 credits per call, the same response shape as every other platform.

What you get#

Onekey exposes eBay as 2 endpoints behind one API key: 1 endpoint return one record (data is an object) and 1 endpoint return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for eBay also works for the rest of the e-commerce & marketplaces category.

Endpoints#

EndpointWhat it doesParametersCreditsStatus
itemOne eBay item by Browse item id.item_id*1beta
searchSearch eBay listings (Browse API).q*5beta

A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.

Make a request#

This calls ebay.item (1 credit, beta). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.

curl "https://api.onekey.dev/v1/ebay/item?item_id=v1%7C110123456789%7C0" \
  -H "x-api-key: YOUR_API_KEY"

Fields you get back#

These unified fields come back from eBay, with the same names as on every other platform. The count is how many of its 2 mapped endpoints return the field; a field the source lacks is null, never missing. 1 platform-specific field (ext.<name>) come on top, documented on each endpoint page.

FieldTypeEndpoints
content.idstring2
entity.namestring2
entity.urlURL2
listing.conditionstring2
listing.currencystring2
listing.pricenumber2
listing.sellerstring2
media.thumbnailUrlURL2
content.createdAtISO 8601 date1
entity.categorystring1
entity.descriptionstring1
listing.brandstring1

The full schema is in Unified schema.

Pricing#

eBay calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.