Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.grantex.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET /v1/usage

​
Authentication

Requires a developer API key in the Authorization header.

​
Request Headers

HeaderValue
AuthorizationBearer <api_key>

​
Example Request

curl https://grantex-auth-dd4mtrt2gq-uc.a.run.app/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

FieldTypeDescription
developerIdstringThe authenticated developer’s ID
periodstringCurrent date in YYYY-MM-DD format
tokenExchangesnumberNumber of token exchange requests today
authorizationsnumberNumber of authorization requests today
verificationsnumberNumber of token verification requests today
totalRequestsnumberSum of all request types
Usage counters are served from Redis for real-time accuracy. They reset at midnight UTC.

​
Error Responses

StatusCodeDescription
401UNAUTHORIZEDInvalid or missing API key

​
SDK Examples

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}`);