diff --git a/MIGRATION.md b/MIGRATION.md new file mode 100644 index 0000000..41deab9 --- /dev/null +++ b/MIGRATION.md @@ -0,0 +1,6 @@ +### Migration Guide +1. Change the URL from `https://cdn.jsdelivr.net/gh/fawazahmed0/currency-api@{apiVersion}/{date}/{endpoint}`
to
`https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@{date}/{apiVersion}/{endpoint}` + +2. change `date` from `YYYY-MM-DD` to `YYYY.M.D` . Eg: `2024-03-01` becomes `2024.3.1` + +3. There is no `/currencies/{currencyCode}/{currencyCode}` endpoint in this new API, so please only use `/currencies/{currencyCode}` \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e8ecf8 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +

Free Currency Exchange Rates API

+ +[![Publish-Currencies](https://github.com/fawazahmed0/exchange-api/actions/workflows/run.yml/badge.svg)](https://github.com/fawazahmed0/exchange-api/actions/workflows/run.yml) + + +**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:** +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](https://github.com/fawazahmed0/exchange-api/blob/main/MIGRATION.md) + +