ebay.search

beta Advanced

Search eBay listings (Browse API).

GET /v1/ebay/search

What you get#

A list of eBay results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/ebay/search?q=iphone" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real eBay response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "content": {
        "id": "v1|110123456789|0",
        "createdAt": "2026-09-01T10:00:00Z"
      },
      "entity": {
        "name": "Apple iPhone 13 128GB Blue",
        "url": "https://www.ebay.com/itm/110123456789"
      },
      "listing": {
        "price": 399.99,
        "currency": "USD",
        "condition": "Used",
        "seller": "phonehub"
      },
      "ext": {
        "sellerFeedbackPercent": 99.8
      },
      "media": {
        "thumbnailUrl": "https://i.ebayimg.com/images/g/abc/s-l225.jpg"
      }
    }
  ],
  "metadata": {
    "platform": "ebay",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`itemId`	`content.id`	-
`title`	`entity.name`	-
`itemWebUrl`	`entity.url`	`safeUrl`
`price.value`	`listing.price`	`toNumber`
`price.currency`	`listing.currency`	-
`condition`	`listing.condition`	-
`seller.username`	`listing.seller`	-
`seller.feedbackPercentage`	`ext.sellerFeedbackPercent`	`toNumber`
`itemCreationDate`	`content.createdAt`	`toIsoDate`
`image.imageUrl`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).