/grailed/items/similar

POST /api/grailed/items/similar

Price: 5 credits

Get listings similar to a given Grailed listing by ID or URL

How to use it

Get listings similar to a given Grailed listing, by listing ID or URL. Returns title, price, size, condition, designers, image and the seller for each similar listing.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• item string required — Grailed listing ID or listing URL (examples: "99531639"; minLength: 1)
• count integer required — Max number of similar listings to return (examples: 30; min: 1)

Response

• @type string (default: "GrailedListingHit")
• id integer required
• listing_title string required
• url string nullable
• price number nullable
• price_drops array (default: [])
• dropped boolean (default: false)
• size string nullable
• category string nullable
• category_path string nullable
• department string nullable
• color string nullable
• condition string nullable
• country_of_origin string nullable
• strata string nullable
• styles array (default: [])
• badges array (default: [])
• designer_names string nullable
• designers array (default: [])
  • @type string (default: "GrailedDesignerRef")
  • id integer required
  • name string required
  • alias string nullable
  • departments array (default: [])
  • logo_url string nullable
• image string nullable
• photo_count integer (default: 0)
• measurement_count integer (default: 0)
• location string nullable
• follower_count integer (default: 0)
• buy_now boolean (default: false)
• make_offer boolean (default: false)
• sold boolean (default: false)
• sold_price number nullable
• sold_shipping_price number nullable
• sold_price_includes_shipping boolean nullable
• sold_at integer nullable
• shipping array (default: [])
  • @type string (default: "GrailedShippingOption")
  • region string required
  • amount number nullable
  • is_enabled boolean (default: false)
• seller object nullable
  • @type string (default: "GrailedHitSeller")
  • id integer required
  • alias string nullable
  • image string nullable
  • total_bought_and_sold integer (default: 0)
  • rating_average number nullable
  • rating_count integer (default: 0)
  • is_trusted_seller boolean (default: false)
• created_at integer 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 — Listing not found 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.