/openrouter/rankings/models

POST /api/openrouter/rankings/models

Price: 1 credit

Rank models by tokens routed through OpenRouter

How to use it

Real consumption, not popularity votes: rows arrive already ordered by tokens routed in the chosen window, so position in the list is the rank. Rows are keyed by dated version alias and billing variant, so one product name can hold several rows; join on `model_version_alias` against a model's `version_alias`, not against its `alias`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• view string required — Aggregation window of the ranking (one of: "day", "week", "month")
• count integer required — Max result count (min: 1)

Response

• @type string (default: "OpenrouterModelRanking")
• id string required
• model_version_alias string nullable
• variant string nullable
• date string nullable
• change number nullable
• request_count integer nullable
• prompt_token_count integer nullable
• completion_token_count integer nullable
• reasoning_token_count integer nullable
• cached_token_count integer nullable
• tool_call_count integer nullable
• tool_call_error_request_count integer nullable
• media_prompt_count integer nullable
• media_completion_count integer nullable
• audio_prompt_count integer nullable
• video_prompt_count integer nullable
• image_output_request_count integer nullable
• video_output_seconds number nullable
• rerank_document_count integer nullable
• transcript_character_count 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 — 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.