mirrors/exchange-api
0
0
Fork 0
mirror of https://github.com/fawazahmed0/exchange-api.git synced 2025-06-30 02:31:14 +00:00
Code

add readme

Browse Source
This commit is contained in:
Fawaz Ahmed 2024-03-01 12:44:06 +05:30
parent ce67232724
commit a143b4ec3d
2 changed files with 73 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
MIGRATION.md Normal file
View File

@ -0,0 +1,6 @@
### Migration Guide
1. Change the URL from `https://cdn.jsdelivr.net/gh/fawazahmed0/currency-api@{apiVersion}/{date}/{endpoint}`<br> to<br> `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}`

67
README.md Normal file
View File

@ -0,0 +1,67 @@
<h1 align="center">Free Currency Exchange Rates API</h1>
[![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 <br>
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`<br>
> Lists all the available currencies in prettified json format:<br>
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies.json <br>
> Get a minified version of it:<br>
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies.min.json <br>
- `/currencies/{currencyCode}`<br>
> Get the currency list with EUR as base currency:<br>
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies/eur.json <br>
> Get the currency list with EUR as base currency on date 2024-03-02:<br>
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@2024.3.2/v1/currencies/eur.json <br>
> Get the currency list with BTC as base currency:<br>
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies/btc.json <br>
> Get the currency list with BTC as base currency in minified format:<br>
https://cdn.jsdelivr.net/npm/@fawazahmed0/currency-api@latest/v1/currencies/btc.min.json <br>
**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:<br>
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)