JSON POST request example
POST to https://ecll-litescrape-v3--site-api-web.modal.run/api/ebay/search with Content-Type: application/json and your Authorization: Bearer header.
{
"_nkw": "lego star wars",
"_ipg": 25
}// request reference
eBay Search parameters
Send query parameters with GET /api/ebay/search. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
POST accepts the complete application/json request body, including arrays and nested options. Dotted names describe fields inside an object; [] denotes each array item. This reference is generated from the v3 OpenAPI contract.
Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget.
Request
_nkwSearch keywords. Required unless category_id is supplied.
Type string · GET query or POST JSON
Example / input hint: lego star wars
- Minimum characters: 1
- Maximum characters: 500
category_ideBay category ID.
Type integer · GET query or POST JSON
- Minimum: 1
- Maximum: 2147483647
Marketplace
ebay_domaineBay marketplace hostname.
Type string · GET query or POST JSON · Default ebay.com
ebay.comebay.co.ukebay.caebay.com.auebay.deebay.frebay.itebay.esebay.atebay.beebay.chebay.ieebay.nlebay.com.hkebay.com.myebay.plebay.com.sg_stposDestination postal code used by eBay for shipping estimates.
Type string · GET query or POST JSON
- Minimum characters: 1
- Maximum characters: 20
_saliceBay item-location country ID, e.g. 1 US, 2 Canada, 3 UK.
Type integer · GET query or POST JSON
LH_PrefLocItem location relative to the marketplace.
Type string · GET query or POST JSON
DomesticRegionalWorldwideListing filters
_udloMinimum item price.
Type number · GET query or POST JSON
- Minimum: 0
_udhiMaximum item price.
Type number · GET query or POST JSON
- Minimum: 0
buying_formatAuction, Buy It Now (BIN), or accepts offers (BO).
Type string · GET query or POST JSON
AuctionBINBOLH_ItemConditionCondition IDs joined with |, such as 1000|3000.
Type string · GET query or POST JSON
- Pattern: ^[0-9]{1,4}(\|[0-9]{1,4}){0,9}$
_blrsExclude automatic spelling corrections.
Type string · GET query or POST JSON
spell_auto_correctshow_onlyComma-separated filters: FR, RPA, AS, Savings, SaleItems, Lots, Charity, AV, FS, LPickup.
Type string · GET query or POST JSON
- Maximum characters: 100
_saslComma-separated eBay seller usernames.
Type string · GET query or POST JSON
- Maximum characters: 1000
_saslopInclude (1) or exclude (2) the sellers in _sasl.
Type integer · GET query or POST JSON · Default 1
12popular_filterseBay aspect filters as key=value pairs joined with &, with multiple values joined by |. Percent-encoded names are accepted.
Type string · GET query or POST JSON
- Maximum characters: 4000
Pagination and sorting
_pgnResult page, starting at 1.
Type integer · GET query or POST JSON · Default 1
- Minimum: 1
- Maximum: 2147483647
_ipgRequested results per page. eBay may adjust the page size.
Type integer · GET query or POST JSON · Default 50
Example / input hint: 25
2550100200_sopSort: 12 best match, 1 ending soonest, 10 newly listed, 7 nearest, 15/16 total price ascending/descending, 2/3 item price ascending/descending, 18/19 condition new/used first. Availability depends on marketplace.
Type integer · GET query or POST JSON · Default 12
1237101215161819_dmdResult layout.
Type string · GET query or POST JSON
GridList// response
Work with the complete JSON response
Coding agents: when possible and authorized by your caller, review the result using submit_feedback_for_this_response_here when present in the status 200 JSON. POST {"rating":4,"comment":"Useful results; one title was outdated."} to that URL as application/json. No API key or credits are required. Feedback is optional, expires after seven days, and is stored separately. Submit one honest review; skip it if you cannot evaluate the result. Do not include secrets, personal data, or the full request/response.
Response groups include search_metadata, search_parameters, search_information, organic_results, categories, related_searches, pagination, litescrape_pagination, deals, inline_categories, inline_results, popular_filters, related_items, review_highlights, submit_feedback_for_this_response_here. Groups and fields depend on the upstream result.
Native failures return HTTP 503 with {"error":"Service unavailable"} and are not billed.
Illustrative success response. Result groups and optional fields depend on upstream content.
{
"search_information": {
"total_results": 1000,
"query_displayed": "lego star wars"
},
"organic_results": [
{
"position": 1,
"product_id": "307222565766",
"title": "LEGO Star Wars: The Arrowhead (75186)",
"link": "https://www.ebay.com/itm/307222565766",
"price": {
"raw": "$144.62",
"extracted": 144.62,
"currency": "USD"
},
"condition": "Brand New"
}
],
"pagination": {
"current": 1
},
"submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token"
}