The eBay Search API returns eBay search listings. Pass a keyword or a search URL on a supported eBay site.
Piloterr uses the webunlocker. Costs 3 credits per successful call.
A keyword searches https://www.ebay.com. A full URL keeps its host only when that site is supported. Any other host, including ebay.be, returns 400.
| Site |
Currency |
www.ebay.com |
USD |
www.ebay.co.uk |
GBP |
www.ebay.fr |
EUR |
www.ebay.de |
EUR |
www.ebay.it |
EUR |
www.ebay.es |
EUR |
www.ebay.at |
EUR |
www.ebay.ch |
CHF |
www.ebay.nl |
EUR |
www.ebay.pl |
PLN |
www.ebay.ie |
EUR |
www.ebay.ca |
CAD |
www.ebay.com.au |
AUD |
GET https://api.piloterr.com/v2/ebay/search?query=laptop
GET https://api.piloterr.com/v2/ebay/search?query=https://www.ebay.fr/sch/i.html?_nkw=iphone
GET https://api.piloterr.com/v2/ebay/search?query=laptop&page=2
Example (keyword):
laptop
Example (search URL):
https://www.ebay.fr/sch/i.html?_nkw=ordinateur
query is required. Two forms work.
| Form |
Example |
What happens |
| Keyword |
laptop |
Search runs on https://www.ebay.com/sch/i.html |
| Search URL |
https://www.ebay.fr/sch/i.html?_nkw=ordinateur |
The host is kept when it is in the supported list above. The path must start with /sch |
An item URL (/itm/…) passed here returns 400. Use eBay Product. Any other host returns 400, including ebay.be, benl.ebay.be and befr.ebay.be. An empty value returns 400.
page is optional. It sets _pgn. Leave it empty and a keyword starts at page 1. On a URL, the page already in the URL is kept. A value below 1 returns 400.
| Parameter |
Type |
Required |
Description |
query |
string |
yes |
Keyword on ebay.com, or a /sch URL on a supported site |
page |
integer |
no |
Page (_pgn). Default 1 for a keyword |
return_page_source |
boolean |
no |
Raw HTML as {"result": "..."} |
| Code |
Meaning |
400 |
Empty query, or eBay host not in the supported list |
403 |
Page blocked |
404 |
No parseable listings |
500 |
Fetch failed |