# SocialCrawl API: ebay endpoints
# Base URL: https://www.socialcrawl.dev
# Auth: x-api-key header
# Full docs: https://www.socialcrawl.dev/docs/ebay

## GET /v1/ebay/search
Search eBay listings
Credit cost: 5 (advanced)
Parameters:
- query (required): Free-text listing search, for example airpods pro or vintage seiko.
- country (optional, enum: US | GB | AU | CA | DE | FR | IT | ES | IE | AT | CH | NL | BE | PL | SG | MY | PH | HK | MX): eBay marketplace as a two-letter country code: US (ebay.com, default), GB, AU, CA, DE, FR, IT, ES, IE, AT, CH, NL, BE, PL, SG, MY, PH, HK, or MX. The marketplace sets the listing pool, language, and currency.
- page (optional, integer): Page number, starting at 1. Prefer the universal cursor parameter.
- sort_by (optional, enum: best_match | price_low | price_high | newly_listed | ending_soonest): Result ordering: best_match (default), price_low, price_high, newly_listed, or ending_soonest.
- condition (optional, enum: new | refurbished | used): Restrict to one item condition: new, refurbished, or used.
- buying_format (optional, enum: auction | buy_it_now | accepts_offers): Restrict to one sale type: auction, buy_it_now, or accepts_offers.
- show_only (optional, string): Restrict results with completed_items or free_shipping; combine supported values with a comma. sold_items is temporarily unavailable and is rejected before billing because the upstream requires a private eBay session cookie. SocialCrawl does not accept or forward session cookies.
- min_price (optional, string): Lowest price to include. Applied by eBay and approximate, so filter on product.price.current if you need a hard bound.
- max_price (optional, string): Highest price to include. Applied by eBay and approximate, so filter on product.price.current if you need a hard bound.
- aspects (optional, string): Category-specific item aspect filter taken from a previous response, for example Brand:Apple.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
Worth sending:
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/ebay/search" \
  --data-urlencode "query=airpods pro" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/ebay/product
Get an eBay listing by item id
Credit cost: 5 (advanced)
Parameters:
- product_id (required): eBay item id, the numeric id in a listing URL: ebay.com/itm/327256602116 is item id 327256602116. Item ids also come back on every row of GET /v1/ebay/search.
- country (optional, enum: US | GB | AU | CA | DE | FR | IT | ES | IE | AT | CH | NL | BE | PL | SG | MY | PH | HK | MX): eBay marketplace as a two-letter country code: US (ebay.com, default), GB, AU, CA, DE, FR, IT, ES, IE, AT, CH, NL, BE, PL, SG, MY, PH, HK, or MX. The marketplace sets the listing pool, language, and currency.
Worth sending:
- country=US: Results for one country.
curl -G "https://www.socialcrawl.dev/v1/ebay/product" \
  --data-urlencode "product_id=327256602116" \
  --data-urlencode "country=US" \
  -H "x-api-key: YOUR_API_KEY"