Core API
...
Parameters
Core Requests

Search

4min

Search Parameters

GET /request

The Search Parameters are applicable when making a request with type=search to retrieve search results for an Ebay domain - the Ebay domain is specified using the ebay_domain parameter and the search term is specified in the search_term parameter. The parameters should be appended as querystring parameters to the Ebay Product Data API GET HTTP request.

Search results are retrieved from the search results page on Ebay.

Search Results Page
Search Results Page


For example, to request search results for the search term "memory cards" sorted by "high to low price", on ebay.com , the request would be:

HTTP
Curl
Node.js
Python
PHP



Search Parameters

The following parameters are available for all requests made when type=search .

Parameter

Required

Description

ebay_domain

optional

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

category_id

optional

Determines the category to filter search results to. Category IDs can be retrieved from any Ebay search URL in the _sacat Ebay URL querystring parameter.

search_term

optional

A search term to use to search for Ebay items.

  • 

    Document image
    



listing_type

optional

Determines the type of listings to search for.

  • 

    Document image
    



  1. all
  2. Search for listings of any type.



  1. buy_it_now
  2. Search for listings with a Buy It Now price.



  1. auction
  2. Search for auction-format listings.



  1. accepts_offers
  2. Search for listings marked as accepting-offers.

sort_by

optional

Determines the sort order of search results to return. Valid values are:

  1. best_match
  2. Sort search results by best match to the search_term .



  1. price_high_to_low
  2. Sort search results by highest to lowest price.



  1. price_low_to_high
  2. Sort search results by lowest to highest price.



  1. price_high_to_low_plus_postage
  2. Sort search results by highest to lowest price.



  1. price_low_to_high_plus_postage
  2. Sort search results by lowest to highest price.



  1. newly_listed
  2. Sort search results by newest listed first.



  1. ending_soonest
  2. Sort search results by listings ending soonest.

  • 

    Document image
    

condition

optional

Determines the condition of listings to search for. Valid values are:

  1. all
  2. Do not filter on condition, return all listings.



  1. new
  2. Filter to just New listings.



  1. used
  2. Filter to just Used listings.



  1. open_box
  2. Filter to just Open Box listings.



  1. manufacturer_refurbished
  2. Filter to just Manufacturer Refurbished listings.



  1. seller_refurbished
  2. Filter to just Seller Refurbished listings.



  1. parts_or_not_working
  2. Filter to just listings listed for parts or in a not working state.



  1. not_specified
  2. Filter to just listings that do not specify a condition.

  • 

    Document image
    

page

optional

The current page of search results to retrieve.

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.

num

optional

The number of search results to request (note that it's up to Ebay as to how many are actually returned). Valid values are 60 , 120 , 240 .

url

optional

The Ebay search results page URL to retrieve search results from.

Note : If the url parameter is supplied then the sort_by , search_term , listing_type , condition and page parameters are ignored as they should be specified in the url .

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).

facets

optional

A free-form set of search filter facets to use with the request. The facet parameter should be expressed in comma seperated notation, with the name and value of the facet delimited by an equals ("=") character.

For example, to set the Brand facet to the value SanDisk and the Format facet to the value MicroSD the value of the facets request parameter would be facets=Brand=SanDisk,Format=MicroSD .

Facet name and values are case sensitive and can be found in the Ebay search URL. If you have a facet that takes multiple values they can be seperated with a pipe "|" character, for example to set the Brand facet to the values SanDisk and Samsung the facets request parameter would be facets=Brand=SanDisk|Samsung

allow_rewritten_results

optional

Set to false if you wish to exclude results that appear beneath the "Results matching fewer words" banner (meaning the search result doesn't exactly match the search_term and has been suggested as an alternative). An example of the "Results matching fewer words banner is shown below. Defaults to true .

  • 

    Document image
    


Next Steps      Search Results

Updated 07 Aug 2024
Did this page help you?
PREVIOUS
Common
NEXT
Product
Docs powered by Archbee