Python SDKAPI Reference

Credits - Python SDK

Credits method reference

Overview

Credit management endpoints

Available Operations

get_credits

Get total credits purchased and used for the authenticated user. Management key required.

Example Usage

1from openrouter import OpenRouter
2import os
3
4with OpenRouter(
5    http_referer="<value>",
6    x_open_router_title="<value>",
7    x_open_router_categories="<value>",
8    api_key=os.getenv("OPENROUTER_API_KEY", ""),
9) as open_router:
10
11    res = open_router.credits.get_credits()
12
13    # Handle response
14    print(res)

Parameters

ParameterTypeRequiredDescription
http_refererOptional[str]➖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.
x_open_router_titleOptional[str]➖The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
x_open_router_categoriesOptional[str]➖Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
retriesOptional[utils.RetryConfig]➖Configuration to override the default retry behavior of the client.

Response

operations.GetCreditsResponse

Errors

Error TypeStatus CodeContent Type
errors.UnauthorizedResponseError401application/json
errors.ForbiddenResponseError403application/json
errors.InternalServerResponseError500application/json
errors.OpenRouterDefaultError4XX, 5XX*/*