0
0
mirror of https://github.com/fawazahmed0/exchange-api.git synced 2025-06-30 02:31:14 +00:00
exchange-api/README.md
2024-03-01 12:47:33 +05:30

2.2 KiB

Free Currency Exchange Rates API

Publish-Currencies

Features:

  • Free & Blazing Fast response
  • No Rate limits
  • 150+ Currencies, Including Common Cryptocurrencies
  • Daily Updated

URL Structure:

https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@{date}/{apiVersion}/{endpoint}

Formats:

date

The date should either be latest or in YYYY.M.D format

The Endpoints Supports HTTP GET Method and returns the data in two formats:

/{endpoint}.json

/{endpoint}.min.json

The above formats also work for fallback i.e if .min.json link fails, you can use .json link and vice versa

Warning: You should always include fallback mechanism in your code

Endpoints:

  • /currencies

Lists all the available currencies in prettified json format:
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies.json

Get a minified version of it:
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies.min.json

  • /currencies/{currencyCode}

Get the currency list with EUR as base currency:
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies/eur.json

Get the currency list with EUR as base currency on date 2024-03-02:
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@2024.3.2/v1/currencies/eur.json

Get the currency list with BTC as base currency:
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies/btc.json

Get the currency list with BTC as base currency in minified format:
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies/btc.min.json

Additional Fallback URL on CloudFlare:
This fallback URL only returns latest currencies and does not support date

https://currency-api.pages.dev/{apiVersion}/{endpoint}

Get the currency list with BTC as base currency:
https://currency-api.pages.dev/v1/currencies/btc.json

Migrating from Previous Currency API: Read this