Credits | OpenRouter Python SDK | OpenRouter

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

(credits)

Overview

Credit management endpoints

Available Operations

get_credits - Get remaining credits
create_coinbase_charge - Create a Coinbase charge for crypto payment

get_credits

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

Example Usage

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

Parameters

Parameter	Type	Required	Description
`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	/

create_coinbase_charge

Create a Coinbase charge for crypto payment

Example Usage

1 from openrouter import OpenRouter, operations
2 import os
3 
4 with OpenRouter() as open_router:
5 
6     res = open_router.credits.create_coinbase_charge(security=operations.CreateCoinbaseChargeSecurity(
7         bearer=os.getenv("OPENROUTER_BEARER", ""),
8     ), amount=100, sender="0x1234567890123456789012345678901234567890", chain_id=1)
9 
10     # Handle response
11     print(res)

Parameters

Parameter	Type	Required	Description
`security`	operations.CreateCoinbaseChargeSecurity	✔️	N/A
`amount`	float	✔️	N/A
`sender`	str	✔️	N/A
`chain_id`	components.ChainID	✔️	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CreateCoinbaseChargeResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestResponseError	400	application/json
errors.UnauthorizedResponseError	401	application/json
errors.TooManyRequestsResponseError	429	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

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

1	from openrouter import OpenRouter, operations
2	import os
3
4	with OpenRouter() as open_router:
5
6	res = open_router.credits.create_coinbase_charge(security=operations.CreateCoinbaseChargeSecurity(
7	bearer=os.getenv("OPENROUTER_BEARER", ""),
8	), amount=100, sender="0x1234567890123456789012345678901234567890", chain_id=1)
9
10	# Handle response
11	print(res)