eBay API · Endpoint
eBay Ranking Search API
See the order listings appear in for a search, and which of them are promoted.
- 1 credit per call
- Failed calls are free
- Updated
- ebay.search.placements
{ "placements": [ { "item_id": "286865561827", "leaf_category": "177", "promoted": true, "rank": 0, "variant_id": "588893894930" }, { "item_id": "286601719329", "leaf_category": "177", "promoted": true, "rank": 1, "variant_id": "588649223901" } ]}
| # | Leaf category | Promoted | Rank | Item id | Variant id |
|---|---|---|---|---|---|
| 1 | 177 | true | 0 | 286865561827 | 588893894930 |
| 2 | 177 | true | 1 | 286601719329 | 588649223901 |
| 3 | 177 | true | 2 | 264987527030 | 0 |
What you send
The input
object of the request, with every field the endpoint accepts.
| Field | Type | Required | What it does | Example |
|---|---|---|---|---|
| query | string | yes | Search query. | used laptop |
| limit | integer | no | Maximum number of results to return. Allowed values: 60, 120, 240. |
60 |
| page | integer | no | One-based result page to fetch. From 1 to 100. | 1 |
Fields it returns
What each record in the response holds, with the values from the sample above.
| Field | Type | What it is | Example |
|---|---|---|---|
| placements[].item_id | string | eBay's ID for the listing. | 286865561827 |
| placements[].leaf_category | string | eBay's ID for the listing's most specific category. | 177 |
| placements[].promoted | boolean | Whether the listing is a paid placement. | true |
| placements[].rank | integer | The listing's place in the results, starting at 0. | 0 |
| placements[].variant_id | string | eBay's ID for the listing variant. | 588893894930 |
| placements | array | The promotion slots on the page. | 3 records |
Call it from your code, or ask your agent
Set UPSCRAPE_API_KEY to your key and copy a working request.
curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "capability": "ebay.search.placements", "input": { "limit": 60, "page": 1, "query": "used laptop" }}'
import jsonimport osimport requestspayload = json.loads(r'''{ "capability": "ebay.search.placements", "input": { "limit": 60, "page": 1, "query": "used laptop" }}''')response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload,)response.raise_for_status()print(json.dumps(response.json(), indent=2))
const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": `Bearer ${process.env.UPSCRAPE_API_KEY}`, "Content-Type": "application/json", "Prefer": "wait=30", }, body: JSON.stringify({ "capability": "ebay.search.placements", "input": { "limit": 60, "page": 1, "query": "used laptop" }}),});if (!response.ok) { throw new Error(`Upscrape request failed: ${response.status}`);}console.log(JSON.stringify(await response.json(), null, 2));
https://data.upscrape.com/mcp
With Upscrape, get the eBay ranking search for query "used laptop". Tell me what it costs before you run it, then show the results as a table.
More from the eBay API
- eBay Listings Search API1 credit
- eBay Item API1 credit
- eBay Deals API1 credit
- eBay Store Items API1 credit
- eBay Store API1 credit
- eBay Seller Feedback API1 credit
- eBay Product Reviews API1 credit
- eBay Promotions Search API1 credit
- eBay Item Recommendations API1 credit
- eBay Additional Item Recommendations API1 credit
- eBay Categories API1 credit
eBay Ranking Search API FAQ
The short answers. The docs have the long ones.
How much does the eBay Ranking Search API cost?
1 credit per successful call, shown before it runs. You buy credits once, and paid credits never expire.
What do I send?
Send query. The input fields below list every option with its type and limits.
Do I need an eBay login?
No. It reads public eBay data; nothing runs on your account.
Can my AI agent call it?
Yes, over MCP: the agent finds ebay.search.placements, checks its price and runs it with the same credits as the REST API.
Your first eBay call is free.
Up to 100 free credits to start, no card needed.