Frankfurter · JSON Structure

V2 Rate Structure

Rate schema from Frankfurter API

Type: object Properties: 5 Required: 4
Currency ExchangeForeign ExchangeFXOpen SourceMITSelf-HostedPublic APIs

Rate is a JSON Structure definition published by Frankfurter, describing 5 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

date base quote rate providers

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/frankfurter/refs/heads/main/json-structure/v2-rate-structure.json",
  "name": "Rate",
  "description": "Rate schema from Frankfurter API",
  "type": "object",
  "properties": {
    "date": {
      "type": "date",
      "description": "The date of the rate"
    },
    "base": {
      "type": "string",
      "description": "Base currency code"
    },
    "quote": {
      "type": "string",
      "description": "Quote currency code"
    },
    "rate": {
      "type": "double",
      "description": "Exchange rate value",
      "exclusiveMinimum": 0
    },
    "providers": {
      "type": "array",
      "description": "Per-provider rates for this pair. Present only when `expand=providers` is set. Each entry has the provider's published rate (rebased to the row's base). Entries with `excluded: true` did not contribute to the blended `rate` \u2014 either flagged as outliers by the consensus filter, or overridden by a currency peg. Omitted on synthesized peg rows where no provider published the quote.",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "Provider key"
          },
          "rate": {
            "type": "double",
            "exclusiveMinimum": 0,
            "description": "Provider's rate, rebased to the row's base"
          },
          "excluded": {
            "type": "boolean",
            "description": "Present and true when this entry did not contribute to the blended rate"
          }
        },
        "required": [
          "key",
          "rate"
        ]
      }
    }
  },
  "required": [
    "date",
    "base",
    "quote",
    "rate"
  ]
}