Skip to main content

​
GET /api/static/usage

Check your current API quota and usage information, broken down by scan mode.

​
Request

Headers:
  • x-api-key (required): Your Rafter API key
Example: 
curl -H "x-api-key: RFabc-your-api-key-here" \
  https://rafter.so/api/static/usage

​
Response

Success (200 OK): 
{
  "quota": {
    "fast": { "used": 3, "limit": 15, "remaining": 12 },
    "plus": { "used": 1, "limit": 1, "remaining": 0 },
    "quota_reset_date": "2026-04-12T00:00:00Z"
  }
}
Error (401 Unauthorized): 
{
  "error": "Invalid or inactive API key."
}
Error (400 Bad Request): 
{
  "error": "Missing API key."
}

​
Response Fields

FieldTypeDescription
quota.fast.usedintegerFast scans used in current period
quota.fast.limitintegerFast scan limit for current period
quota.fast.remainingintegerFast scans remaining
quota.plus.usedintegerPlus scans used in current period
quota.plus.limitintegerPlus scan limit for current period
quota.plus.remainingintegerPlus scans remaining
quota.quota_reset_datestringISO 8601 date when quota resets

​
Plan Limits

Fast and Plus scans draw from separate quota pools — using one does not affect the other. See rafter.so/pricing for current plan limits.

​
Common Scenarios

​
Quota Available

{
  "quota": {
    "fast": { "used": 3, "limit": 15, "remaining": 12 },
    "plus": { "used": 0, "limit": 1, "remaining": 1 },
    "quota_reset_date": "2026-04-12T00:00:00Z"
  }
}

​
Fast Quota Exhausted (Plus Still Available)

{
  "quota": {
    "fast": { "used": 15, "limit": 15, "remaining": 0 },
    "plus": { "used": 0, "limit": 1, "remaining": 1 },
    "quota_reset_date": "2026-04-12T00:00:00Z"
  }
}

​
Rate Limiting

The API implements rate limiting to ensure fair usage:
  • Rate Limit: 100 requests per minute per IP address
  • Quota: Based on your subscription plan

​
Examples

​
JavaScript

const response = await fetch('https://rafter.so/api/static/usage', {
  headers: {
    'x-api-key': 'RFabc-your-api-key-here'
  }
});

const data = await response.json();
const { fast, plus } = data.quota;
console.log(`Fast scans: ${fast.remaining}/${fast.limit} remaining`);
console.log(`Plus scans: ${plus.remaining}/${plus.limit} remaining`);

​
Python

import requests

response = requests.get(
    'https://rafter.so/api/static/usage',
    headers={'x-api-key': 'RFabc-your-api-key-here'}
)

data = response.json()
fast = data['quota']['fast']
plus = data['quota']['plus']
print(f"Fast scans: {fast['remaining']}/{fast['limit']} remaining")
print(f"Plus scans: {plus['remaining']}/{plus['limit']} remaining")

​
Shell

#!/bin/bash

API_KEY="RFabc-your-api-key-here"
RESPONSE=$(curl -s -H "x-api-key: $API_KEY" \
  https://rafter.so/api/static/usage)

echo "Fast remaining: $(echo $RESPONSE | jq '.quota.fast.remaining')"
echo "Plus remaining: $(echo $RESPONSE | jq '.quota.plus.remaining')"