/therealreal/products/similar

POST /api/therealreal/products/similar

Price: 1 credit

Get the TheRealReal items that look similar to one product

How to use it

Pass a product alias from the TheRealReal product search or product endpoints to get visually similar items. Prices are in USD.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — TheRealReal product alias or product page URL (examples: "chanel-daily-supple-backpack-wmvp7", "https://www.therealreal.com/products/women/handbags/backpacks/chanel-daily-supple-backpack-wmvp7"; minLength: 1)
• count integer required — Max number of products to return (min: 1)

Response

• @type string (default: "TherealrealProductCard")
• id string required
• alias string nullable
• sku string nullable
• variant_id string nullable
• name string nullable
• url string nullable
• availability string nullable
• condition string nullable
• quantity integer nullable
• price number nullable
• original_price number nullable
• retail_price number nullable
• currency string nullable
• discount_label string nullable
• promo_code string nullable
• promo_label string nullable
• promo_price number nullable
• designer object nullable
  • @type string (default: "TherealrealBrand")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • description string nullable
• artist object nullable
  • @type string (default: "TherealrealBrand")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • description string nullable
• department object nullable
  • @type string (default: "TherealrealDepartment")
  • id string required
  • name string nullable
• categories array (default: [])
  • @type string (default: "TherealrealCategory")
  • id string required
  • name string nullable
  • permalink string nullable
  • url string nullable
  • parent_id string nullable
  • level integer nullable
  • product_count integer nullable
• attributes array (default: [])
  • @type string (default: "TherealrealAttribute")
  • name string required
  • code string nullable
  • values array (default: [])
  • is_measurement boolean nullable
• images array (default: [])
• badge string nullable
• obsession_count integer nullable
• is_editors_pick boolean nullable
• is_first_look boolean nullable
• is_buy_now_eligible boolean nullable

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 — No TheRealReal item has this product alias 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.