Credits - Python SDK

Credits method reference

The Python SDK and docs are currently in beta. Report issues on GitHub.

Overview

Credit management endpoints

Available Operations

get_credits - Get remaining credits

get_credits

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

Example Usage

1 from openrouter import OpenRouter
2 import os
3 
4 with 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

Parameter	Type	Required	Description
`http_referer`	Optional[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_title`	Optional[str]	➖	The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
`x_open_router_categories`	Optional[str]	➖	Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetCreditsResponse

Errors

Error Type	Status Code	Content Type
errors.UnauthorizedResponseError	401	application/json
errors.ForbiddenResponseError	403	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

1	from openrouter import OpenRouter
2	import os
3
4	with 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)