/reverb/csps/search

POST /api/reverb/csps/search

Price: 10 credits

Search Reverb (reverb.com) canonical products (gear models) by keyword and filters

How to use it

Search Reverb canonical product model pages (CSPs) by keyword, brand, and category. Returns normalized gear models with aggregate pricing and listing counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• currency string — Display currency for prices in the response. (default: "USD"; one of: "USD", "CAD", "EUR", "GBP", "AUD", "JPY", "NZD")
• shipping_region string — Destination shipping region (affects shipping rates and availability). (default: "US_CON"; one of: "XX", "US_CON", "CA", "GB", "AU", "FR", "DE", "JP", "ID", "US_AK", "US_HI", "US_PR", "US_OTHER")
• locale string — Language for localized text in the response. (default: "en"; one of: "en", "fr", "ja", "es", "de", "it")
• query string nullable — Search keyword (examples: "stratocaster", "moog")
• make string nullable — Brand slug filter (examples: "fender", "gibson")
• product_type string nullable — Top-level category slug (examples: "electric-guitars")
• category string nullable — Sub-category slug (examples: "solid-body")
• count integer required — Max number of results to return (min: 1; max: 2500)

Response

• @type string (default: "ReverbCsp")
• id string required
• alias string nullable
• product_title string required
• summary string nullable
• brand string nullable
• review_count integer nullable
• rating_percentage number nullable
• used_total integer nullable
• new_total integer nullable
• used_low_price number nullable
• used_low_price_currency string nullable
• image string nullable
• images array (default: [])
• root_category_slug string nullable
• url string nullable
• canonical_product_ids array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.