Skip to main content
GET
Obter Uso do Projeto

Visão Geral

Retorna uma visão completa do consumo de créditos de um projeto para o ciclo de crédito 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.). Todas as figuras de crédito estão restritas ao creditCycle — a janela em que os créditos são acumulados e reiniciados, derivada do ponto de ancoragem da assinatura. Todo projeto tem uma, incluindo planos gratuitos. O subscriptionDetails.billingCycle é a janela de faturamento; é informativa e null em planos gratuitos, que nunca são faturados.

Parâmetros de Solicitação

string
obrigatório
O ID do projeto para recuperar o uso. Deve corresponder ao projeto associado com a chave da API usada para autenticação.

Campos de Resposta

number
Créditos restantes no ciclo de crédito atual. Calculado como o limite de crédito do plano menos os créditos regulares consumidos, arredondado para zero.
number
Total de créditos consumidos no ciclo de crédito atual, incluindo créditos regulares e pré-pagos.
number
Créditos pré-pagos ainda disponíveis.
number
Créditos pré-pagos consumidos no ciclo de crédito atual.
object
A janela a que cada figura de crédito nesta resposta está restrita — o período em que os créditos são acumulados e reiniciados, derivado do ponto de ancoragem da assinatura. Sempre presente, para todos os planos, incluindo planos gratuitos.
string
Data de início do ciclo de crédito no formato YYYY-MM-DD (UTC).
string
Data de término do ciclo de crédito no formato YYYY-MM-DD (UTC).
object
Plano de assinatura e informações do ciclo de faturamento.
object | null
Datas de início e término do ciclo de faturamento atual. Somente informativo — null em planos gratuitos, que nunca são faturados. Em planos pagos, normalmente coincide com creditCycle.
string
Data de início do ciclo de faturamento no formato YYYY-MM-DD.
string
Data de término do ciclo de faturamento no formato YYYY-MM-DD.
number
Limite total de créditos para o ciclo de crédito com base no seu plano.
string
O nome do plano de assinatura (por exemplo, "business", "professional").
object
Consumo de créditos por produto para o ciclo de crédito atual, em créditos inteiros. Abrange todos os produtos. Os valores são acumulados em bruto e arredondados uma vez no final para corresponder ao faturamento, então os créditos por produto podem não somar exatamente para creditsUsed após o arredondamento.
number
Créditos consumidos pelo Solana RPC padrão.
number
Créditos consumidos pela Enhanced API (por exemplo, transações analisadas, metadados de token).
number
Créditos consumidos pela Wallet API.
number
Créditos consumidos pela API DAS (Digital Asset Standard).
number
Créditos consumidos pelos Webhooks.
number
Créditos consumidos pelo LaserStream gRPC (medido por largura de banda).
number
Créditos consumidos pelo LaserStream WebSocket (medido por largura de banda).
number
Créditos consumidos pelas Pré-confirmações.
number
Créditos consumidos pelo Arquivo.
number
Créditos consumidos pelo Photon (Compressão ZK).
number
Créditos consumidos por uso não categorizado.
object
Contagem de solicitações para o ciclo de crédito 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. Campos: rpc, enhancedApi, walletApi, das, webhooks, preConfirmations, archival, photon, other.
object
Bytes transferidos para o ciclo de crédito atual, apenas para os produtos LaserStream medidos por largura de banda. Esses produtos são cobrados por dados transferidos, não por contagem de solicitações, então aparecem aqui e em credits, mas nunca em requests. Campos: laserstreamGrpc, laserstreamWebsocket.

Parâmetros de Solicitação

string
obrigatório
O ID do projeto para recuperar o uso. Deve corresponder ao projeto associado à chave da API.

Autorizações

api-key
string
query
obrigatório

Chave de API passada como um parâmetro de consulta.

Parâmetros de caminho

id
string<uuid>
obrigatório

O ID do projeto para recuperar uso. Deve corresponder ao projeto associado à chave de API.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Resposta

Uso do projeto recuperado com sucesso.

creditsRemaining
number

Número de créditos restantes no ciclo de crédito atual. Calculado como creditsLimit - regularCreditsUsed, limitado a 0.

Exemplo:

487500

creditsUsed
number

Total de créditos consumidos no ciclo de crédito atual, incluindo créditos regulares e pré-pagos.

Exemplo:

12500

prepaidCreditsRemaining
number

Número de créditos pré-pagos restantes.

Exemplo:

50000

prepaidCreditsUsed
number

Número de créditos pré-pagos consumidos no ciclo de crédito atual.

Exemplo:

0

creditCycle
object

O período ao qual cada valor de crédito nesta resposta está vinculado — o período em que os créditos acumulam e são redefinidos, derivado do ponto de faturamento da assinatura. Sempre presente, para todos os planos, incluindo planos gratuitos que nunca são faturados.

subscriptionDetails
object

Detalhes sobre o plano de assinatura do projeto e o ciclo de faturamento.

credits
object

Consumo de créditos por produto para o ciclo de crédito 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, então os créditos por produto podem não somar exatamente a creditsUsed após o arredondamento.

requests
object

Contagens de solicitações para o ciclo de crédito atual, apenas para produtos tarifados por solicitação. Os produtos LaserStream tarifados por largura de banda (laserstreamGrpc, laserstreamWebsocket) não aparecem aqui — veja dataTransfer.

dataTransfer
object

Bytes transferidos para o ciclo de crédito atual, apenas para os produtos LaserStream tarifados por largura de banda. Esses produtos são faturados por dados transferidos, não por contagem de solicitações, então eles aparecem aqui e em credits, mas nunca em requests.