/carwale/models/reviews

POST /api/carwale/models/reviews

Price: 20 credits

List owner reviews of a CarWale car model, optionally by star rating, sorted by most helpful, latest or highest rated: title, text, tips, rating with per-aspect scores, version, author, city, votes, views and update time

How to use it

The numeric model id returned by carwale/models or carwale/models/search is accepted as well as the alias. most_helpful covers fewer reviews than latest.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• model string required — CarWale model id, make/model alias or model page URL (examples: "1729", "hyundai/creta", "https://www.carwale.com/hyundai-cars/creta/")
• rating integer nullable — Only reviews with this star rating (min: 1; max: 5)
• sort string — Result order (default: "latest"; one of: "most_helpful", "latest", "highest_rated")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "CarwaleReview")
• id string required
• model_id string nullable
• model_alias string nullable
• version_id string nullable
• version_name string nullable
• text string nullable
• tips string nullable
• rating number nullable
• author_name string nullable
• city string nullable
• is_winner boolean nullable
• upvote_count integer nullable
• downvote_count integer nullable
• view_count integer nullable
• mileage number nullable
• updated_at integer nullable
• posted_ago string nullable
• scores array (default: [])
  • @type string (default: "CarwaleRatingScore")
  • name string required
  • score number nullable
  • label string nullable
• images array (default: [])

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 — CarWale has no model under that id or 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.