eBay API endpoint

Search eBay listings

Returns normalized eBay search results.

POSTapiKey3 credits/requestebay.SearchOptionebay.searchResponseDoc/ebay/search

Parameters

Name	In	Type	Required	Enum	Example	Description
option	body	object	Yes			eBay search payload
x-api-key	header	string	Yes			API key required

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost: 3 credits/request
Charged response: Successful 2xx responses

Plan	Price	Included credits	Daily cap	Rate limit	Overage
Free	$0/mo	2,000	500 daily credits	5/min	No overage
Starter	$9/mo	20,000	5,000 daily credits	15/min	$0.75/1,000 overage credits when enabled
Growth	$29/mo	100,000	25,000 daily credits	45/min	$0.45/1,000 overage credits when enabled
Pro	$79/mo	400,000	No daily cap	120/min	$0.30/1,000 overage credits
Business	$199/mo	1,200,000	No daily cap	300/min	$0.20/1,000 overage credits
Enterprise	$499/mo	5,000,000	No daily cap	1,000/min	$0.12/1,000 overage credits

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
500	Internal Server Error	#/definitions/app.Response
502	Bad Gateway	#/definitions/app.Response

Request body example

{
  "keyword": "1952 topps baseball mickey mantle #311",
  "limit": 60,
  "listing_type": "active",
  "page": 1
}

Example response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "page": 1,
    "total": 123,
    "has_more": true,
    "result": [
      {
        "image": "https://i.ebayimg.com/images/g/item1/s-l140.webp",
        "caption": "New Listing",
        "item_id": "196435705622",
        "title": "OpenAI Shirt",
        "sub_title": "Brand New",
        "link": "https://www.ebay.com/itm/196435705622"
      }
    ]
  }
}

Request schema

#/definitions/ebay.SearchOption

Field	Type	Required	Enum	Example	Description
keyword	string	Yes		1952 topps baseball mickey mantle #311	keyword to search on Ebay
limit	integer	No	60, 120, 240	60	Number of items per page
listing_type	string	No	active, sold, completed, sold_completed	active	Listing type to search
page	integer	No		1	Page number

Response schema

#/definitions/ebay.searchResponseDoc

Field	Type	Required	Example	Description
code	integer	No		Code is the HTTP status code or a custom code used to indicate the result of the request @example 200
data	ebay.SearchResp	No
data.has_more	boolean	No	true
data.page	integer	No	1
data.result	array	No
data.result[].bid_count	integer	No	9
data.result[].caption	string	No	caption
data.result[].image	string	No	https://i.ebayimg.com/images/g/b6wAAOSwLRdmZeHS/s-l500.jpg
data.result[].is_authenticity_guaranteed	boolean	No	false
data.result[].item_id	string	No	196435705622
data.result[].link	string	No	https://www.ebay.com/itm/196435705622
data.result[].location	string	No	Canada
data.result[].logistic	string	No	+$4.95 shipping
data.result[].offer_note	string	No	Buy It Now
data.result[].price	number	No	49.95
data.result[].price_from	number	No	10	$10 to $20
data.result[].price_to	number	No	20
data.result[].rating	number	No	5
data.result[].rating_num	integer	No	1
data.result[].seller	string	No	soonerfan1949 (998) 100%
data.result[].sold_count	integer	No	178
data.result[].sub_title	string	No	Pre-Owned
data.result[].title	string	No	1983 TOPPS BASEBALL - 1952 TOPPS REPRINTS #311 MICKEY MANTLE
data.result[].watcher_count	integer	No	26
data.total	integer	No	120
msg	unknown	No		Msg is the message that describes the result of the request @example "Request successful"

Example request

curl -X POST "https://api.crawlora.net/api/v1/ebay/search" -H "x-api-key: <api-key>" -H "Content-Type: application/json" -d '{"keyword":"1952 topps baseball mickey mantle #311","limit":60,"listing_type":"active","page":1}'

TypeScript fetch

const url = new URL("https://api.crawlora.net/api/v1/ebay/search");
const headers = new Headers();
headers.set("x-api-key", "<api-key>");
headers.set("Content-Type", "application/json");
const response = await fetch(url, {
  method: "POST",
  headers,
  body: JSON.stringify({
    "keyword": "1952 topps baseball mickey mantle #311",
    "limit": 60,
    "listing_type": "active",
    "page": 1
  }),
});
const payload = await response.json();

Open in Playground Back to group