mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-29 11:23:49 +08:00
speakeasybot
4e789208b4
* `open_router.beta.responses.send()`: * `request` **Changed** **Breaking** ⚠️ * `response` **Changed** **Breaking** ⚠️ * `open_router.presets.create_presets_responses()`: `request` **Changed** **Breaking** ⚠️ * `open_router.presets.create_presets_chat_completions()`: `request` **Changed** **Breaking** ⚠️ * `open_router.chat.send()`: `request` **Changed** **Breaking** ⚠️ * `open_router.workspaces.set_budget()`: **Added** * `open_router.o_auth.create_auth_code()`: * `request.workspace_id` **Added** * `error.status[403]` **Added** * `open_router.files.download()`: **Added** * `open_router.models.get()`: **Added** * `open_router.workspaces.list_budgets()`: **Added** * `open_router.workspaces.delete_budget()`: **Added** * `open_router.datasets.get_benchmarks_artificial_analysis()`: **Added** * `open_router.beta.analytics.query_analytics()`: `response.data.warnings` **Added** * `open_router.files.delete()`: **Added** * `open_router.files.retrieve()`: **Added** * `open_router.files.upload()`: **Added** * `open_router.embeddings.list_models()`: `response.data.[].benchmarks` **Added** * `open_router.models.list()`: * `request` **Changed** * `response.data.[].benchmarks` **Added** * `open_router.models.list_for_user()`: `response.data.[].benchmarks` **Added** * `open_router.files.list()`: **Added** * `open_router.presets.create_presets_messages()`: `request` **Changed** * `open_router.datasets.get_benchmarks_design_arena()`: **Added**
1268 lines
61 KiB
Python
1268 lines
61 KiB
Python
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
||
|
||
from .basesdk import BaseSDK
|
||
from jsonpath import JSONPath
|
||
from openrouter import components, errors, operations, utils
|
||
from openrouter._hooks import HookContext
|
||
from openrouter.types import OptionalNullable, UNSET
|
||
from openrouter.utils import get_security_from_env
|
||
from openrouter.utils.unmarshal_json_response import unmarshal_json_response
|
||
from typing import Any, Awaitable, Dict, List, Mapping, Optional, Union
|
||
|
||
|
||
class Datasets(BaseSDK):
|
||
r"""Datasets endpoints"""
|
||
|
||
def get_app_rankings(
|
||
self,
|
||
*,
|
||
http_referer: Optional[str] = None,
|
||
x_open_router_title: Optional[str] = None,
|
||
x_open_router_categories: Optional[str] = None,
|
||
category: Optional[operations.GetAppRankingsCategory] = None,
|
||
subcategory: Optional[operations.Subcategory] = None,
|
||
sort: Optional[operations.GetAppRankingsSort] = "popular",
|
||
start_date: Optional[str] = None,
|
||
end_date: Optional[str] = None,
|
||
limit: Optional[int] = 50,
|
||
offset: Optional[int] = 0,
|
||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||
server_url: Optional[str] = None,
|
||
timeout_ms: Optional[int] = None,
|
||
http_headers: Optional[Mapping[str, str]] = None,
|
||
) -> Optional[operations.GetAppRankingsResponse]:
|
||
r"""Top apps by token usage
|
||
|
||
Returns the top public apps on OpenRouter ranked by token usage inside the requested
|
||
date window, matching the public apps marketplace on openrouter.ai/apps. Token totals
|
||
are `prompt_tokens + completion_tokens`; hidden and private apps are excluded and
|
||
traffic from related app aliases is merged into the canonical visible app.
|
||
|
||
`sort=popular` (default) ranks by total token volume inside the window.
|
||
`sort=trending` ranks by absolute excess token growth: window volume minus the average
|
||
volume of the three equal-length periods immediately preceding the window. Apps with
|
||
no excess growth are omitted, so `trending` may return fewer than `limit` rows.
|
||
|
||
Filter with `category` (marketplace category group, e.g. `coding`) or `subcategory`
|
||
(e.g. `cli-agent`). Ranks are re-numbered 1..N after filtering. Page with `offset` —
|
||
`rank` stays absolute, so the first row of `offset=50` is `rank: 51`.
|
||
|
||
Authenticate with any valid OpenRouter API key (same key used for inference).
|
||
Rate-limited to 30 requests/minute per key and 500 requests/day per account.
|
||
|
||
When republishing or quoting this dataset, OpenRouter must be cited as:
|
||
\"Source: OpenRouter (openrouter.ai/apps), as of {as_of}.\"
|
||
|
||
Token counts come from each upstream provider's own tokenizer, so a token attributed
|
||
to one app is not directly comparable to a token attributed to another app whose
|
||
traffic flows through a different provider.
|
||
|
||
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||
This is used to track API usage per application.
|
||
|
||
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||
|
||
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
||
|
||
:param category: Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group.
|
||
:param subcategory: Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent.
|
||
:param sort: `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results.
|
||
:param start_date: Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`.
|
||
:param end_date: End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400.
|
||
:param limit: Maximum number of apps to return (1-100). Defaults to 50.
|
||
:param offset: Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`.
|
||
:param retries: Override the default retry configuration for this method
|
||
:param server_url: Override the default server URL for this method
|
||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||
:param http_headers: Additional headers to set or replace on requests.
|
||
"""
|
||
base_url = None
|
||
url_variables = None
|
||
if timeout_ms is None:
|
||
timeout_ms = self.sdk_configuration.timeout_ms
|
||
|
||
if server_url is not None:
|
||
base_url = server_url
|
||
else:
|
||
base_url = self._get_url(base_url, url_variables)
|
||
|
||
request = operations.GetAppRankingsRequest(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
category=category,
|
||
subcategory=subcategory,
|
||
sort=sort,
|
||
start_date=start_date,
|
||
end_date=end_date,
|
||
limit=limit,
|
||
offset=offset,
|
||
)
|
||
|
||
req = self._build_request(
|
||
method="GET",
|
||
path="/datasets/app-rankings",
|
||
base_url=base_url,
|
||
url_variables=url_variables,
|
||
request=request,
|
||
request_body_required=False,
|
||
request_has_path_params=False,
|
||
request_has_query_params=True,
|
||
user_agent_header="user-agent",
|
||
accept_header_value="application/json",
|
||
http_headers=http_headers,
|
||
_globals=operations.GetAppRankingsGlobals(
|
||
http_referer=self.sdk_configuration.globals.http_referer,
|
||
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
||
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
||
),
|
||
security=self.sdk_configuration.security,
|
||
allow_empty_value=None,
|
||
timeout_ms=timeout_ms,
|
||
)
|
||
|
||
if retries == UNSET:
|
||
if self.sdk_configuration.retry_config is not UNSET:
|
||
retries = self.sdk_configuration.retry_config
|
||
else:
|
||
retries = utils.RetryConfig(
|
||
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
||
)
|
||
|
||
retry_config = None
|
||
if isinstance(retries, utils.RetryConfig):
|
||
retry_config = (retries, ["5XX"])
|
||
|
||
http_res = self.do_request(
|
||
hook_ctx=HookContext(
|
||
config=self.sdk_configuration,
|
||
base_url=base_url or "",
|
||
operation_id="getAppRankings",
|
||
oauth2_scopes=None,
|
||
security_source=get_security_from_env(
|
||
self.sdk_configuration.security, components.Security
|
||
),
|
||
),
|
||
request=req,
|
||
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
||
retry_config=retry_config,
|
||
)
|
||
|
||
def next_func() -> Optional[operations.GetAppRankingsResponse]:
|
||
body = utils.unmarshal_json(http_res.text, Union[Dict[Any, Any], List[Any]])
|
||
|
||
offset = request.offset if not request.offset is None else 0
|
||
|
||
if not http_res.text:
|
||
return None
|
||
results = JSONPath("$.data").parse(body)
|
||
if len(results) == 0 or len(results[0]) == 0:
|
||
return None
|
||
limit = request.limit if not request.limit is None else 50
|
||
if len(results[0]) < limit:
|
||
return None
|
||
next_offset = offset + len(results[0])
|
||
|
||
return self.get_app_rankings(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
category=category,
|
||
subcategory=subcategory,
|
||
sort=sort,
|
||
start_date=start_date,
|
||
end_date=end_date,
|
||
limit=limit,
|
||
offset=next_offset,
|
||
retries=retries,
|
||
)
|
||
|
||
response_data: Any = None
|
||
if utils.match_response(http_res, "200", "application/json"):
|
||
return operations.GetAppRankingsResponse(
|
||
result=unmarshal_json_response(
|
||
components.AppRankingsResponse, http_res
|
||
),
|
||
next=next_func,
|
||
)
|
||
if utils.match_response(http_res, "400", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.BadRequestResponseErrorData, http_res
|
||
)
|
||
raise errors.BadRequestResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "401", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.UnauthorizedResponseErrorData, http_res
|
||
)
|
||
raise errors.UnauthorizedResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "429", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.TooManyRequestsResponseErrorData, http_res
|
||
)
|
||
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "500", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.InternalServerResponseErrorData, http_res
|
||
)
|
||
raise errors.InternalServerResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "4XX", "*"):
|
||
http_res_text = utils.stream_to_text(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
if utils.match_response(http_res, "5XX", "*"):
|
||
http_res_text = utils.stream_to_text(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
|
||
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
||
|
||
async def get_app_rankings_async(
|
||
self,
|
||
*,
|
||
http_referer: Optional[str] = None,
|
||
x_open_router_title: Optional[str] = None,
|
||
x_open_router_categories: Optional[str] = None,
|
||
category: Optional[operations.GetAppRankingsCategory] = None,
|
||
subcategory: Optional[operations.Subcategory] = None,
|
||
sort: Optional[operations.GetAppRankingsSort] = "popular",
|
||
start_date: Optional[str] = None,
|
||
end_date: Optional[str] = None,
|
||
limit: Optional[int] = 50,
|
||
offset: Optional[int] = 0,
|
||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||
server_url: Optional[str] = None,
|
||
timeout_ms: Optional[int] = None,
|
||
http_headers: Optional[Mapping[str, str]] = None,
|
||
) -> Optional[operations.GetAppRankingsResponse]:
|
||
r"""Top apps by token usage
|
||
|
||
Returns the top public apps on OpenRouter ranked by token usage inside the requested
|
||
date window, matching the public apps marketplace on openrouter.ai/apps. Token totals
|
||
are `prompt_tokens + completion_tokens`; hidden and private apps are excluded and
|
||
traffic from related app aliases is merged into the canonical visible app.
|
||
|
||
`sort=popular` (default) ranks by total token volume inside the window.
|
||
`sort=trending` ranks by absolute excess token growth: window volume minus the average
|
||
volume of the three equal-length periods immediately preceding the window. Apps with
|
||
no excess growth are omitted, so `trending` may return fewer than `limit` rows.
|
||
|
||
Filter with `category` (marketplace category group, e.g. `coding`) or `subcategory`
|
||
(e.g. `cli-agent`). Ranks are re-numbered 1..N after filtering. Page with `offset` —
|
||
`rank` stays absolute, so the first row of `offset=50` is `rank: 51`.
|
||
|
||
Authenticate with any valid OpenRouter API key (same key used for inference).
|
||
Rate-limited to 30 requests/minute per key and 500 requests/day per account.
|
||
|
||
When republishing or quoting this dataset, OpenRouter must be cited as:
|
||
\"Source: OpenRouter (openrouter.ai/apps), as of {as_of}.\"
|
||
|
||
Token counts come from each upstream provider's own tokenizer, so a token attributed
|
||
to one app is not directly comparable to a token attributed to another app whose
|
||
traffic flows through a different provider.
|
||
|
||
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||
This is used to track API usage per application.
|
||
|
||
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||
|
||
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
||
|
||
:param category: Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group.
|
||
:param subcategory: Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent.
|
||
:param sort: `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results.
|
||
:param start_date: Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`.
|
||
:param end_date: End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400.
|
||
:param limit: Maximum number of apps to return (1-100). Defaults to 50.
|
||
:param offset: Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`.
|
||
:param retries: Override the default retry configuration for this method
|
||
:param server_url: Override the default server URL for this method
|
||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||
:param http_headers: Additional headers to set or replace on requests.
|
||
"""
|
||
base_url = None
|
||
url_variables = None
|
||
if timeout_ms is None:
|
||
timeout_ms = self.sdk_configuration.timeout_ms
|
||
|
||
if server_url is not None:
|
||
base_url = server_url
|
||
else:
|
||
base_url = self._get_url(base_url, url_variables)
|
||
|
||
request = operations.GetAppRankingsRequest(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
category=category,
|
||
subcategory=subcategory,
|
||
sort=sort,
|
||
start_date=start_date,
|
||
end_date=end_date,
|
||
limit=limit,
|
||
offset=offset,
|
||
)
|
||
|
||
req = self._build_request_async(
|
||
method="GET",
|
||
path="/datasets/app-rankings",
|
||
base_url=base_url,
|
||
url_variables=url_variables,
|
||
request=request,
|
||
request_body_required=False,
|
||
request_has_path_params=False,
|
||
request_has_query_params=True,
|
||
user_agent_header="user-agent",
|
||
accept_header_value="application/json",
|
||
http_headers=http_headers,
|
||
_globals=operations.GetAppRankingsGlobals(
|
||
http_referer=self.sdk_configuration.globals.http_referer,
|
||
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
||
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
||
),
|
||
security=self.sdk_configuration.security,
|
||
allow_empty_value=None,
|
||
timeout_ms=timeout_ms,
|
||
)
|
||
|
||
if retries == UNSET:
|
||
if self.sdk_configuration.retry_config is not UNSET:
|
||
retries = self.sdk_configuration.retry_config
|
||
else:
|
||
retries = utils.RetryConfig(
|
||
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
||
)
|
||
|
||
retry_config = None
|
||
if isinstance(retries, utils.RetryConfig):
|
||
retry_config = (retries, ["5XX"])
|
||
|
||
http_res = await self.do_request_async(
|
||
hook_ctx=HookContext(
|
||
config=self.sdk_configuration,
|
||
base_url=base_url or "",
|
||
operation_id="getAppRankings",
|
||
oauth2_scopes=None,
|
||
security_source=get_security_from_env(
|
||
self.sdk_configuration.security, components.Security
|
||
),
|
||
),
|
||
request=req,
|
||
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
||
retry_config=retry_config,
|
||
)
|
||
|
||
def next_func() -> Awaitable[Optional[operations.GetAppRankingsResponse]]:
|
||
body = utils.unmarshal_json(http_res.text, Union[Dict[Any, Any], List[Any]])
|
||
|
||
async def empty_result():
|
||
return None
|
||
|
||
offset = request.offset if not request.offset is None else 0
|
||
|
||
if not http_res.text:
|
||
return empty_result()
|
||
results = JSONPath("$.data").parse(body)
|
||
if len(results) == 0 or len(results[0]) == 0:
|
||
return empty_result()
|
||
limit = request.limit if not request.limit is None else 50
|
||
if len(results[0]) < limit:
|
||
return empty_result()
|
||
next_offset = offset + len(results[0])
|
||
|
||
return self.get_app_rankings_async(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
category=category,
|
||
subcategory=subcategory,
|
||
sort=sort,
|
||
start_date=start_date,
|
||
end_date=end_date,
|
||
limit=limit,
|
||
offset=next_offset,
|
||
retries=retries,
|
||
)
|
||
|
||
response_data: Any = None
|
||
if utils.match_response(http_res, "200", "application/json"):
|
||
return operations.GetAppRankingsResponse(
|
||
result=unmarshal_json_response(
|
||
components.AppRankingsResponse, http_res
|
||
),
|
||
next=next_func,
|
||
)
|
||
if utils.match_response(http_res, "400", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.BadRequestResponseErrorData, http_res
|
||
)
|
||
raise errors.BadRequestResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "401", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.UnauthorizedResponseErrorData, http_res
|
||
)
|
||
raise errors.UnauthorizedResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "429", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.TooManyRequestsResponseErrorData, http_res
|
||
)
|
||
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "500", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.InternalServerResponseErrorData, http_res
|
||
)
|
||
raise errors.InternalServerResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "4XX", "*"):
|
||
http_res_text = await utils.stream_to_text_async(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
if utils.match_response(http_res, "5XX", "*"):
|
||
http_res_text = await utils.stream_to_text_async(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
|
||
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
||
|
||
def get_benchmarks_artificial_analysis(
|
||
self,
|
||
*,
|
||
http_referer: Optional[str] = None,
|
||
x_open_router_title: Optional[str] = None,
|
||
x_open_router_categories: Optional[str] = None,
|
||
max_results: Optional[int] = 50,
|
||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||
server_url: Optional[str] = None,
|
||
timeout_ms: Optional[int] = None,
|
||
http_headers: Optional[Mapping[str, str]] = None,
|
||
) -> components.BenchmarksAAResponse:
|
||
r"""Artificial Analysis Benchmark Indices
|
||
|
||
Returns composite index scores (Intelligence, Coding, Agentic) from Artificial Analysis for LLM models. Includes OpenRouter pricing per model. Authenticate with any valid OpenRouter API key. Rate-limited to 30 requests/minute per key and 500 requests/day per account.
|
||
|
||
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||
This is used to track API usage per application.
|
||
|
||
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||
|
||
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
||
|
||
:param max_results: Max results to return (1–100, default 50).
|
||
:param retries: Override the default retry configuration for this method
|
||
:param server_url: Override the default server URL for this method
|
||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||
:param http_headers: Additional headers to set or replace on requests.
|
||
"""
|
||
base_url = None
|
||
url_variables = None
|
||
if timeout_ms is None:
|
||
timeout_ms = self.sdk_configuration.timeout_ms
|
||
|
||
if server_url is not None:
|
||
base_url = server_url
|
||
else:
|
||
base_url = self._get_url(base_url, url_variables)
|
||
|
||
request = operations.GetBenchmarksArtificialAnalysisRequest(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
max_results=max_results,
|
||
)
|
||
|
||
req = self._build_request(
|
||
method="GET",
|
||
path="/datasets/benchmarks/artificial-analysis",
|
||
base_url=base_url,
|
||
url_variables=url_variables,
|
||
request=request,
|
||
request_body_required=False,
|
||
request_has_path_params=False,
|
||
request_has_query_params=True,
|
||
user_agent_header="user-agent",
|
||
accept_header_value="application/json",
|
||
http_headers=http_headers,
|
||
_globals=operations.GetBenchmarksArtificialAnalysisGlobals(
|
||
http_referer=self.sdk_configuration.globals.http_referer,
|
||
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
||
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
||
),
|
||
security=self.sdk_configuration.security,
|
||
allow_empty_value=None,
|
||
timeout_ms=timeout_ms,
|
||
)
|
||
|
||
if retries == UNSET:
|
||
if self.sdk_configuration.retry_config is not UNSET:
|
||
retries = self.sdk_configuration.retry_config
|
||
else:
|
||
retries = utils.RetryConfig(
|
||
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
||
)
|
||
|
||
retry_config = None
|
||
if isinstance(retries, utils.RetryConfig):
|
||
retry_config = (retries, ["5XX"])
|
||
|
||
http_res = self.do_request(
|
||
hook_ctx=HookContext(
|
||
config=self.sdk_configuration,
|
||
base_url=base_url or "",
|
||
operation_id="getBenchmarksArtificialAnalysis",
|
||
oauth2_scopes=None,
|
||
security_source=get_security_from_env(
|
||
self.sdk_configuration.security, components.Security
|
||
),
|
||
),
|
||
request=req,
|
||
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
||
retry_config=retry_config,
|
||
)
|
||
|
||
response_data: Any = None
|
||
if utils.match_response(http_res, "200", "application/json"):
|
||
return unmarshal_json_response(components.BenchmarksAAResponse, http_res)
|
||
if utils.match_response(http_res, "400", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.BadRequestResponseErrorData, http_res
|
||
)
|
||
raise errors.BadRequestResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "401", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.UnauthorizedResponseErrorData, http_res
|
||
)
|
||
raise errors.UnauthorizedResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "429", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.TooManyRequestsResponseErrorData, http_res
|
||
)
|
||
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "500", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.InternalServerResponseErrorData, http_res
|
||
)
|
||
raise errors.InternalServerResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "4XX", "*"):
|
||
http_res_text = utils.stream_to_text(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
if utils.match_response(http_res, "5XX", "*"):
|
||
http_res_text = utils.stream_to_text(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
|
||
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
||
|
||
async def get_benchmarks_artificial_analysis_async(
|
||
self,
|
||
*,
|
||
http_referer: Optional[str] = None,
|
||
x_open_router_title: Optional[str] = None,
|
||
x_open_router_categories: Optional[str] = None,
|
||
max_results: Optional[int] = 50,
|
||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||
server_url: Optional[str] = None,
|
||
timeout_ms: Optional[int] = None,
|
||
http_headers: Optional[Mapping[str, str]] = None,
|
||
) -> components.BenchmarksAAResponse:
|
||
r"""Artificial Analysis Benchmark Indices
|
||
|
||
Returns composite index scores (Intelligence, Coding, Agentic) from Artificial Analysis for LLM models. Includes OpenRouter pricing per model. Authenticate with any valid OpenRouter API key. Rate-limited to 30 requests/minute per key and 500 requests/day per account.
|
||
|
||
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||
This is used to track API usage per application.
|
||
|
||
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||
|
||
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
||
|
||
:param max_results: Max results to return (1–100, default 50).
|
||
:param retries: Override the default retry configuration for this method
|
||
:param server_url: Override the default server URL for this method
|
||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||
:param http_headers: Additional headers to set or replace on requests.
|
||
"""
|
||
base_url = None
|
||
url_variables = None
|
||
if timeout_ms is None:
|
||
timeout_ms = self.sdk_configuration.timeout_ms
|
||
|
||
if server_url is not None:
|
||
base_url = server_url
|
||
else:
|
||
base_url = self._get_url(base_url, url_variables)
|
||
|
||
request = operations.GetBenchmarksArtificialAnalysisRequest(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
max_results=max_results,
|
||
)
|
||
|
||
req = self._build_request_async(
|
||
method="GET",
|
||
path="/datasets/benchmarks/artificial-analysis",
|
||
base_url=base_url,
|
||
url_variables=url_variables,
|
||
request=request,
|
||
request_body_required=False,
|
||
request_has_path_params=False,
|
||
request_has_query_params=True,
|
||
user_agent_header="user-agent",
|
||
accept_header_value="application/json",
|
||
http_headers=http_headers,
|
||
_globals=operations.GetBenchmarksArtificialAnalysisGlobals(
|
||
http_referer=self.sdk_configuration.globals.http_referer,
|
||
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
||
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
||
),
|
||
security=self.sdk_configuration.security,
|
||
allow_empty_value=None,
|
||
timeout_ms=timeout_ms,
|
||
)
|
||
|
||
if retries == UNSET:
|
||
if self.sdk_configuration.retry_config is not UNSET:
|
||
retries = self.sdk_configuration.retry_config
|
||
else:
|
||
retries = utils.RetryConfig(
|
||
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
||
)
|
||
|
||
retry_config = None
|
||
if isinstance(retries, utils.RetryConfig):
|
||
retry_config = (retries, ["5XX"])
|
||
|
||
http_res = await self.do_request_async(
|
||
hook_ctx=HookContext(
|
||
config=self.sdk_configuration,
|
||
base_url=base_url or "",
|
||
operation_id="getBenchmarksArtificialAnalysis",
|
||
oauth2_scopes=None,
|
||
security_source=get_security_from_env(
|
||
self.sdk_configuration.security, components.Security
|
||
),
|
||
),
|
||
request=req,
|
||
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
||
retry_config=retry_config,
|
||
)
|
||
|
||
response_data: Any = None
|
||
if utils.match_response(http_res, "200", "application/json"):
|
||
return unmarshal_json_response(components.BenchmarksAAResponse, http_res)
|
||
if utils.match_response(http_res, "400", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.BadRequestResponseErrorData, http_res
|
||
)
|
||
raise errors.BadRequestResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "401", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.UnauthorizedResponseErrorData, http_res
|
||
)
|
||
raise errors.UnauthorizedResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "429", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.TooManyRequestsResponseErrorData, http_res
|
||
)
|
||
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "500", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.InternalServerResponseErrorData, http_res
|
||
)
|
||
raise errors.InternalServerResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "4XX", "*"):
|
||
http_res_text = await utils.stream_to_text_async(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
if utils.match_response(http_res, "5XX", "*"):
|
||
http_res_text = await utils.stream_to_text_async(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
|
||
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
||
|
||
def get_benchmarks_design_arena(
|
||
self,
|
||
*,
|
||
http_referer: Optional[str] = None,
|
||
x_open_router_title: Optional[str] = None,
|
||
x_open_router_categories: Optional[str] = None,
|
||
arena: Optional[operations.Arena] = "models",
|
||
category: Optional[str] = None,
|
||
max_results: Optional[int] = 50,
|
||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||
server_url: Optional[str] = None,
|
||
timeout_ms: Optional[int] = None,
|
||
http_headers: Optional[Mapping[str, str]] = None,
|
||
) -> components.BenchmarksDAResponse:
|
||
r"""Design Arena Benchmark Rankings
|
||
|
||
Returns ELO ratings from head-to-head arena battles on Design Arena. Filterable by arena (models/builders/agents) and category. Includes OpenRouter pricing per model. Authenticate with any valid OpenRouter API key. Rate-limited to 30 requests/minute per key and 500 requests/day per account.
|
||
|
||
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||
This is used to track API usage per application.
|
||
|
||
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||
|
||
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
||
|
||
:param arena: Arena to query. Defaults to `models`.
|
||
:param category: Category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories.
|
||
:param max_results: Max results to return: per category when no category filter is applied (1–100, default 50).
|
||
:param retries: Override the default retry configuration for this method
|
||
:param server_url: Override the default server URL for this method
|
||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||
:param http_headers: Additional headers to set or replace on requests.
|
||
"""
|
||
base_url = None
|
||
url_variables = None
|
||
if timeout_ms is None:
|
||
timeout_ms = self.sdk_configuration.timeout_ms
|
||
|
||
if server_url is not None:
|
||
base_url = server_url
|
||
else:
|
||
base_url = self._get_url(base_url, url_variables)
|
||
|
||
request = operations.GetBenchmarksDesignArenaRequest(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
arena=arena,
|
||
category=category,
|
||
max_results=max_results,
|
||
)
|
||
|
||
req = self._build_request(
|
||
method="GET",
|
||
path="/datasets/benchmarks/design-arena",
|
||
base_url=base_url,
|
||
url_variables=url_variables,
|
||
request=request,
|
||
request_body_required=False,
|
||
request_has_path_params=False,
|
||
request_has_query_params=True,
|
||
user_agent_header="user-agent",
|
||
accept_header_value="application/json",
|
||
http_headers=http_headers,
|
||
_globals=operations.GetBenchmarksDesignArenaGlobals(
|
||
http_referer=self.sdk_configuration.globals.http_referer,
|
||
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
||
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
||
),
|
||
security=self.sdk_configuration.security,
|
||
allow_empty_value=None,
|
||
timeout_ms=timeout_ms,
|
||
)
|
||
|
||
if retries == UNSET:
|
||
if self.sdk_configuration.retry_config is not UNSET:
|
||
retries = self.sdk_configuration.retry_config
|
||
else:
|
||
retries = utils.RetryConfig(
|
||
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
||
)
|
||
|
||
retry_config = None
|
||
if isinstance(retries, utils.RetryConfig):
|
||
retry_config = (retries, ["5XX"])
|
||
|
||
http_res = self.do_request(
|
||
hook_ctx=HookContext(
|
||
config=self.sdk_configuration,
|
||
base_url=base_url or "",
|
||
operation_id="getBenchmarksDesignArena",
|
||
oauth2_scopes=None,
|
||
security_source=get_security_from_env(
|
||
self.sdk_configuration.security, components.Security
|
||
),
|
||
),
|
||
request=req,
|
||
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
||
retry_config=retry_config,
|
||
)
|
||
|
||
response_data: Any = None
|
||
if utils.match_response(http_res, "200", "application/json"):
|
||
return unmarshal_json_response(components.BenchmarksDAResponse, http_res)
|
||
if utils.match_response(http_res, "400", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.BadRequestResponseErrorData, http_res
|
||
)
|
||
raise errors.BadRequestResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "401", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.UnauthorizedResponseErrorData, http_res
|
||
)
|
||
raise errors.UnauthorizedResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "429", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.TooManyRequestsResponseErrorData, http_res
|
||
)
|
||
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "500", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.InternalServerResponseErrorData, http_res
|
||
)
|
||
raise errors.InternalServerResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "4XX", "*"):
|
||
http_res_text = utils.stream_to_text(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
if utils.match_response(http_res, "5XX", "*"):
|
||
http_res_text = utils.stream_to_text(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
|
||
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
||
|
||
async def get_benchmarks_design_arena_async(
|
||
self,
|
||
*,
|
||
http_referer: Optional[str] = None,
|
||
x_open_router_title: Optional[str] = None,
|
||
x_open_router_categories: Optional[str] = None,
|
||
arena: Optional[operations.Arena] = "models",
|
||
category: Optional[str] = None,
|
||
max_results: Optional[int] = 50,
|
||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||
server_url: Optional[str] = None,
|
||
timeout_ms: Optional[int] = None,
|
||
http_headers: Optional[Mapping[str, str]] = None,
|
||
) -> components.BenchmarksDAResponse:
|
||
r"""Design Arena Benchmark Rankings
|
||
|
||
Returns ELO ratings from head-to-head arena battles on Design Arena. Filterable by arena (models/builders/agents) and category. Includes OpenRouter pricing per model. Authenticate with any valid OpenRouter API key. Rate-limited to 30 requests/minute per key and 500 requests/day per account.
|
||
|
||
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||
This is used to track API usage per application.
|
||
|
||
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||
|
||
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
||
|
||
:param arena: Arena to query. Defaults to `models`.
|
||
:param category: Category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories.
|
||
:param max_results: Max results to return: per category when no category filter is applied (1–100, default 50).
|
||
:param retries: Override the default retry configuration for this method
|
||
:param server_url: Override the default server URL for this method
|
||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||
:param http_headers: Additional headers to set or replace on requests.
|
||
"""
|
||
base_url = None
|
||
url_variables = None
|
||
if timeout_ms is None:
|
||
timeout_ms = self.sdk_configuration.timeout_ms
|
||
|
||
if server_url is not None:
|
||
base_url = server_url
|
||
else:
|
||
base_url = self._get_url(base_url, url_variables)
|
||
|
||
request = operations.GetBenchmarksDesignArenaRequest(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
arena=arena,
|
||
category=category,
|
||
max_results=max_results,
|
||
)
|
||
|
||
req = self._build_request_async(
|
||
method="GET",
|
||
path="/datasets/benchmarks/design-arena",
|
||
base_url=base_url,
|
||
url_variables=url_variables,
|
||
request=request,
|
||
request_body_required=False,
|
||
request_has_path_params=False,
|
||
request_has_query_params=True,
|
||
user_agent_header="user-agent",
|
||
accept_header_value="application/json",
|
||
http_headers=http_headers,
|
||
_globals=operations.GetBenchmarksDesignArenaGlobals(
|
||
http_referer=self.sdk_configuration.globals.http_referer,
|
||
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
||
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
||
),
|
||
security=self.sdk_configuration.security,
|
||
allow_empty_value=None,
|
||
timeout_ms=timeout_ms,
|
||
)
|
||
|
||
if retries == UNSET:
|
||
if self.sdk_configuration.retry_config is not UNSET:
|
||
retries = self.sdk_configuration.retry_config
|
||
else:
|
||
retries = utils.RetryConfig(
|
||
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
||
)
|
||
|
||
retry_config = None
|
||
if isinstance(retries, utils.RetryConfig):
|
||
retry_config = (retries, ["5XX"])
|
||
|
||
http_res = await self.do_request_async(
|
||
hook_ctx=HookContext(
|
||
config=self.sdk_configuration,
|
||
base_url=base_url or "",
|
||
operation_id="getBenchmarksDesignArena",
|
||
oauth2_scopes=None,
|
||
security_source=get_security_from_env(
|
||
self.sdk_configuration.security, components.Security
|
||
),
|
||
),
|
||
request=req,
|
||
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
||
retry_config=retry_config,
|
||
)
|
||
|
||
response_data: Any = None
|
||
if utils.match_response(http_res, "200", "application/json"):
|
||
return unmarshal_json_response(components.BenchmarksDAResponse, http_res)
|
||
if utils.match_response(http_res, "400", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.BadRequestResponseErrorData, http_res
|
||
)
|
||
raise errors.BadRequestResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "401", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.UnauthorizedResponseErrorData, http_res
|
||
)
|
||
raise errors.UnauthorizedResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "429", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.TooManyRequestsResponseErrorData, http_res
|
||
)
|
||
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "500", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.InternalServerResponseErrorData, http_res
|
||
)
|
||
raise errors.InternalServerResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "4XX", "*"):
|
||
http_res_text = await utils.stream_to_text_async(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
if utils.match_response(http_res, "5XX", "*"):
|
||
http_res_text = await utils.stream_to_text_async(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
|
||
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
||
|
||
def get_rankings_daily(
|
||
self,
|
||
*,
|
||
http_referer: Optional[str] = None,
|
||
x_open_router_title: Optional[str] = None,
|
||
x_open_router_categories: Optional[str] = None,
|
||
start_date: Optional[str] = None,
|
||
end_date: Optional[str] = None,
|
||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||
server_url: Optional[str] = None,
|
||
timeout_ms: Optional[int] = None,
|
||
http_headers: Optional[Mapping[str, str]] = None,
|
||
) -> components.RankingsDailyResponse:
|
||
r"""Daily token totals for top 50 models
|
||
|
||
Returns the top 50 public models per day by total token usage on OpenRouter, plus a
|
||
single aggregated `other` row per day that sums every model outside that top 50.
|
||
Token totals are `prompt_tokens + completion_tokens`, matching the public rankings
|
||
chart on openrouter.ai/rankings.
|
||
|
||
Each row is a distinct `(date, model_permaslug)` pair. The `other` row uses the
|
||
reserved permaslug `other` and is always returned last within its date, so callers
|
||
can compute `top-50 traffic / total daily traffic` without a second request.
|
||
|
||
Authenticate with any valid OpenRouter API key (same key used for inference).
|
||
Rate-limited to 30 requests/minute per key and 500 requests/day per account.
|
||
|
||
When republishing or quoting this dataset, OpenRouter must be cited as:
|
||
\"Source: OpenRouter (openrouter.ai/rankings), as of {as_of}.\"
|
||
|
||
Token counts come from each upstream provider's own tokenizer (Anthropic counts
|
||
are as reported by Anthropic, OpenAI counts are as reported by OpenAI, etc.), so
|
||
a token in one row is not directly comparable to a token in another row from a
|
||
different provider.
|
||
|
||
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||
This is used to track API usage per application.
|
||
|
||
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||
|
||
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
||
|
||
:param start_date: Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`.
|
||
:param end_date: End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400.
|
||
:param retries: Override the default retry configuration for this method
|
||
:param server_url: Override the default server URL for this method
|
||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||
:param http_headers: Additional headers to set or replace on requests.
|
||
"""
|
||
base_url = None
|
||
url_variables = None
|
||
if timeout_ms is None:
|
||
timeout_ms = self.sdk_configuration.timeout_ms
|
||
|
||
if server_url is not None:
|
||
base_url = server_url
|
||
else:
|
||
base_url = self._get_url(base_url, url_variables)
|
||
|
||
request = operations.GetRankingsDailyRequest(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
start_date=start_date,
|
||
end_date=end_date,
|
||
)
|
||
|
||
req = self._build_request(
|
||
method="GET",
|
||
path="/datasets/rankings-daily",
|
||
base_url=base_url,
|
||
url_variables=url_variables,
|
||
request=request,
|
||
request_body_required=False,
|
||
request_has_path_params=False,
|
||
request_has_query_params=True,
|
||
user_agent_header="user-agent",
|
||
accept_header_value="application/json",
|
||
http_headers=http_headers,
|
||
_globals=operations.GetRankingsDailyGlobals(
|
||
http_referer=self.sdk_configuration.globals.http_referer,
|
||
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
||
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
||
),
|
||
security=self.sdk_configuration.security,
|
||
allow_empty_value=None,
|
||
timeout_ms=timeout_ms,
|
||
)
|
||
|
||
if retries == UNSET:
|
||
if self.sdk_configuration.retry_config is not UNSET:
|
||
retries = self.sdk_configuration.retry_config
|
||
else:
|
||
retries = utils.RetryConfig(
|
||
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
||
)
|
||
|
||
retry_config = None
|
||
if isinstance(retries, utils.RetryConfig):
|
||
retry_config = (retries, ["5XX"])
|
||
|
||
http_res = self.do_request(
|
||
hook_ctx=HookContext(
|
||
config=self.sdk_configuration,
|
||
base_url=base_url or "",
|
||
operation_id="getRankingsDaily",
|
||
oauth2_scopes=None,
|
||
security_source=get_security_from_env(
|
||
self.sdk_configuration.security, components.Security
|
||
),
|
||
),
|
||
request=req,
|
||
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
||
retry_config=retry_config,
|
||
)
|
||
|
||
response_data: Any = None
|
||
if utils.match_response(http_res, "200", "application/json"):
|
||
return unmarshal_json_response(components.RankingsDailyResponse, http_res)
|
||
if utils.match_response(http_res, "400", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.BadRequestResponseErrorData, http_res
|
||
)
|
||
raise errors.BadRequestResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "401", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.UnauthorizedResponseErrorData, http_res
|
||
)
|
||
raise errors.UnauthorizedResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "429", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.TooManyRequestsResponseErrorData, http_res
|
||
)
|
||
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "500", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.InternalServerResponseErrorData, http_res
|
||
)
|
||
raise errors.InternalServerResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "4XX", "*"):
|
||
http_res_text = utils.stream_to_text(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
if utils.match_response(http_res, "5XX", "*"):
|
||
http_res_text = utils.stream_to_text(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
|
||
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|
||
|
||
async def get_rankings_daily_async(
|
||
self,
|
||
*,
|
||
http_referer: Optional[str] = None,
|
||
x_open_router_title: Optional[str] = None,
|
||
x_open_router_categories: Optional[str] = None,
|
||
start_date: Optional[str] = None,
|
||
end_date: Optional[str] = None,
|
||
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
||
server_url: Optional[str] = None,
|
||
timeout_ms: Optional[int] = None,
|
||
http_headers: Optional[Mapping[str, str]] = None,
|
||
) -> components.RankingsDailyResponse:
|
||
r"""Daily token totals for top 50 models
|
||
|
||
Returns the top 50 public models per day by total token usage on OpenRouter, plus a
|
||
single aggregated `other` row per day that sums every model outside that top 50.
|
||
Token totals are `prompt_tokens + completion_tokens`, matching the public rankings
|
||
chart on openrouter.ai/rankings.
|
||
|
||
Each row is a distinct `(date, model_permaslug)` pair. The `other` row uses the
|
||
reserved permaslug `other` and is always returned last within its date, so callers
|
||
can compute `top-50 traffic / total daily traffic` without a second request.
|
||
|
||
Authenticate with any valid OpenRouter API key (same key used for inference).
|
||
Rate-limited to 30 requests/minute per key and 500 requests/day per account.
|
||
|
||
When republishing or quoting this dataset, OpenRouter must be cited as:
|
||
\"Source: OpenRouter (openrouter.ai/rankings), as of {as_of}.\"
|
||
|
||
Token counts come from each upstream provider's own tokenizer (Anthropic counts
|
||
are as reported by Anthropic, OpenAI counts are as reported by OpenAI, etc.), so
|
||
a token in one row is not directly comparable to a token in another row from a
|
||
different provider.
|
||
|
||
:param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||
This is used to track API usage per application.
|
||
|
||
:param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||
|
||
:param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.
|
||
|
||
:param start_date: Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`.
|
||
:param end_date: End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400.
|
||
:param retries: Override the default retry configuration for this method
|
||
:param server_url: Override the default server URL for this method
|
||
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds
|
||
:param http_headers: Additional headers to set or replace on requests.
|
||
"""
|
||
base_url = None
|
||
url_variables = None
|
||
if timeout_ms is None:
|
||
timeout_ms = self.sdk_configuration.timeout_ms
|
||
|
||
if server_url is not None:
|
||
base_url = server_url
|
||
else:
|
||
base_url = self._get_url(base_url, url_variables)
|
||
|
||
request = operations.GetRankingsDailyRequest(
|
||
http_referer=http_referer,
|
||
x_open_router_title=x_open_router_title,
|
||
x_open_router_categories=x_open_router_categories,
|
||
start_date=start_date,
|
||
end_date=end_date,
|
||
)
|
||
|
||
req = self._build_request_async(
|
||
method="GET",
|
||
path="/datasets/rankings-daily",
|
||
base_url=base_url,
|
||
url_variables=url_variables,
|
||
request=request,
|
||
request_body_required=False,
|
||
request_has_path_params=False,
|
||
request_has_query_params=True,
|
||
user_agent_header="user-agent",
|
||
accept_header_value="application/json",
|
||
http_headers=http_headers,
|
||
_globals=operations.GetRankingsDailyGlobals(
|
||
http_referer=self.sdk_configuration.globals.http_referer,
|
||
x_open_router_title=self.sdk_configuration.globals.x_open_router_title,
|
||
x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories,
|
||
),
|
||
security=self.sdk_configuration.security,
|
||
allow_empty_value=None,
|
||
timeout_ms=timeout_ms,
|
||
)
|
||
|
||
if retries == UNSET:
|
||
if self.sdk_configuration.retry_config is not UNSET:
|
||
retries = self.sdk_configuration.retry_config
|
||
else:
|
||
retries = utils.RetryConfig(
|
||
"backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
|
||
)
|
||
|
||
retry_config = None
|
||
if isinstance(retries, utils.RetryConfig):
|
||
retry_config = (retries, ["5XX"])
|
||
|
||
http_res = await self.do_request_async(
|
||
hook_ctx=HookContext(
|
||
config=self.sdk_configuration,
|
||
base_url=base_url or "",
|
||
operation_id="getRankingsDaily",
|
||
oauth2_scopes=None,
|
||
security_source=get_security_from_env(
|
||
self.sdk_configuration.security, components.Security
|
||
),
|
||
),
|
||
request=req,
|
||
error_status_codes=["400", "401", "429", "4XX", "500", "5XX"],
|
||
retry_config=retry_config,
|
||
)
|
||
|
||
response_data: Any = None
|
||
if utils.match_response(http_res, "200", "application/json"):
|
||
return unmarshal_json_response(components.RankingsDailyResponse, http_res)
|
||
if utils.match_response(http_res, "400", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.BadRequestResponseErrorData, http_res
|
||
)
|
||
raise errors.BadRequestResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "401", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.UnauthorizedResponseErrorData, http_res
|
||
)
|
||
raise errors.UnauthorizedResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "429", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.TooManyRequestsResponseErrorData, http_res
|
||
)
|
||
raise errors.TooManyRequestsResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "500", "application/json"):
|
||
response_data = unmarshal_json_response(
|
||
errors.InternalServerResponseErrorData, http_res
|
||
)
|
||
raise errors.InternalServerResponseError(response_data, http_res)
|
||
if utils.match_response(http_res, "4XX", "*"):
|
||
http_res_text = await utils.stream_to_text_async(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
if utils.match_response(http_res, "5XX", "*"):
|
||
http_res_text = await utils.stream_to_text_async(http_res)
|
||
raise errors.OpenRouterDefaultError(
|
||
"API error occurred", http_res, http_res_text
|
||
)
|
||
|
||
raise errors.OpenRouterDefaultError("Unexpected response received", http_res)
|