/dongchedi/rankings

POST /api/dongchedi/rankings

Price: 5 credits

Get Dongchedi car rankings: sales, popularity, rating, instrumented tests and city charts

How to use it

Get a Dongchedi car-series ranking for China: monthly retail or wholesale sales, popularity, Dongchedi rating, instrumented tests such as safety, moose, acceleration, braking and EV range, or local sales and price drops in one city. Narrow by brand, origin, vehicle type, size class and official guide price in CNY.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• rank_type string required — Which ranking to return (one of: "retail_sales", "wholesale_sales", "popularity", "rating", "safety_test", "energy_consumption_test", "moose_test", "acceleration_test", "braking_test", "track_lap_test", "ev_range_test", "ev_consumption_test", "city_sales", "city_price_drops")
• count integer required — Max number of ranked series (examples: 50; min: 1; max: 4100)
• city string nullable — Chinese city name for the city rankings and popularity (examples: "北京")
• month integer nullable — Sales month as unix seconds of any moment in it (examples: 1752364800)
• brand_id string nullable — Brand id, as brand_id in returned entries (examples: "16")
• origin string nullable — Manufacturer origin (one of: "joint_venture", "domestic", "imported")
• vehicle_types array nullable — Vehicle types (one of: "sedan", "suv", "mpv", "sports_car", "minivan", "light_bus", "pickup", "mini_truck", "light_truck")
• vehicle_classes array nullable — Size classes (one of: "micro_car", "small_car", "compact_car", "midsize_car", "large_midsize_car", "large_car", "small_suv", "compact_suv", "midsize_suv", "large_midsize_suv", "large_suv", "small_mpv", "compact_mpv", "midsize_mpv", "large_midsize_mpv", "large_mpv")
• price_min number nullable — Minimum official guide price in CNY (min: 0)
• price_max number nullable — Maximum official guide price in CNY (>: 0)

Response

• @type string (default: "DongchediRankEntry")
• rank integer required
• previous_rank integer nullable
• series_id string required
• series_name string nullable
• url string required
• image string nullable
• brand_id string nullable
• brand_name string nullable
• sub_brand_id string nullable
• sub_brand_name string nullable
• vehicle_class string nullable
• currency string (default: "CNY")
• dealer_price_min number nullable
• dealer_price_max number nullable
• value number nullable
• value_label string nullable
• price_drop number nullable
• price_drop_model_id string nullable
• price_drop_model_name string nullable
• test object nullable
  • @type string (default: "DongchediRankTest")
  • id string nullable
  • name string nullable
  • result string nullable
  • model_id string nullable
  • model_name string nullable
  • extra object nullable
    • @type string (default: "DongchediRankResult")
    • name string nullable
    • value string nullable
• review_count integer nullable
• image_count integer nullable
• model_ids array (default: [])
• discontinued_model_ids array (default: [])

Errors

• 422 — Unknown city name, or no sales ranking for the requested month. 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.