Skip to main content
GET
Search Listings

Query Parameters

query
string
required
Search keywords. Matches against listing titles.
domain
string
default:"com"
eBay marketplace domain TLD or alias. See /v1/ebay/markets for all supported values.Examples: com, co.uk, de, fr, com.au
category_id
string
Restrict results to an eBay category id. Use /v1/ebay/categories to look up ids.
page
integer
default:1
Page number for paginated results. Range: 1 - 100.
per_page
integer
Results per page. Clamped to one of 60, 120, or 240.
sort_by
string
default:"best_match"
Sort order for results.
condition
string
Item condition filter.
buying_format
string
Buying format filter.
min_price
number
Minimum price filter in the marketplace’s local currency.
max_price
number
Maximum price filter in the marketplace’s local currency.
free_shipping
boolean
default:false
Only return listings with free shipping.

Response

query
string
The search query that was executed.
domain
string
Marketplace domain that was searched.
category_id
string
The category id filter applied (nullable).
sold
boolean
Always false for active-listing search (see /completed for sold).
results
array
Array of matching listings.
facets
object
Available filter facets keyed by name, each a list of string values.
pagination
object
Pagination metadata with current_page, per_page, total_pages, total_results.
scraped_at
string
ISO 8601 timestamp when the results were scraped.

Example Response

Each search request costs 5 credits. Failed requests are not charged.

Authorizations

x-api-key
string
header
required

Query Parameters

query
string
required

Search keywords.

domain
string
default:com

eBay marketplace domain TLD or alias (com, co.uk, de, fr, ...).

category_id
string

Restrict results to a category id.

page
integer
default:1

Page number for paginated results.

Required range: 1 <= x <= 100
per_page
integer

Results per page. Clamped to 60, 120 or 240.

Required range: 1 <= x <= 240
sort_by
enum<string>
default:best_match

Sort order for results.

Available options:
best_match,
ending_soonest,
newly_listed,
price_low_to_high,
price_high_to_low
condition
enum<string>

Item condition filter.

Available options:
new,
open_box,
refurbished,
used,
for_parts
buying_format
enum<string>

Buying format filter.

Available options:
auction,
buy_it_now,
best_offer
min_price
number

Minimum price filter in the marketplace's local currency.

Required range: x >= 0
max_price
number

Maximum price filter in the marketplace's local currency.

Required range: x >= 0
free_shipping
boolean
default:false

Only return listings with free shipping.

Response

200 - application/json

Active listings

query
string | null
domain
string
category_id
string | null
sold
boolean
results
object[]
facets
object
pagination
object
scraped_utc
number | null
scraped_at
string | null