GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • RoxyAPI
  • Astrology
  • Vedic
  • Forecast
  • Human Design
  • Chinese Astrology
  • Feng Shui
  • Mesoamerican
  • Vastu
  • Numerology
  • Kabbalah
  • Tarot
  • Biorhythm
  • Ayurveda

This view

  • Original page
  • New address

GeezerVison is showing roxyapi.com — Usage API Reference: every endpoint, tested live | RoxyAPI

Usage API Reference

Monitor your API usage, check rate limits, and track request consumption. Get detailed usage breakdowns by endpoint, current month statistics, and recommendations for plan upgrades when approaching limits.

Auth
X-API-Key
Languages
en, tr, de, es, hi, pt, fr, ru, zh-Hans, zh-Hant
SDKs
TypeScript, Python, PHP, C#, Go, Rust, and Dart
GET /api/v2/usage

Get API usage statistics

Returns the live quota position for the API key on the request: plan name, billable requests used in the current UTC calendar month, the monthly allowance, and how many requests remain. It also returns the subscription status, billing email and the date the current billing period ends, so a dashboard can show quota and renewal together. Poll it to drive usage meters, low balance warnings, and upgrade prompts before a 429 ever happens.

Response

plan string, required
Name of the subscription plan the API key belongs to. One flat plan covers every domain and the Remote MCP servers, so this is a quota tier, never a per product entitlement.
usedThisMonth number, required
Billable requests counted against the current calendar month. The quota window is the UTC calendar month and resets on the 1st at 12:00 AM UTC, never on your renewal date, so an annual plan refills every month and a plan bought mid month still refills on the 1st. Read from the durable request ledger, which can trail the live limiter by up to 5 minutes; for the exact live position read the X-RateLimit-Used header on any response, including this one. Cached responses still count; a request that failed on our side with a 5xx never does.
requestsPerMonth number, required
Monthly request allowance for the plan. Every data endpoint call, API or MCP, is one request and a report spends the cost its operation lists in x-request-cost: there is no per domain fee.
remainingThisMonth number, required
Requests left before the monthly allowance is exhausted, floored at zero. Equal to requestsPerMonth minus usedThisMonth. Refills at the calendar month rollover, whose exact instant every API response carries as a Unix timestamp in the X-RateLimit-Reset header.
email string (email), required
Billing email the subscription is registered under.
status string, required
Subscription lifecycle state. Values: active, cancelled (no longer renewing but usable until endDate), suspended (payment failed, usable until endDate), expired (past endDate), pending (checkout started, payment not captured).
endDate string (date-time), required
ISO 8601 timestamp when the current billing period ends. A renewal extends this date in place. API access survives a cancelled or suspended status until this moment passes. This is a BILLING date, not a quota date: the monthly allowance resets on the 1st of each month independently of it.

Errors

StatusMeaning
400Validation error. `issues[]` lists every failed field.
401Invalid or missing API key
404Subscription not found
405Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
429Monthly rate limit exceeded
500Internal server error
TypeScript
import { createRoxy } from '@roxyapi/sdk'

const roxy = createRoxy(process.env.ROXY_API_KEY!)
const { data } = await roxy.usage.getUsageStats()

Install: npm install @roxyapi/sdk

Python
from roxy_sdk import create_roxy

roxy = create_roxy("YOUR_API_KEY")
result = roxy.usage.get_usage_stats()

Install: pip install roxy-sdk

PHP
use function RoxyAPI\Sdk\createRoxy;

$roxy = createRoxy(getenv('ROXY_API_KEY'));
$result = $roxy->usage->getUsageStats();

Install: composer require roxyapi/sdk

C#
using RoxyApi;

var roxy = new RoxyClient(Environment.GetEnvironmentVariable("ROXY_API_KEY")!);
var result = await roxy.Usage.GetAsync();

Install: dotnet add package RoxyApi.Sdk

Go
import roxyapi "github.com/RoxyAPI/sdk-go"

roxy, _ := roxyapi.NewRoxy(os.Getenv("ROXY_API_KEY"))
resp, _ := roxy.Usage.GetUsageStats(ctx, nil)

Install: go get github.com/RoxyAPI/sdk-go

Rust
use roxyapi::Roxy;

async fn call(roxy: &Roxy) -> Result<(), roxyapi::Error> {
    let result = roxy.usage().get_usage_stats().await?;
    println!("{result:?}");
    Ok(())
}

Install: cargo add roxyapi

Dart
import 'package:roxyapi/roxyapi.dart';

final roxy = Roxy(Platform.environment['ROXY_API_KEY'] ?? '');
final result = await roxy.usage.getUsageStats();

Install: dart pub add roxyapi

cURL
curl "https://roxyapi.com/api/v2/usage" \
  -H "X-API-Key: YOUR_KEY"
Sending
Example response
{
  "plan": "Pro",
  "usedThisMonth": 1523,
  "requestsPerMonth": 10000,
  "remainingThisMonth": 8477,
  "email": "[email protected]",
  "status": "active",
  "endDate": "2026-09-01T00:00:00.000Z"
}
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.