Skip to main content
GET
Shop Search
💳 1 credit per request

Authorizations

X-API-Key
string
header
required

API key for authentication. Format: sk_live_xxxxxxxxxxxxx

Get your API key from the Dashboard.

Query Parameters

query
string
required

Term you want to search for

Example:

"shoes"

page
integer

Page number to retrieve

Example:

1

region
string

Region to search shop products in. Available options: US, GB, DE, FR, IT, ID, MY, MX, PH, SG, ES, TH, VN, BR, JP, IE

Example:

"US"

Response

Successful response

Key Response Fields:

  • query — The search term used
  • total_products — Total number of products returned
  • products[] — Array of matching products:
    • product_id — Unique product identifier
    • title — Product listing title
    • image — Product thumbnail with CDN URLs
    • product_price_info.currency_name — Price currency (e.g., USD)
    • product_price_info.currency_symbol — Currency symbol (e.g., $)
    • product_price_info.sale_price_decimal — Current sale price
    • product_price_info.sale_price_format — Formatted sale price string
    • rate_info — Product rating info (if available)
    • sold_info.sold_count — Total units sold
    • seller_info.seller_id — Seller/shop unique identifier
    • seller_info.shop_name — Shop display name
    • seller_info.shop_logo — Shop logo image (if available)
    • seo_url.canonical_url — Product page canonical URL
    • seo_url.slug — URL-friendly product slug