freecurrencyapi Documentation

# Status Endpoint

Returns your current quota and the plan of your account.

Quota

Requests to this endpoint do not count against your quota or rate limit

Request Method: GET
Request URL: https://api.freecurrencyapi.com/v1/status

# Request Parameters

Parameter Type Mandatory Description
apikey string ️ Your API Key

# Example Request

curl "https://api.freecurrencyapi.com/v1/status" \
    -H "apikey: YOUR-APIKEY"

# Sample Response

account_id is your account's numeric ID, account_id_str the same id as a string for JavaScript clients, whose numbers lose precision above 2^53. The month bucket is your regular monthly request quota. The grace bucket is a temporary extra allowance that keeps your integration running while a pending payment is being completed — it is 0 unless a grace period is active for your account.

{
    "account_id": 313373133731337,
    "account_id_str": "313373133731337",
    "quotas": {
        "month": {
            "total": 1000,
            "used": 71,
            "remaining": 929
        },
        "grace": {
            "total": 0,
            "used": 0,
            "remaining": 0
        }
    },
    "plan": {
        "name": "free",
        "interval": "month",
        "price_id": "price_1AbCdEfGhIjKlMnOpQrStUvW",
        "free": true,
        "custom": false,
        "status": "active",
        "renews_at": "2026-11-01T00:00:00+00:00",
        "scheduled": null,
        "upgrade_url": "https://app.freecurrencyapi.com/upgrade?utm_source=agent&utm_campaign=status&team=313373133731337",
        "plans_url": "https://api.freecurrencyapi.com/v1/agent/plans"
    }
}

The response also has a plan object after quotas: name, interval, price_id, free, custom, status (of the subscription, e.g. active), renews_at, scheduled (a plan change that starts later, or null), upgrade_url (null for a custom plan) and plans_url (every plan as JSON). Use it to check that an upgrade took effect.

# When to call it

  • Before a batch job, to check that enough requests are left this month.
  • After an upgrade, to confirm the new plan in plan.name.
  • In a monitoring check: the call is free, so it can run as often as you like.

# Quota fields

Field Description
total Requests included in the bucket for this period
used Requests counted so far
remaining Requests left until the quota resets

When quotas.month.remaining reaches 0, the data endpoints return 429 with error.code quota_exceeded until the quota resets; see status codes (opens new window). A missing or invalid API key returns 401 here too.

← Currencies Endpoint →