currency flow logo

API Endpoints:

Status Endpoint

The status endpoint returns information about your current quota.

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

GET/v3/status

Check API Status

This status endpoint returns information about your current quota.

Response Properties

  • Name
    quotas
    Type
    object
    Description

    Contains information about your request quota.

Request

GET
/v3/status
curl -G https://api.currencyflow.io/v3/status \
    -H "apikey: YOUR-API-KEY"

Response

{
  "account_id": 313373133731337,
  "quotas": {
      "total": 300,
      "used": 72,
      "remaining": 229
      "expiredAt": "2023-12-13T15:35"
  }
}

Currencies Endpoint

Returns a list of all featured currencies of currencyapi.

GET/v3/currencies

Supported Currencies

The endpoint returns a list of all supported currencies that are available through our other endpoints.

Response Structure

Our /currencies endpoint offers the following information:

Request

GET
/v3/currencies
curl -G https://api.currencyflow.io/v3/currencies \
    -H "apikey: YOUR-API-KEY"

Full Response

{
    "data": {
        "AED": {
            "symbol": "AED",
            "name": "United Arab Emirates Dirham",
        },
        "AFN": {
            "symbol": "Af",
            "name": "Afghan Afghani",
        },
        "...": {}
    }
}

Latest Exchange Rates

On this page, we’ll dive into the latest exchange rates endpoint you can use to retrieve the latest currency exchange rate data for any given base currency, programmatically.

GET/v3/latest

Latest Currency Exchange Data

This endpoint returns currency exchange data for any given base currency (default USD).

Optional attributes

  • Name
    base_currency
    Type
    string
    Description

    The base currency to which all results are behaving relative to By default all values are based on USD

  • Name
    currencies
    Type
    string
    Description

    A list of comma-separated currency codes which you want to get (EUR,USD,CAD) By default all available currencies will be shown

Reponse Structure

The API response comes as a JSON and consists of a meta and a data key. The meta holds useful information like the last_updated_at datetime to let you know then this dataset was last updated. The data key holds the actual currency information.

Request

GET
/v3/latest
curl -G https://api.currencyflow.io/v3/latest \
    -H "apikey: YOUR-API-KEY"

Full Response

{
    "meta": {
        "last_updated_at": "2023-06-23T10:15:59Z"
    },
    "rates": {
        "AED": 3.67306        },
        "AFN": 91.80254
        },
        "...": "150+ more currencies"
    }
}

meta   Response Properties

  • Name
    last_updated_at
    Type
    string
    Description

    The latest update time as a datetime string

{
    "meta": {
        "last_updated_at": "2022-01-01T23:59:59Z"
    }
}

rates   Response Properties

  • Name
    three letter currency code
    Type
    string
    Description

    a list of supported currencies can be found here: /currencies

  • Name
    value
    Type
    float
    Description

    the current convertion rate

{
    "rates": {
        "AED": 3.6725,
    }
}

Historical Exchange Rates

On this page, we’ll dive into the historical exchange rates endpoint you can use to retrieve historical exchangen rates for a specific date. Data are available all the way back to 1999.

GET/v3/historical

Historical Exchange Rates

This historical exchange rates endpoint provides currency rates for a specified date.

Required attributes

  • Name
    date
    Type
    string
    Description

    Date to retrieve historical rates from (format: 2021-12-31)

Optional attributes

  • Name
    base_currency
    Type
    string
    Description

    The base currency to which all results are behaving relative to By default all values are based on USD

  • Name
    currencies
    Type
    string
    Description

    A list of comma seperated currency codes which you want to get (EUR,USD,CAD) By default all available currencies will be shown

Response Properties

The response is equal to the response from /latest endpoint.

Request

GET
/v3/historical
curl -G https://api.currencyflow.io/v3/historical?date=2022-01-01 \
    -H "apikey: YOUR-API-KEY"

Full Response

{
    "meta": {
        "last_updated_at": "2022-01-01T23:59:59Z"
    },
    "rates": {
        "AED": 3.6725,
        "...": "170+ more currencies"
    }
}

Convert Exchange Rates

On this page, we’ll dive into the convert exchange rates endpoint you can use to directly convert a value to another currency's value.

GET/v3/convert

Convert Exchange Rates

Returns calculated values for today or any given date for all currencies.

Required attributes

  • Name
    value
    Type
    string
    Description

    The value you want to convert

Optional attributes

  • Name
    date
    Type
    string
    Description

    Date to retrieve historical rates from (format: 2021-12-31)

  • Name
    base_currency
    Type
    string
    Description

    The base currency to which all results are behaving relative to By default all values are based on USD

  • Name
    currencies
    Type
    string
    Description

    A list of comma seperated currency codes which you want to get (EUR,USD,CAD) By default all available currencies will be shown

Response Properties

The response is equal to the response from /latest endpoint.

Request

GET
/v3/convert
curl -G https://api.currencyflow.io/v3/convert?value=12 \
    -H "apikey: YOUR-API-KEY"

Full Response

{
    "meta": {
        "last_updated_at": "2022-01-01T23:59:59Z"
    },
    "rates": {
        "AED": 3.6725,
        },
        "...": "150+ more currencies"
    }
}