Skip to content
RateFlowAPI

Endpoints

Endpoints

On this page

All endpoints require an X-API-Key header. See Authentication.

Successful responses use a consistent envelope: "success": true and a data object. Error responses instead return "success": false with an error object. See Errors.


Latest Rates

Retrieve the most recent exchange rates for a base currency.

GET /v1/rates/latest
Parameter Type Required Description
base query No Base currency code (e.g. EUR, USD). Defaults to EUR

Example request:

Shell
curl -s -H "X-API-Key: YOUR_API_KEY" "https://api.rateflowapi.com/v1/rates/latest?base=EUR"

Example response:

JSON
{
    "success": true,
    "data": {
        "base": "EUR",
        "updated_at": "2026-03-29T15:00:00Z",
        "rates": {
            "USD": 1.0821,
            "GBP": 0.8569,
            "JPY": 162.45,
            "CHF": 0.9612
        }
    }
}

Pair Conversion

Get the exchange rate between two currencies, with optional amount conversion.

GET /v1/rates/pair/{from}/{to}
Parameter Type Required Description
from path Yes Source currency code
to path Yes Target currency code
amount query No Amount to convert (0 < amount < 1,000,000,000,000)

Example request (with amount):

Shell
curl -s -H "X-API-Key: YOUR_API_KEY" "https://api.rateflowapi.com/v1/rates/pair/EUR/USD?amount=100"

Example response:

JSON
{
    "success": true,
    "data": {
        "base": "EUR",
        "target": "USD",
        "rate": 1.0821,
        "amount": 100,
        "converted": 108.21
    }
}

Example request (rate only):

Shell
curl -s -H "X-API-Key: YOUR_API_KEY" "https://api.rateflowapi.com/v1/rates/pair/EUR/USD"
JSON
{
    "success": true,
    "data": {
        "base": "EUR",
        "target": "USD",
        "rate": 1.0821
    }
}

Historical Rates

Retrieve exchange rates for a specific past date.

GET /v1/rates/history/{from}/{to}/{date}
Parameter Type Required Description
from path Yes Base currency code
to path Yes Target currency code
date path Yes Date in YYYY-MM-DD format

How far back the data goes. Available history depends on the currency. The roughly 30 currencies of the European Central Bank (ECB) reference set have daily history back to 4 January 1999. All other supported currencies have history from 5 June 2026 onward. A request for a date before a currency's first available day returns 404 no-data-available, provided your plan allows that date.

Example request:

Shell
curl -s -H "X-API-Key: YOUR_API_KEY" "https://api.rateflowapi.com/v1/rates/history/EUR/USD/2026-03-01"

Example response:

JSON
{
    "success": true,
    "data": {
        "base": "EUR",
        "target": "USD",
        "requested_date": "2026-03-01",
        "date": "2026-02-27",
        "carried_forward": true,
        "rate": 1.0794
    }
}
Field Description
requested_date The date you asked for. Always echoed back.
date The day the returned rate was actually published.
carried_forward true when date is earlier than requested_date (see below), false for a direct hit.
rate Units of to per one unit of from on date.

Days without a published rate. Most sources publish on business days only, so weekends and public holidays often have no rate of their own. When we hold no rate for the pair on the requested date, the API returns the most recent stored rate from the 7 days before it and marks the response with carried_forward: true and the real publication day in date. The example above asks for Sunday 1 March 2026, holds no Sunday rate, and receives Friday's. When a source did publish for that day, the rate is served directly with carried_forward: false. This is the same rule for every date, recent or historical. If nothing was published for the pair in that 7-day window, the API returns 404 no-data-available. The plan's history limit applies to requested_date.


Supported Codes

List all supported currency codes with their localized names.

GET /v1/currencies
Parameter Type Required Description
locale query No Language for names: en (default) or de

Example request:

Shell
curl -s -H "X-API-Key: YOUR_API_KEY" "https://api.rateflowapi.com/v1/currencies?locale=en"

Example response:

JSON
{
    "success": true,
    "data": {
        "currencies": {
            "EUR": "Euro",
            "USD": "US Dollar",
            "GBP": "British Pound",
            "JPY": "Japanese Yen",
            "CHF": "Swiss Franc"
        }
    }
}

Enriched Pair

Get a pair conversion with additional currency metadata (names and symbols).

GET /v1/rates/enriched/{from}/{to}
Parameter Type Required Description
from path Yes Source currency code
to path Yes Target currency code
locale query No Language for names: en (default) or de

Example request:

Shell
curl -s -H "X-API-Key: YOUR_API_KEY" "https://api.rateflowapi.com/v1/rates/enriched/EUR/USD"

Example response:

JSON
{
    "success": true,
    "data": {
        "base": "EUR",
        "target": "USD",
        "rate": 1.0821,
        "base_detail": {
            "name": "Euro",
            "symbol": "€"
        },
        "target_detail": {
            "name": "US Dollar",
            "symbol": "$"
        }
    }
}

Quota

Check your current plan's rate limit usage and remaining quota.

GET /v1/quota

No additional parameters required. The API key determines the user.

Example request:

Shell
curl -s -H "X-API-Key: YOUR_API_KEY" "https://api.rateflowapi.com/v1/quota"

Example response:

JSON
{
    "success": true,
    "data": {
        "plan": "Pro",
        "quota": {
            "base_limit": 50000,
            "effective_limit": 55000,
            "used": 12450,
            "remaining": 42550,
            "overflow_allowed": true,
            "overflow_percent": 10
        },
        "resets_at": "2026-04-01T00:00:00Z"
    },
    "meta": {
        "timestamp": "2026-03-29T15:00:00Z"
    }
}
Field Description
plan Name of your current plan
quota.base_limit Monthly request limit for your plan
quota.effective_limit Actual limit (higher if overflow is allowed)
quota.used Requests made this month
quota.remaining Requests remaining this month
quota.overflow_allowed Whether overflow above base limit is permitted
quota.overflow_percent Overflow percentage allowed (0-100)
resets_at ISO 8601 timestamp when quota resets (1st of next month)