Core APIs
...
Ebay
Core Requests

Search

3min

Ebay Search Parameters

GET /search?engine=ebay

The Ebay Search Parameters are applicable when making a request with engine=ebay to retrieve Ebay search results for a given search term. The search term is specified in the q parameter and the optional ebay_domain parameter can be used to specify the Ebay domain used for the request. A full list of supported Ebay domains can be found here.

Ebay Search Results
Ebay Search Results


For example, to request Ebay search results for the keyword playing cards on ebay.com , the request would be:

HTTP
Curl
Node.js
Python
PHP



Ebay Search Parameters

The following parameters are available for all requests made when engine=ebay .

Parameter

Required

Description

engine

required

Should be set to engine=ebay .

q

required

The keyword you want to use to perform the search.

ebay_domain

optional

The Ebay domain to retrieve search results from. For a full list of supported Ebay domains see Supported Ebay Domains .

page

optional

Determines the page of results to return, defaults to 1 .

max_page

optional

Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response.

See the Pagination docs for more information.

sold_items

optional

Determines whether to filter Ebay search results to just 'sold items'. Valid values are true or false (default).

completed_items

optional

Determines whether to filter Ebay search results to just 'completed items'. Valid values are true or false (default).

authorized_sellers

optional

Determines whether to filter Ebay search results to just items offered by 'authorized sellers'. Valid values are true or false (default).

returns_accepted

optional

Determines whether to filter Ebay search results to just 'returns accepted items'. Valid values are true or false (default).

free_returns

optional

Determines whether to filter Ebay search results to just 'free returns items'. Valid values are true or false (default).

authenticity_verified

optional

Determines whether to filter Ebay search results to just 'authenticity verified items'. Valid values are true or false (default).

deals_and_savings

optional

Determines whether to filter Ebay search results to just 'deals and savings items'. Valid values are true or false (default).

sale_items

optional

Determines whether to filter Ebay search results to just 'sale items'. Valid values are true or false (default).

page

optional

Determines the page of results to return, defaults to 1 . Use in combination with the num parameter to implement pagination.

max_page

optional

Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response.

See the Pagination docs for more information.



Next Steps      Ebay Search Results

Updated 15 Aug 2024
Did this page help you?