Frankfurter · Schema

Provider

Provider schema from Frankfurter API

Currency ExchangeForeign ExchangeFXOpen SourceMITSelf-HostedPublic APIs

Properties

Name Type Description
key string Provider identifier
name string Full provider name
country_code stringnull ISO 3166-1 alpha-2 country code
rate_type stringnull Official rate type as used by the source
pivot_currency stringnull Base currency for published rates
data_url stringnull Link to the data source
terms_url stringnull Link to terms of use
start_date stringnull Earliest available date
end_date stringnull Latest available date
publishes_missed integernull Number of expected publishes missed since end_date. For daily providers, counts scheduled publish days strictly between end_date and today. For weekly and monthly providers, counts ISO weeks or calend
currencies array Currency codes covered by this provider
View JSON Schema on GitHub

JSON Schema

v2-provider-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/frankfurter/refs/heads/main/json-schema/v2-provider-schema.json",
  "title": "Provider",
  "description": "Provider schema from Frankfurter API",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "Provider identifier"
    },
    "name": {
      "type": "string",
      "description": "Full provider name"
    },
    "country_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "ISO 3166-1 alpha-2 country code"
    },
    "rate_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "Official rate type as used by the source"
    },
    "pivot_currency": {
      "type": [
        "string",
        "null"
      ],
      "description": "Base currency for published rates"
    },
    "data_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Link to the data source"
    },
    "terms_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Link to terms of use"
    },
    "start_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date",
      "description": "Earliest available date"
    },
    "end_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date",
      "description": "Latest available date"
    },
    "publishes_missed": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "description": "Number of expected publishes missed since end_date. For daily providers, counts scheduled publish days strictly between end_date and today. For weekly and monthly providers, counts ISO weeks or calendar months between the latest imported bucket and the bucket whose publish window has already started. Null when the provider has no scheduled cadence or no imported data."
    },
    "currencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Currency codes covered by this provider"
    }
  },
  "required": [
    "key",
    "name",
    "currencies"
  ]
}