Usage Credits

What are usage credits and how to use them.

What are credits?

Credits are a unit of measurement that represent the computational resources your apps are consuming on Reservoir. Not all API queries are equal and some can be far more lightweight than others. Credits allow us to more fairly weigh different queries and actions and ensure you're only paying for what you need.

To keep things as simple as possible, most requests cost 1 credit. Only a handful of computationally heavy endpoints are priced higher (see below).

What are additional credits?

Each subscription plan offers a certain amount of included credits that resets with each billing cycle. Additional credits can be consumed and will be charged to your account at the end of the billing cycle. For more information about included credit amounts and additional credits costs for each subscription plan, visit our pricing page.

What are rate limits and how are they measured?

Rate limits are designed to protect the Reservoir network from abuse. Each subscription plan is offered a certain amount of credits that can be consumed every second (credits per second) for each of your apps (api key). For more information about credits per second for each subscription plan, visit our pricing page.

Please note that when hitting the rate limit, this does go towards your API usage. For example, if my API subscription limit is 1,000/minute but I make 2,000/minute then I will be using 2,000/minute even though half are error messages.

How do I monitor my usage?

You can monitor your company's credit usage from the current and previous billing cycle in the Developer Dashboard's usage & billing section.

Websocket costs

Every 100 websocket messages received will consume 1 credit. Learn more about how you can filter websocket events to reduce credit usage under the Subscription Options sections of the websocket docs.

Endpoint costs

Each API query uses a different amount of computational resources. See costs breakdown of each API endpoint below:

Collections

RouteBase CostExtra Costs
/collections/*1 credits/request
/search/collections/*1 credits/request
/collections/{collection}/supported-marketplaces/*1 credits/request
/users/{user}/collections/*1 credits/request
/collections/{collection}/community/*1 credits/request
/collections-sets/*1 credits/request
/contracts-sets/*1 credits/request
/collections/refresh/*1 credits/request

Tokens

RouteBase CostExtra Costs
/tokens/*1 credits/request
/tokens/bootstrap/*1 credits/request
/tokens/floor/*1 credits/request
/tokens/ids/*1 credits/request
/tokens/flag/changes/*1 credits/request
/users/{user}/tokens/*1 credits/request
/token-sets/*1 credits/request
/tokens/refresh/*1 credits/request

Orders

RouteBase CostExtra Costs
/orders/asks/*1 credits/request
/orders/bids/*1 credits/request
/orders/depth/*1 credits/request
/orders/users/{user}/top-bids/*1 credits/request

Events

RouteBase CostExtra Costs
/events/asks/*1 credits/request
/events/bids/*1 credits/request
/events/collections/floor-ask/*1 credits/request
/events/collections/top-bid/*1 credits/request
/events/tokens/floor-ask/*1 credits/request

Execute (Buy & Sell)

RouteBase CostExtra Costs
/execute/ask/*1 credits/request
/execute/bid/*1 credits/request
/execute/cancel/*1 credits/request
/execute/buy/*10 credits/request
/execute/sell/*10 credits/request
/order/*1 credits/request
/cross-posting-orders/*1 credits/request
/transactions/{txHash}/synced/*1 credits/request

Activity

RouteBase CostExtra Costs
/collections/activity/*1 credits/request
/tokens/{token}/activity/*1 credits/request
/users/activity/*1 credits/request

Sales & Transfers

RouteBase CostExtra Costs
/sales/*1 credits/request
/transfers/*1 credits/request
/transfers/bulk/*1 credits/request

Owners

Stats

RouteBase CostExtra Costs
/stats/*1 credits/request
/collections/daily-volumes/*1 credits/request
/liquidity/users/*1 credits/request

Sources

RouteBase CostExtra Costs
/sources/*1 credits/request

Oracle

RouteBase CostExtra Costs
/oracle/collections/floor-ask/*1 credits/request
/oracle/collections/top-bid/*1 credits/request
/oracle/tokens/status/*1 credits/request

Utility

RouteBase CostExtra Costs
/api-keys/{key}/rate-limits1 credits/request
/tokens/flag/*1 credits/request
/management/orders/simulate/*1 credits/request
/execute/auth-signature/*1 credits/request
/execute/cancel-signature/*1 credits/request