name: Currencylayer Vocabulary
description: |
  Controlled vocabulary for the Currencylayer foreign exchange rate API. Terms
  unify the operational dimensions (resources, endpoints, parameters, plans)
  with the capability dimensions exposed downstream (rate lookup, conversion,
  time-frame analysis, change reporting).
url: https://raw.githubusercontent.com/api-evangelist/currencylayer/main/vocabulary/currencylayer-vocabulary.yml
created: '2026-05-29'
modified: '2026-05-29'
specificationVersion: '0.1'
provider: currencylayer
domain: Currency Exchange

dimensions:
  resources:
    - id: currency
      label: Currency
      definition: An ISO 4217 three-letter currency code Currencylayer supports (168+ codes plus precious metals).
    - id: quote
      label: Quote / Exchange Rate
      definition: A signed quote of one currency expressed in units of another, keyed as `SRCDST` (e.g. `USDEUR`).
    - id: conversion
      label: Conversion
      definition: An on-demand calculation translating an amount of one currency into another at a chosen rate.
    - id: timeFrame
      label: Time-Frame Series
      definition: A sequence of daily end-of-day quotes between two dates (max 365 days) for a given source/currencies pair.
    - id: changeReport
      label: Change Report
      definition: A summarized comparison of start rate, end rate, absolute change, and percentage change between two dates.

  endpoints:
    - id: listCurrencies
      label: List Supported Currencies
      method: GET
      path: /list
    - id: getLive
      label: Get Live Exchange Rates
      method: GET
      path: /live
    - id: getHistorical
      label: Get Historical Exchange Rates
      method: GET
      path: /historical
    - id: convertCurrency
      label: Convert Currency Amount
      method: GET
      path: /convert
    - id: getTimeFrame
      label: Get Time-Frame Exchange Rates
      method: GET
      path: /timeframe
    - id: getChange
      label: Get Currency Change Data
      method: GET
      path: /change

  parameters:
    - id: source
      label: Source / Base Currency
      definition: ISO 4217 currency code anchoring the rate set. Defaults to USD; switchable on Basic and above.
    - id: currencies
      label: Currencies Filter
      definition: Comma-separated list of target currency codes that scopes the response.
    - id: from
      label: Source Currency (Convert)
      definition: ISO 4217 code identifying the currency being converted out of.
    - id: to
      label: Target Currency (Convert)
      definition: ISO 4217 code identifying the currency being converted into.
    - id: amount
      label: Conversion Amount
      definition: Numeric amount of the source currency to convert.
    - id: date
      label: Historical Date
      definition: ISO-8601 calendar date specifying a historical record.
    - id: start_date
      label: Window Start Date
      definition: First date in a time-frame or change window.
    - id: end_date
      label: Window End Date
      definition: Last date in a time-frame or change window.

  capabilities:
    - id: realtime-fx
      label: Real-Time FX Lookup
      definition: Retrieve current rates anchored to a chosen source, optionally filtered.
    - id: historical-fx
      label: Historical FX Lookup
      definition: Retrieve end-of-day rates for any working day since 1999.
    - id: currency-conversion
      label: Currency Conversion
      definition: Convert an amount from one currency into another at a real-time or historical rate.
    - id: timeframe-analysis
      label: Time-Frame Analysis
      definition: Pull a window of daily rates for trend analysis or backtesting (up to 365 days).
    - id: change-reporting
      label: Change Reporting
      definition: Summarize rate movement between two dates for risk monitoring and treasury reporting.

  commercial:
    - id: plan
      label: Subscription Plan
      values: [Free, Basic, Professional, Enterprise, "Enterprise Plus", Custom]
    - id: refreshRate
      label: Rate Refresh Cadence
      values: [Hourly, "10-minute", "60-second"]
    - id: httpsGating
      label: HTTPS Encryption Gating
      definition: HTTPS is included on every paid tier; Free is HTTP only.
    - id: sourceCurrencySwitching
      label: Source Currency Switching
      definition: Ability to set `source` to a non-USD currency; gated to Basic and above.

  data-sources:
    - id: multi-source
      label: Multi-Source Aggregation
      definition: Currencylayer blends 15+ commercial-grade exchange rate providers to deliver 168+ supported currencies.
    - id: precious-metals
      label: Precious Metals
      definition: Coverage extends beyond fiat to gold, silver, platinum, and other tradeable metals.

tags:
  - Currency Exchange
  - Foreign Exchange
  - FX
  - Forex
  - Conversion
  - Historical Rates
  - Time Frame
  - Change Report
  - APILayer