Estadísticas de uso

Consulta las estadísticas de uso de la API de tu cuenta, incluidos los recuentos de solicitudes, el estado del rate limit y los streams activos.


GET /api/v1/account/usage

Este endpoint reemplaza al antiguo endpoint /me/usage. El formato de la respuesta se ha actualizado para utilizar el envoltorio estándar v1.

AutenticaciónPermalink for this section

Requiere API key. Disponible para todos los planes.

Ejemplos de solicitudesPermalink for this section

cURL


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

JavaScript


const response = await fetch(
  'https://api.sharpapi.io/api/v1/account/usage',
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
const { data } = await response.json();
 
console.log(`Today: ${data.requests.today} requests`);
console.log(`This week: ${data.requests.this_week} requests`);
console.log(`This month: ${data.requests.this_month} requests`);
console.log(`Rate limit remaining: ${data.requests.limit.remaining}/${data.requests.limit.per_minute} per minute`);
console.log(`Active streams: ${data.streams.active}/${data.streams.max}`);

Python


import requests
 
response = requests.get(
    'https://api.sharpapi.io/api/v1/account/usage',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
usage = response.json()['data']
 
print(f"Today: {usage['requests']['today']} requests")
print(f"This month: {usage['requests']['this_month']} requests")
print(f"Rate limit: {usage['requests']['limit']['remaining']}/{usage['requests']['limit']['per_minute']} per minute")
print(f"Active streams: {usage['streams']['active']}/{usage['streams']['max']}")

RespuestaPermalink for this section

Éxito (200)Permalink for this section


{
  "data": {
    "requests": {
      "today": 342,
      "this_week": 2105,
      "this_month": 14523,
      "limit": {
        "per_minute": 300,
        "remaining": 287,
        "resets_at": "2026-02-08T14:45:00.000Z"
      }
    },
    "streams": {
      "active": 2,
      "max": 10
    },
    "period": {
      "start": "2026-02-01T00:00:00.000Z",
      "end": "2026-02-28T23:59:59.000Z"
    }
  },
  "meta": {
    "updated_at": "2026-02-08T14:50:00.123Z"
  }
}

Cabeceras de respuestaPermalink for this section


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

Respuestas de errorPermalink for this section

401 Unauthorized


{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key",
    "docs": "https://docs.sharpapi.io/en/authentication"
  }
}

Campos de la respuestaPermalink for this section

Objeto RequestsPermalink for this section

Campo	Tipo	Descripción
`today`	number	Total de solicitudes a la API hoy (UTC)
`this_week`	number	Total de solicitudes a la API esta semana
`this_month`	number	Total de solicitudes a la API en este mes de facturación

Objeto Requests LimitPermalink for this section

Campo	Tipo	Descripción
`per_minute`	number	Número máximo de solicitudes a la API permitidas por minuto
`remaining`	number	Solicitudes restantes en la ventana actual del rate limit
`resets_at`	string	Marca de tiempo ISO 8601 en la que se reinicia la ventana del rate limit

Objeto StreamsPermalink for this section

Campo	Tipo	Descripción
`active`	number	Número de streams SSE/WebSocket actualmente activos
`max`	number	Número máximo de streams concurrentes permitidos (0 si el streaming no está habilitado)

Objeto PeriodPermalink for this section

Campo	Tipo	Descripción
`start`	string	Inicio en formato ISO 8601 del mes de facturación actual
`end`	string	Fin en formato ISO 8601 del mes de facturación actual

Casos de usoPermalink for this section

Monitorizar el uso del rate limitPermalink for this section


import requests
 
response = requests.get(
    'https://api.sharpapi.io/api/v1/account/usage',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
usage = response.json()['data']
 
limit = usage['requests']['limit']
usage_pct = (1 - limit['remaining'] / limit['per_minute']) * 100
print(f"Rate limit usage: {usage_pct:.1f}%")
print(f"Resets at: {limit['resets_at']}")

Comprobar la disponibilidad de streamsPermalink for this section


const { data } = await fetch(
  'https://api.sharpapi.io/api/v1/account/usage',
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
).then(r => r.json());
 
if (data.streams.active >= data.streams.max) {
  console.log('All stream slots in use — close a stream before opening a new one');
} else {
  console.log(`${data.streams.max - data.streams.active} stream slots available`);
}

Endpoints relacionadosPermalink for this section

Información de la cuenta - Detalles de la cuenta, plan y características
Gestión de API keys - Gestiona tus API keys
Precios - Compara los límites de los planes