Skip to main content
GET
/
v0
/
admin
/
projects
/
{id}
/
usage
Get Project Usage
curl --request GET \
  --url 'https://admin-api.helius.xyz/v0/admin/projects/{id}/usage?api-key='
{
  "creditsRemaining": 487500,
  "creditsUsed": 12500,
  "prepaidCreditsRemaining": 50000,
  "prepaidCreditsUsed": 0,
  "subscriptionDetails": {
    "billingCycle": {
      "start": "2026-04-01",
      "end": "2026-05-01"
    },
    "creditsLimit": 500000,
    "plan": "business"
  },
  "usage": {
    "api": 1200,
    "archival": 0,
    "das": 5000,
    "grpc": 300,
    "grpcGeyser": 0,
    "photon": 0,
    "rpc": 4500,
    "stream": 100,
    "webhook": 800,
    "websocket": 600
  }
}

โ€‹
Overview

Returns a complete picture of a projectโ€™s credit consumption for the current billing cycle, including credits remaining, subscription plan details, and a breakdown of requests by service type (RPC, DAS, gRPC, WebSocket, etc.).

โ€‹
Request Parameters

โ€‹
id
string
required
The project ID to retrieve usage for. Must match the project associated with the API key used for authentication.

โ€‹
Response Fields

โ€‹
creditsRemaining
number
Credits remaining in the current billing cycle. Calculated as the planโ€™s credit limit minus regular credits consumed, floored at zero.
โ€‹
creditsUsed
number
Total credits consumed in the current billing cycle, including both regular and prepaid credits.
โ€‹
prepaidCreditsRemaining
number
Prepaid credits still available.
โ€‹
prepaidCreditsUsed
number
Prepaid credits consumed in the current billing cycle.
โ€‹
subscriptionDetails
object
Subscription plan and billing cycle information.
โ€‹
subscriptionDetails.billingCycle.start
string
Billing cycle start date in YYYY-MM-DD format.
โ€‹
subscriptionDetails.billingCycle.end
string
Billing cycle end date in YYYY-MM-DD format.
โ€‹
subscriptionDetails.creditsLimit
number
Total credit allowance for the billing cycle based on your plan.
โ€‹
subscriptionDetails.plan
string
The name of the subscription plan (e.g., "business", "professional").
โ€‹
usage
object
Request counts broken down by service type. Each field is the total number of requests made to that service during the current billing cycle.
โ€‹
usage.api
number
Enhanced API requests (e.g., parsed transactions, token metadata).
โ€‹
usage.archival
number
Archival RPC requests.
โ€‹
usage.das
number
DAS (Digital Asset Standard) API requests.
โ€‹
usage.grpc
number
gRPC streaming requests.
โ€‹
usage.grpcGeyser
number
Geyser gRPC requests.
โ€‹
usage.photon
number
ZK Compression (Photon) requests.
โ€‹
usage.rpc
number
Standard Solana RPC requests.
โ€‹
usage.stream
number
LaserStream data streaming requests.
โ€‹
usage.webhook
number
Webhook delivery events.
โ€‹
usage.websocket
number
WebSocket subscription requests.

โ€‹
Request Parameters

โ€‹
id
string
required
The project ID to retrieve usage for. Must match the project associated with the API key.

Authorizations

โ€‹
api-key
string
query
required

API key passed as a query parameter.

Path Parameters

โ€‹
id
string<uuid>
required

The project ID to retrieve usage for. Must match the project associated with the API key.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Project usage retrieved successfully.

โ€‹
creditsRemaining
number

Number of credits remaining in the current billing cycle. Calculated as creditsLimit - regularCreditsUsed, floored at 0.

Example:

487500

โ€‹
creditsUsed
number

Total credits consumed in the current billing cycle, including both regular and prepaid credits.

Example:

12500

โ€‹
prepaidCreditsRemaining
number

Number of prepaid credits remaining.

Example:

50000

โ€‹
prepaidCreditsUsed
number

Number of prepaid credits consumed in the current billing cycle.

Example:

0

โ€‹
subscriptionDetails
object

Details about the project's subscription plan and current billing cycle.

โ€‹
usage
object

Request counts broken down by service type for the current billing cycle.