/therealreal/products/search

POST /api/therealreal/products/search

Price: 20 credits

Search TheRealReal items by free text, designer, category, artist, condition, color, size, store, price, availability, sale, editors' picks, tags and vintage

How to use it

Browse or search TheRealReal items; sold items are included unless only_available is true. Designer ids come from the TheRealReal designers endpoint and category ids from the TheRealReal categories endpoint. Prices and the price filter are in USD.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of products to return (min: 1; max: 1800)
• query string nullable — Free-text search (examples: "prada", "chanel flap bag"; minLength: 1)
• designer_ids array nullable — Designer ids, as id of a designer-kind row in the designers endpoint (examples: ["267"], ["267","1593"])
• category_ids array nullable — Category ids, as id in the categories endpoint (examples: ["493"], ["493","383"])
• artist_ids array nullable — Artist ids, as id of an artist-kind row in the designers endpoint or artist.id in products (examples: ["436"])
• conditions array nullable — Item conditions (one of: "pristine", "excellent", "very_good", "good", "fair", "as_is")
• colors array nullable — Colors and patterns (one of: "black", "brown", "burgundy", "red", "blue", "purple", "pink", "orange", "green", "metallic", "grey", "yellow", "white", "gold", "silver", "animal_print", "pattern_prints", "neutrals", "clear")
• clothing_sizes array nullable — Clothing sizes (one of: "petite", "xxs", "xs", "s", "m", "l", "xl", "xxl", "3xl", "4xl", "5xl")
• shoe_sizes array nullable — US shoe sizes (one of: "3.5", "4", "4.5", "5", "5.5", "6", "6.5", "7", "7.5", "8", "8.5", "9", "9.5", "10", "10.5", "11", "11.5", "12", "12.5", "13", "13.5", "14", "14.5", "15", "15.5", "16", "16.5", "17", "17.5", "18")
• stores array nullable — TheRealReal stores holding the item (one of: "brentwood", "chicago_walton", "dallas_knox_henderson", "greenwich", "houston", "los_angeles_melrose", "manhasset", "marin", "miami_design_district", "nyc_brooklyn", "nyc_madison", "nyc_soho", "newport_beach", "palm_beach", "palo_alto", "san_francisco_union_square", "summit")
• genders array nullable — Women's or men's items (one of: "women", "men")
• watch_styles array nullable — Watch styles (one of: "vintage", "sport", "dress", "diver", "casual", "aviator", "fashion", "pocket", "chronograph", "smart", "complications", "destro", "gmt")
• watch_movements array nullable — Watch movements (one of: "automatic", "quartz", "manual", "co_axial_escapement_automatic", "spring_drive", "solarbeat")
• watch_complications array nullable — Watch complications (one of: "date", "day", "chronograph", "day_date", "moonphase", "full_calendar", "perpetual_calendar", "annual_calendar", "timezone", "power_reserve", "tourbillon", "minute_repeater", "alarm")
• case_diameters array nullable — Watch case diameters (one of: "19mm_and_under", "20_29mm", "30_39mm", "40mm_and_over")
• case_materials array nullable — Watch case materials (one of: "yellow_gold", "rose_gold", "white_gold", "platinum", "silver", "stainless_steel", "stainless_steel_and_gold", "titanium", "ceramic", "other")
• metal_types array nullable — Jewelry metal types (one of: "white_gold", "yellow_gold", "rose_gold", "silver", "platinum", "other")
• gemstones array nullable — Jewelry gemstones (one of: "diamond", "sapphire", "topaz", "onyx", "amethyst", "quartz", "citrine", "turquoise", "ruby", "lapis_lazuli", "tourmaline", "smoky_quartz", "garnet", "abalone", "agate", "alexandrite", "amazonite", "ametrine", "andalusite", "apatite", "aquamarine", "benitoite", "bloodstone", "carnelian", "cats_eye_chrysoberyl", "cats_eye_quartz", "cats_eye_tourmaline", "cats_eye_obsidian", "chalcedony", "chrysoberyl", "chrysoprase", "color_change_sapphire", "demantoid_garnet", "diopside", "emerald", "fire_agate", "opal", "fire_opal", "fluorite", "hematite", "iolite", "jadeite", "jet", "kunzite", "labradorite", "lavender_jadeite", "malachite", "moonstone", "morganite", "moss_agate", "mother_of_pearl", "nephrite", "peridot", "prasiolite", "pyrite", "red_beryl", "rhodochrosite", "rhodonite", "rubellite", "sard", "serpentine", "sodalite", "spessartine_garnet", "spinel", "spodumene", "star_sapphire", "tanzanite", "tigers_eye_quartz", "tsavorite_garnet", "zircon", "druzy", "kyanite", "cavansite", "jasper", "composite_turquoise", "chrysocolla", "rhodolite", "sunstone", "green_beryl", "larimar", "sphene", "rutilated_quartz", "scapolite", "synthetic_ruby", "synthetic_sapphire", "parti_colored_tourmaline", "pectolite", "synthetic_spinel", "obsidian", "tourmalinated_quartz", "howlite", "blue_lace_agate", "dyed_quartzite", "quartzite", "sugilite", "chrysocolla_in_chalcedony", "rose_quartz", "goshenite", "beryl", "aventurine_quartz", "dyed_jadeite", "feldspar", "pietersite", "heliodor", "magnesite", "prehnite", "synthetic_emerald", "hessonite_garnet", "variscite", "synthetic_quartz", "dyed_chalcedony", "stone", "star_ruby", "snowflake_obsidian", "coral", "quench_crackled_quartz", "black_opal", "boulder_opal", "white_opal", "geode", "diaspore", "ammolite", "synthetic_opal", "cats_eye_moonstone", "moonstone_labradorite", "dyed_magnesite", "sagenitic_quartz", "zoisite", "sunstone_moonstone", "cats_eye_aquamarine", "hematine", "sunstone_labradorite", "tiger_iron", "omphacite_jade", "glass", "andesine", "sphalerite", "star_rose_quartz", "synthetic_alexandrite", "coated_druzy", "zultanite", "surface_diffused_sapphire", "color_shift_sapphire", "orange_sapphire", "yellow_sapphire", "green_sapphire", "blue_sapphire", "purple_sapphire", "pink_sapphire", "colorless_sapphire", "black_sapphire", "ruby_in_fuchsite", "paraiba_tourmaline", "moissanite", "cubic_zirconia", "synthetic_star_ruby", "synthetic_star_sapphire", "synthetic_color_change_sapphire")
• stone_shapes array nullable — Jewelry stone shapes (one of: "round", "princess", "emerald", "asscher", "cushion", "pear", "oval", "marquise", "heart", "cabochon", "other", "radiant")
• clarity_grades array nullable — Diamond clarity grades (one of: "fl", "if", "vvs1", "vvs2", "vs1", "vs2", "si1", "si2", "i1", "i2", "vvs1_vvs2", "vvs2_vs1", "vs1_vs2", "vs2_si1", "si1_si2", "si2_i1", "i1_i2", "flawless", "internally_flawless", "very_very_slightly_included", "very_slightly_included", "slightly_included", "included")
• color_grades array nullable — Diamond color grades (one of: "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "e_f", "f_g", "g_h", "h_i", "i_j", "j_k", "k_l", "l_m", "m_n_o", "colorless", "near_colorless", "faint_color", "very_light_color", "light_color", "fancy_light", "fancy", "fancy_intense", "fancy_vivid", "fancy_deep", "fancy_dark", "color_enhanced", "faint_brown", "y_to_z_range", "w_x", "light_brown", "s_t", "u_v", "q_r", "n", "o_p", "very_light_brown", "d_e")
• ring_sizes array nullable — US ring sizes (one of: "1", "1.25", "1.5", "1.75", "2", "2.25", "2.5", "2.75", "3", "3.25", "3.5", "3.75", "4", "4.25", "4.5", "4.75", "5", "5.25", "5.5", "5.75", "6", "6.25", "6.5", "6.75", "7", "7.25", "7.5", "7.75", "8", "8.25", "8.5", "8.75", "9", "9.25", "9.5", "9.75", "10", "10.25", "10.5", "10.75", "11", "11.25", "11.5", "11.75", "12", "12.25", "12.5", "12.75", "13", "13.25", "13.5", "13.75", "14", "14.5", "15")
• art_sizes array nullable — Artwork sizes (one of: "small", "medium", "large", "oversize")
• mens_chest_sizes array nullable — Men's chest sizes, inches (one of: "32_and_under", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48_and_over")
• mens_neck_sizes array nullable — Men's neck sizes, inches (one of: "14.5_and_under", "15", "15.5", "16", "16.5", "17", "17.5", "18_and_over")
• mens_waist_sizes array nullable — Men's waist sizes, inches (one of: "27_and_under", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40_and_over")
• mens_inseam_sizes array nullable — Men's inseam lengths, inches (one of: "27_and_under", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40")
• kids_clothing_sizes array nullable — Kids' clothing sizes (one of: "2", "3", "4", "5", "6", "6x", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16")
• kids_shoe_sizes array nullable — Kids' shoe sizes (one of: "1", "1.5", "2", "2.5", "3", "3.5", "4", "4.5", "5", "5.5", "6", "6.5", "7", "7.5", "8", "8.5", "9", "9.5", "10", "10.5", "11", "11.5", "12", "12.5", "13", "13.5")
• toddlers_shoe_sizes array nullable — Toddlers' shoe sizes (one of: "1", "1.5", "2", "2.5", "3", "3.5", "4", "4.5", "5", "5.5", "6", "6.5")
• infants_clothing_sizes array nullable — Infants' clothing sizes, months (one of: "0m", "1m", "2m", "3m", "6m", "9m", "12m", "18m", "24m")
• infants_shoe_sizes array nullable — Infants' shoe sizes (one of: "0", "0.5", "1", "1.5", "2", "2.5", "3")
• min_price integer nullable — Minimum price in USD (min: 0)
• max_price integer nullable — Maximum price in USD (min: 0)
• only_available boolean — Only items still for sale (default: false)
• only_on_sale boolean — Only discounted items (default: false)
• only_editors_picks boolean — Only editors' picks (default: false)
• only_with_tags boolean — Only items with the original tags (default: false)
• only_vintage boolean — Only vintage items (default: false)
• sort string — Result ordering (default: "newest"; one of: "newest", "lowest_price", "highest_price", "sold_first", "most_obsessed")

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 — 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.