> ## Documentation Index
> Fetch the complete documentation index at: https://www.helius.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Obter Uso do Projeto
> Recuperar uso de créditos, detalhes da assinatura e contagem de solicitações por serviço para um projeto dentro do ciclo de faturamento atual.
## Visão Geral
Retorna uma visão completa do consumo de créditos de um projeto para o ciclo de faturamento atual, incluindo créditos restantes, detalhes do plano de assinatura e um detalhamento das solicitações por tipo de serviço (RPC, DAS, gRPC, WebSocket, etc.).
## Parâmetros da Solicitação
O ID do projeto para o qual deseja recuperar o uso. Deve corresponder ao projeto associado à chave da API utilizada para autenticação.
## Campos de Resposta
Créditos restantes no ciclo de faturamento atual. Calculados como o limite de crédito do plano menos os créditos consumidos regularmente, arredondados para zero.
Total de créditos consumidos no ciclo de faturamento atual, incluindo créditos regulares e pré-pagos.
Créditos pré-pagos ainda disponíveis.
Créditos pré-pagos consumidos no ciclo de faturamento atual.
Informações do plano de assinatura e ciclo de faturamento.
Data de início do ciclo de faturamento no formato `YYYY-MM-DD`.
Data de término do ciclo de faturamento no formato `YYYY-MM-DD`.
Limite total de créditos para o ciclo de faturamento com base no seu plano.
Nome do plano de assinatura (ex: `"business"`, `"professional"`).
Consumo de créditos por produto para o ciclo de faturamento atual, em créditos inteiros. Abrange todos os produtos. Os valores são acumulados brutos e arredondados uma vez no final para corresponder ao faturamento, portanto, os créditos por produto podem não somar exatamente para `creditsUsed` após o arredondamento.
Créditos consumidos pelo Solana RPC padrão.
Créditos consumidos pela Enhanced API (ex: transações analisadas, metadados de token).
Créditos consumidos pela Wallet API.
Créditos consumidos pela API DAS (Digital Asset Standard).
Créditos consumidos por Webhooks.
Créditos consumidos pela LaserStream gRPC (medição de largura de banda).
Créditos consumidos pela LaserStream WebSocket (medição de largura de banda).
Créditos consumidos por Pré-confirmações.
Créditos consumidos por Arquivamento.
Créditos consumidos pelo Photon (ZK Compression).
Créditos consumidos por uso não categorizado.
Contagem de solicitações para o ciclo de faturamento atual, apenas para produtos com medição de solicitações. Os produtos LaserStream com medição de largura de banda (`laserstreamGrpc`, `laserstreamWebsocket`) não aparecem aqui — veja `dataTransfer`. Campos: `rpc`, `enhancedApi`, `walletApi`, `das`, `webhooks`, `preConfirmations`, `archival`, `photon`, `other`.
Bytes transferidos para o ciclo de faturamento atual, apenas para os produtos LaserStream com medição de largura de banda. Esses produtos são cobrados pelo volume de dados transferidos, não pela contagem de solicitações, então aparecem aqui e em `credits` mas nunca em `requests`. Campos: `laserstreamGrpc`, `laserstreamWebsocket`.
## Parâmetros da Solicitação
O ID do projeto para o qual deseja recuperar o uso. Deve corresponder ao projeto associado à chave da API.
## OpenAPI
````yaml pt-BR/openapi/admin-api/getProjectUsage.yaml GET /v0/admin/projects/{id}/usage
openapi: 3.0.3
info:
title: Helius Admin API
description: >
Acesso programático aos dados de uso e cobrança do projeto.
## Autenticação
Todas as solicitações requerem uma chave de API passada de uma das seguintes
formas:
- Cabeçalho: `X-Api-Key: YOUR_API_KEY`
- Parâmetro de consulta: `?api-key=YOUR_API_KEY`
version: 1.0.0
contact:
name: Suporte à API
url: https://helius.dev
servers:
- url: https://admin-api.helius.xyz
description: Servidor de produção
security:
- ApiKeyQuery: []
- ApiKeyHeader: []
paths:
/v0/admin/projects/{id}/usage:
get:
tags:
- Admin
summary: Obter Uso do Projeto
description: >
Recuperar uso de crédito, detalhes de assinatura e contagens de
solicitações por serviço para um projeto dentro do ciclo de cobrança
atual.
A chave de API usada para autenticação deve pertencer ao projeto
especificado no caminho. Solicitações em que o projeto da chave de API
não corresponde ao parâmetro `id` retornarão um erro `400`.
operationId: getProjectUsage
parameters:
- name: id
in: path
required: true
description: >-
O ID do projeto para recuperar uso. Deve corresponder ao projeto
associado à chave de API.
schema:
type: string
format: uuid
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
responses:
'200':
description: Uso do projeto recuperado com sucesso.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectUsageResponse'
example:
creditsRemaining: 486100
creditsUsed: 13900
prepaidCreditsRemaining: 50000
prepaidCreditsUsed: 0
subscriptionDetails:
billingCycle:
start: '2026-04-01'
end: '2026-05-01'
creditsLimit: 500000
plan: business
credits:
rpc: 4500
enhancedApi: 1200
walletApi: 0
das: 5000
webhooks: 800
laserstreamGrpc: 1500
laserstreamWebsocket: 800
preConfirmations: 100
archival: 0
photon: 0
other: 0
requests:
rpc: 4500
enhancedApi: 1200
walletApi: 0
das: 5000
webhooks: 800
preConfirmations: 50
archival: 0
photon: 0
other: 0
dataTransfer:
laserstreamGrpc: 15000000
laserstreamWebsocket: 8000000
'400':
description: >-
Requisição Inválida — o ID do projeto no caminho não corresponde ao
projeto associado à chave de API.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 400
message: ID de projeto inválido
error: Requisição Inválida
'401':
description: Não autorizado — chave de API ausente, malformada ou não encontrada.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 401
message: Chave de API ausente ou inválida
error: Não Autorizado
'403':
description: Proibido — a Admin API não está habilitada para este projeto.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 403
message: Admin API não habilitada para este projeto
error: Proibido
'429':
description: >-
Muitas Solicitações — limite de taxa de 5 solicitações por segundo
excedido.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 429
message: 'ThrottlerException: Muitas Solicitações'
error: Muitas Solicitações
'500':
description: >-
Erro Interno do Servidor — ocorreu um erro do lado do servidor (por
exemplo, dados de cobrança ausentes).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
statusCode: 500
message: Erro interno do servidor
error: Erro Interno do Servidor
components:
schemas:
ProjectUsageResponse:
type: object
properties:
creditsRemaining:
type: number
description: >-
Número de créditos restantes no ciclo de cobrança atual. Calculado
como `creditsLimit - regularCreditsUsed`, com piso em 0.
example: 487500
creditsUsed:
type: number
description: >-
Total de créditos consumidos no ciclo de cobrança atual, incluindo
tanto créditos regulares quanto pré-pagos.
example: 12500
prepaidCreditsRemaining:
type: number
description: Número de créditos pré-pagos restantes.
example: 50000
prepaidCreditsUsed:
type: number
description: Número de créditos pré-pagos consumidos no ciclo de cobrança atual.
example: 0
subscriptionDetails:
type: object
description: >-
Detalhes sobre o plano de assinatura do projeto e o ciclo de
cobrança atual.
properties:
billingCycle:
type: object
description: Datas de início e fim do ciclo de cobrança atual.
properties:
start:
type: string
description: Data de início do ciclo de cobrança.
example: '2026-04-01'
end:
type: string
description: Data de término do ciclo de cobrança.
example: '2026-05-01'
creditsLimit:
type: number
description: >-
Limite total de créditos para o ciclo de cobrança atual com base
no plano.
example: 500000
plan:
type: string
description: O nome do plano de assinatura.
example: business
credits:
type: object
description: >
Consumo de crédito por produto para o ciclo de cobrança atual, em
créditos inteiros.
Abrange todos os produtos. Os valores são acumulados em bruto e
arredondados apenas
no final para coincidir com a cobrança, portanto, os créditos por
produto podem não
somar exatamente a `creditsUsed` após o arredondamento.
properties:
rpc:
type: number
description: Créditos consumidos pelo RPC padrão do Solana.
example: 4500
enhancedApi:
type: number
description: >-
Créditos consumidos pela Enhanced API (por exemplo, transações
analisadas, metadados de token).
example: 1200
walletApi:
type: number
description: Créditos consumidos pela Wallet API.
example: 0
das:
type: number
description: Créditos consumidos pela API DAS (Digital Asset Standard).
example: 5000
webhooks:
type: number
description: Créditos consumidos pelos Webhooks.
example: 800
laserstreamGrpc:
type: number
description: >-
Créditos consumidos pelo LaserStream gRPC (medido por largura de
banda).
example: 1500
laserstreamWebsocket:
type: number
description: >-
Créditos consumidos pelo LaserStream WebSocket (medido por
largura de banda).
example: 800
preConfirmations:
type: number
description: Créditos consumidos pelas Preconfirmações.
example: 100
archival:
type: number
description: Créditos consumidos pelo Archival.
example: 0
photon:
type: number
description: Créditos consumidos pelo Photon (Compressão ZK).
example: 0
other:
type: number
description: Créditos consumidos por uso não categorizado.
example: 0
requests:
type: object
description: >
Contagens de solicitações para o ciclo de cobrança atual, apenas
para produtos medidos por solicitação.
Os produtos do LaserStream medidos por largura de banda
(`laserstreamGrpc`, `laserstreamWebsocket`)
não aparecem aqui — veja `dataTransfer`.
properties:
rpc:
type: number
description: Número de solicitações padrão de RPC do Solana.
example: 4500
enhancedApi:
type: number
description: Número de solicitações Enhanced API.
example: 1200
walletApi:
type: number
description: Número de solicitações da Wallet API.
example: 0
das:
type: number
description: Número de solicitações da API DAS (Digital Asset Standard).
example: 5000
webhooks:
type: number
description: Número de eventos de entrega de webhook.
example: 800
preConfirmations:
type: number
description: Número de solicitações de Preconfirmações.
example: 50
archival:
type: number
description: Número de solicitações de RPC de arquivamento.
example: 0
photon:
type: number
description: Número de solicitações de Photon (Compressão ZK).
example: 0
other:
type: number
description: Número de solicitações não categorizadas.
example: 0
dataTransfer:
type: object
description: >
Bytes transferidos para o ciclo de cobrança atual, apenas para os
produtos medidos por largura de banda
LaserStream. Esses produtos são cobrados por dados transferidos, não
por
contagem de solicitações, portanto, aparecem aqui e em `credits`,
mas nunca em `requests`.
properties:
laserstreamGrpc:
type: number
description: Bytes transferidos via LaserStream gRPC.
example: 15000000
laserstreamWebsocket:
type: number
description: Bytes transferidos via LaserStream WebSocket.
example: 8000000
ErrorResponse:
type: object
properties:
statusCode:
type: integer
description: Código de status HTTP.
message:
type: string
description: Mensagem de erro legível por humanos.
error:
type: string
description: Nome do erro HTTP.
securitySchemes:
ApiKeyQuery:
type: apiKey
in: query
name: api-key
description: Chave de API passada como um parâmetro de consulta.
ApiKeyHeader:
type: apiKey
in: header
name: X-Api-Key
description: Chave de API passada como um cabeçalho de solicitação.
````