Skip to Content
Referência da APIEstatísticas de Uso

Estatísticas de Uso

Veja quantas requisições a sua chave fez até agora hoje (dia UTC), a janela atual de rate limit — requisições restantes neste minuto e quando a janela é reiniciada — e o número de streams abertos.

GET /api/v1/account/usage

Este endpoint substitui o antigo endpoint /me/usage. O formato de resposta foi atualizado para utilizar o envelope padrão v1.

AutenticaçãoLink permanente para esta seção

Requer API key. Disponível para todos os planos.

Exemplos de RequisiçõesLink permanente para esta seção

curl -X GET "https://api.sharpapi.io/api/v1/account/usage" \ -H "X-API-Key: YOUR_API_KEY"

RespostaLink permanente para esta seção

Sucesso (200)Link permanente para esta seção

{ "data": { "active_streams": 2, "rate_limit": { "limit": 300, "remaining": 287, "reset": 1770562200 }, "requests_today": 1284 }, "updated_at": "2026-02-08T14:49:12.123Z" }

requests_today é o número de requisições feitas com esta chave até agora no dia UTC atual. Volta a 0 às 00:00 UTC. Uma requisição é contada toda vez que passa pelo limitador de taxa, inclusive as que o limitador rejeita com 429. Em 19 de outubro de 2026 a contagem começou quando este campo entrou no ar, então o valor desse dia é menor que o total real.

rate_limit.limit, rate_limit.remaining e rate_limit.reset descrevem a janela de rate limit de um minuto, que é independente, e não a contagem diária.

Cabeçalhos de RespostaLink permanente para esta seção

X-RateLimit-Limit: 300 X-RateLimit-Remaining: 287 X-RateLimit-Reset: 1770562200 X-Data-Delay: 0 X-Request-Id: req_usage789abc

Respostas de ErroLink permanente para esta seção

401 Unauthorized

Se nenhuma chave for enviada, retorna missing_api_key; uma chave inválida retorna invalid_api_key.

{ "error": { "code": "missing_api_key", "message": "API key required. Pass via X-API-Key header, api_key query parameter, or Bearer token.", "docs": "https://docs.sharpapi.io/en/authentication" } }

Campos de RespostaLink permanente para esta seção

CampoTipoDescrição
requests_todayintegerRequisições feitas com esta chave até agora no dia UTC atual. Reiniciado às 00:00 UTC. Toda requisição que passa pelo limitador de taxa é contada, inclusive as rejeitadas com 429. Nenhum total semanal ou mensal é informado.
rate_limitobjectA janela atual de rate limit de um minuto — veja abaixo
active_streamsintegerConexões de streaming atualmente abertas nesta chave

O envelope também traz um updated_at no nível superior (timestamp RFC 3339).

Objeto Rate LimitLink permanente para esta seção

CampoTipoDescrição
limitintegerRequisições permitidas por minuto no seu plano
remainingintegerRequisições restantes no minuto atual (limit menos as requisições já contadas neste minuto, nunca abaixo de 0). Independente de requests_today
resetintegerTimestamp Unix (segundos) de quando a janela atual de um minuto termina

Casos de UsoLink permanente para esta seção

Monitorar Uso do Rate LimitLink permanente para esta seção

from datetime import datetime, timezone import requests response = requests.get( 'https://api.sharpapi.io/api/v1/account/usage', headers={'X-API-Key': 'YOUR_API_KEY'} ) usage = response.json()['data'] rl = usage['rate_limit'] usage_pct = (1 - rl['remaining'] / rl['limit']) * 100 print(f"Rate limit used this minute: {usage_pct:.1f}%") print(f"Window resets at: {datetime.fromtimestamp(rl['reset'], tz=timezone.utc).isoformat()}")

Acompanhar as requisições diáriasLink permanente para esta seção

requests_today é um valor diário; use rate_limit para o ritmo por minuto. Este exemplo compara a contagem diária com um orçamento que você mesmo escolhe (a resposta não inclui um limite diário):

import requests DAILY_BUDGET = 50_000 # your own target; the API does not report a daily cap response = requests.get( 'https://api.sharpapi.io/api/v1/account/usage', headers={'X-API-Key': 'YOUR_API_KEY'} ) usage = response.json()['data'] used = usage['requests_today'] print(f"Requests today (UTC): {used} of {DAILY_BUDGET} ({used / DAILY_BUDGET * 100:.1f}%)")

Verificar Streams AbertosLink permanente para esta seção

const { data } = await fetch( 'https://api.sharpapi.io/api/v1/account/usage', { headers: { 'X-API-Key': 'YOUR_API_KEY' } } ).then(r => r.json()); console.log(`${data.active_streams} stream(s) open on this key`);

A resposta não inclui o limite de streams simultâneos do seu plano; consulte Preços para ver os limites de cada plano.

Endpoints RelacionadosLink permanente para esta seção

Last updated on