Path parameters

• bank string Required

  Source code from /api/v1/central-banks (e.g. ecb, boc, cbsl, banxico, ustreasury)

  Format should match the following pattern: ^[a-z0-9_-]{2,20}$.

Query parameters

• source string

  Pair mode: source currency, 3-letter code (requires target)

  Minimum length is 3, maximum length is 3.

• target string

  Pair mode: target currency, 3-letter code (requires source)

  Minimum length is 3, maximum length is 3.

• type string

  Rate type to return when the pair is requested with source+target on a two-sided table (buy/sell banks such as TCMB, BCB, BI, CBN). Values are the bank's own type labels as shown in its full table, e.g. buy or sell. Without it the pair resolves reference, mid, import, buy, sell in that order and rate_type says which side was used. A type the bank does not publish returns 404 listing the available types.

• format string

  Response format (default json). csv is UTF-8 with a BOM; xlsx is a real Excel workbook with typed dates and numbers; xml mirrors the JSON fields.

  Values are json, csv, xml, or xlsx. Default value is json.

Responses

• 200 application/json

  Latest published table (or single resolved pair when source+target given)

  One of:

  CbTable object CbPair object

  Hide attributes Show attributes

  • bank string Required
  • name string
  • rate_date string(date) Required
  • rates array[object] Required
    Hide rates attributes Show rates attributes object

    • base string
    • quote string
    • type string

      Rate type as labeled by the bank (reference, buying, selling, indicative, ...)

    • value number(double)
  • disclaimer string

  Hide attributes Show attributes

  • bank string Required
  • name string
  • rate_date string(date) Required
  • source string Required
  • target string Required
  • rate number(double) Required
  • rate_type string
  • derived boolean

    True when not directly published by the bank (inverse or cross-computed)

  • method string

    Values are published, inverse, or cross.

  • disclaimer string
• 400 application/json

  Invalid or missing parameters

  Hide response attributes Show response attributes object

  • error string Required

    Error message

  • hint string

    Optional remediation hint

• 401 application/json

  Authentication required — provide an API key via Authorization: Bearer art_live_... (free keys at https://allratestoday.com/register)

  Hide response attributes Show response attributes object

  • error string Required

    Error message

  • hint string

    Optional remediation hint

• 404 application/json

  Unknown bank, or the bank does not publish the requested pair

  Hide response attributes Show response attributes object

  • error string Required

    Error message

  • hint string

    Optional remediation hint

• 429 application/json

  Monthly request limit exceeded (X-Monthly-Limit / X-Monthly-Used / X-Monthly-Resets headers included)

  Hide response attributes Show response attributes object

  • error string
  • used integer
  • limit integer
  • plan string
  • resets_at string(date-time)
  • upgrade_url string
• 503 application/json

  No rates ingested yet for this bank

  Hide response attributes Show response attributes object

  • error string Required

    Error message

  • hint string

    Optional remediation hint