/spinny/listings/search

POST /api/spinny/listings/search

Price: 10 credits

Search Spinny used-car listings in a city or across India by make or model, price, year, kilometres, fuel, body type, transmission, colour, seats, owners, stock status, category, features, registration state and hub: price with taxes and discount, EMI and loan rate, year, km, owners, RTO, hub, status flags and photos

How to use it

Pass a returned id to spinny/listings for specifications and features, or to spinny/listings/inspection for the inspection report. Make, model and hub aliases come from spinny/models and spinny/hubs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string nullable — Spinny city alias; all of India when omitted (examples: "delhi-ncr", "mumbai", "bangalore")
• makes array nullable — Make slugs (examples: ["maruti-suzuki"], ["hyundai","tata"])
• models array nullable — Model slugs (examples: ["creta"], ["swift","i20"])
• price_min integer nullable — Minimum price in rupees (min: 0)
• price_max integer nullable — Maximum price in rupees (min: 1)
• year_min integer nullable — Earliest model year (min: 1990; max: 2100)
• km_max integer nullable — Maximum kilometres driven (min: 1)
• fuel array nullable — Fuel types (one of: "petrol", "diesel", "cng", "electric", "hybrid")
• body_type array nullable — Body types (one of: "hatchback", "sedan", "suv", "muv")
• transmission string nullable — Transmission (one of: "automatic", "manual")
• color array nullable — Exterior colours (one of: "white", "silver", "grey", "black", "violet", "purple", "blue", "green", "beige", "yellow", "golden", "bronze", "brown", "orange", "wine", "maroon", "red")
• seats array nullable — Seating capacities (one of: "4", "5", "6-plus")
• owners array nullable — Owner counts
• availability array nullable — Stock status (one of: "available", "booked", "in-refurb", "waitlist-open")
• category array nullable — Spinny car categories (one of: "assured-plus", "assured", "budget", "luxury", "assured-electric", "luxury-electric")
• lifestyle array nullable — Lifestyle categories (one of: "value", "feature-packed", "family", "adventure", "commuter", "luxury")
• features array nullable — Safety and comfort features the car has (one of: "airbags", "fog-lamps", "hill-hold-control", "five_star_ncap,four_star_ncap", "sunroof", "wireless-phone-charging", "air-purifier", "touch-screen-infotainment", "apple-car-play", "parking-sensors", "rear-camera", "360-degree-view-camera", "keyless-start", "cruise-control", "driver-seat-adjustment", "power-windows")
• rto array nullable — Registration state codes (examples: ["dl"], ["hr","up"])
• hubs array nullable — Hub aliases (examples: ["delhi-dwarka-sector-21-taj-vivanta-hub"])
• sort string — Result order; sorting by price or discount needs a city (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "emi_asc", "km_asc", "year_desc", "newest", "discount_desc")
• count integer required — Max number of results (min: 1; max: 5000)

Response

• @type string (default: "SpinnyListing")
• id string required
• url string nullable
• make string nullable
• model string nullable
• variant string nullable
• year integer nullable
• registration_year integer nullable
• km_driven integer nullable
• fuel_type string nullable
• transmission string nullable
• transmission_type string nullable
• body_type string nullable
• color string nullable
• owner_count integer nullable
• rto string nullable
• currency string (default: "INR")
• price number nullable
• price_with_taxes number nullable
• price_without_gst number nullable
• price_without_tax number nullable
• tax_percent number nullable
• base_price number nullable
• original_price number nullable
• original_price_without_tax number nullable
• original_base_price number nullable
• discount number nullable
• discount_name string nullable
• discount_ends_at integer nullable
• discount_starts_at integer nullable
• discount_sale_type string nullable
• discounted_price number nullable
• discounted_price_without_gst number nullable
• discounted_car_price number nullable
• discounted_tcs number nullable
• emi_monthly number nullable
• emi_monthly_before_offer number nullable
• loan_interest_rate number nullable
• loan_interest_rate_before_offer number nullable
• loan_amount number nullable
• loan_amount_min number nullable
• loan_amount_max number nullable
• loan_tenure_years number nullable
• loan_tenure_years_min number nullable
• loan_tenure_years_max number nullable
• loan_to_value_max_percent number nullable
• has_loan_offer boolean nullable
• loan_offer_savings number nullable
• token_amount number nullable
• token_amount_max number nullable
• exchange_bonus number nullable
• category string nullable
• procurement_category string nullable
• is_max_certified boolean nullable
• is_sold boolean nullable
• is_booked boolean nullable
• is_upcoming boolean nullable
• is_on_hold boolean nullable
• hold_ends_at integer nullable
• is_unpublished boolean nullable
• has_home_test_drive boolean nullable
• has_360_view boolean nullable
• shortlist_count integer nullable
• city string nullable
• hub_id string nullable
• hub_name string nullable
• image string nullable
• images array (default: [])
• highlights array (default: [])
  • @type string (default: "SpinnyHighlight")
  • detail string nullable
  • short_title string nullable
  • tag string nullable
  • strength string nullable
• price_breakdown array (default: [])
  • @type string (default: "SpinnyPriceItem")
  • name string required
  • label string nullable
  • amount number nullable
  • description string nullable
  • insurance object nullable
    • @type string (default: "SpinnyInsurance")
    • third_party_premium number nullable
    • third_party_insurer string nullable
    • personal_accident_cover number nullable
    • personal_accident_insurer string nullable
    • premium_total number nullable
    • gst number nullable
    • gst_percent number nullable
    • total number nullable
  • components array (default: [])
    • @type string (default: "SpinnyPriceComponent")
    • name string required
    • label string nullable
    • amount number nullable
    • description string nullable
    • insurance object nullable (see schema SpinnyInsurance)
• price_summary array (default: [])
  • @type string (default: "SpinnyPriceItem")
  • name string required
  • label string nullable
  • amount number nullable
  • description string nullable
  • insurance object nullable
    • @type string (default: "SpinnyInsurance")
    • third_party_premium number nullable
    • third_party_insurer string nullable
    • personal_accident_cover number nullable
    • personal_accident_insurer string nullable
    • premium_total number nullable
    • gst number nullable
    • gst_percent number nullable
    • total number nullable
  • components array (default: [])
    • @type string (default: "SpinnyPriceComponent")
    • name string required
    • label string nullable
    • amount number nullable
    • description string nullable
    • insurance object nullable (see schema SpinnyInsurance)
• price_summary_without_tax array (default: [])
  • @type string (default: "SpinnyPriceItem")
  • name string required
  • label string nullable
  • amount number nullable
  • description string nullable
  • insurance object nullable
    • @type string (default: "SpinnyInsurance")
    • third_party_premium number nullable
    • third_party_insurer string nullable
    • personal_accident_cover number nullable
    • personal_accident_insurer string nullable
    • premium_total number nullable
    • gst number nullable
    • gst_percent number nullable
    • total number nullable
  • components array (default: [])
    • @type string (default: "SpinnyPriceComponent")
    • name string required
    • label string nullable
    • amount number nullable
    • description string nullable
    • insurance object nullable (see schema SpinnyInsurance)
• is_fixed_price boolean nullable
• is_assured_plus boolean nullable
• status_tag string nullable
• seller_type string nullable
• is_waitlist_open boolean nullable
• waitlist_slots_free integer nullable
• waitlist_slots_max integer nullable
• waitlist_slots_held integer nullable
• has_showroom_visit boolean nullable
• published_at integer nullable
• hub_locality string nullable
• hub_type string 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 — Spinny has no city under that 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.