Get Current Usage

Retrieve usage metrics for the current UTC date.

Endpoint

GET /v1/usage

Authentication

Requires a developer API key in the Authorization header.

Request Headers

Header	Value
Authorization	Bearer <api_key>

Example Request

curl https://api.grantex.dev/v1/usage \
  -H "Authorization: Bearer gx_..."

Response — 200 OK

{
  "developerId": "dev_01HXYZ...",
  "period": "2026-04-05",
  "tokenExchanges": 142,
  "authorizations": 58,
  "verifications": 1203,
  "totalRequests": 1403
}

Response Fields

Field	Type	Description
developerId	string	The authenticated developer’s ID
period	string	Current date in YYYY-MM-DD format
tokenExchanges	number	Number of token exchange requests today
authorizations	number	Number of authorization requests today
verifications	number	Number of token verification requests today
totalRequests	number	Sum of all request types

Usage counters are served from Redis for real-time accuracy. They reset at midnight UTC.

Error Responses

Status	Code	Description
401	UNAUTHORIZED	Invalid or missing API key

SDK Examples

TypeScript

import Grantex from '@grantex/sdk';

const grantex = new Grantex({ apiKey: 'gx_...' });

const usage = await grantex.usage.current();
console.log(`Total requests today: ${usage.totalRequests}`);
console.log(`Token exchanges: ${usage.tokenExchanges}`);

from grantex import Grantex

grantex = Grantex(api_key="gx_...")

usage = grantex.usage.current()
print(f"Total requests today: {usage.total_requests}")
print(f"Token exchanges: {usage.token_exchanges}")