Redume/Kekkai
1
0
Fork 0
mirror of https://github.com/Redume/Kekkai.git synced 2025-02-23 20:51:25 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Documentation for api endpoints
Some checks failed
Create and publish a Docker image / build-and-push-server (push) Has been cancelled
Details
Create and publish a Docker image / build-and-push-chart (push) Has been cancelled
Details
Create and publish a Docker image / build-and-push-CR (push) Has been cancelled
Details
Deploy docs / deploy (push) Has been cancelled
Details

Browse source
This commit is contained in:
Данил 2024-11-08 20:26:48 +03:00
parent cd01af2eac
commit 7157920e1e
3 changed files with 297 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

159
docs/endpoints/get-rate.md Normal file
View file

@ -0,0 +1,159 @@
Currencies are identified by standard three-letter `ISO 4217` currency codes.
## Getting the currency rate for a certain day.
### Request
=== "Shell"
=== "Curl"
```bash
curl --request GET \
--url https://kekkai-api.redume.su/api/getRate/?from_currency=RUB&conv_currency=USD&date=2024-10-16
```
=== "Python"
=== "Requests"
```py
import requests
res = requests.get('https://kekkai-api.redume.su/api/getRate/', {
'from_currency': 'RUB',
'conv_currency': 'USD',
'date': '2024-10-16',
}, timeout=3)
print(res.json())
```
=== "Node.JS"
=== "Axios"
```js
const axios = require('axios');
axios.get('https://kekkai-api.redume.su/api/getRate/', {
timeout: 3000,
'from_currency': 'RUB',
'conv_currency': 'USD',
'date': '2024-10-16',
}
)
.then((res) => {
console.log(JSON.stringify(res.json()));
})
.catch((err) => {
console.error(err);
});
```
### Query Parameters
| Parameter | Description |
|---------------|-------------------------------------------------------------------------|
| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place |
| `conv_currency` | `ISO 4217` code of the currency to which the conversion is performed |
| `date` | Currency rate date in the format `YYYYY-DD-MM` |
### Response
!!! info "Output"
```json
[
{
"from_currency": "RUB",
"conv_currency": "USD",
"rate": 0.01,
"date": "2024-10-17T00:00:00.000Z"
}
]
```
## Get currency exchange rate for a certain period
Getting the list of the array with currency rate for a certain period of time.
### Request
=== "Shell"
=== "Curl"
```bash
curl --request GET \
--url https://kekkai-api.redume.su/api/getRate/?from_currency=RUB&conv_currency=USD&start_date=2024-10-16&end_date=2024-10-20
```
=== "Python"
=== "Requests"
```py
import requests
res = requests.get('https://kekkai-api.redume.su/api/getRate/', {
'from_currency': 'RUB',
'conv_currency': 'USD',
'start_date': '2024-10-16',
'end_date': '2024-10-20',
}, timeout=3)
print(res.json())
```
=== "Node.JS"
=== "Axios"
```js
const axios = require('axios');
axios.get('https://kekkai-api.redume.su/api/getRate/', {
timeout: 3000,
'from_currency': 'RUB',
'conv_currency': 'USD',
'start_date': '2024-10-16',
'end_date': '2024-10-20',
}
)
.then((res) => {
console.log(res['data']);
})
.catch((err) => {
console.error(err);
});
```
### Query params
| Parameter | Description |
|---------------|-------------------------------------------------------------------------|
| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place |
| `conv_currency` | `ISO 4217` code of the currency to which the conversion is performed |
| `start_date` | Start date of the period in the format `YYYYY-DD-MM` |
| `end_date` | Period end date in the format `YYYYY-DD-MM` |
### Response
!!! info "Output"
```json
[
{
"from_currency": "RUB",
"conv_currency": "USD",
"rate": 0.01,
"date": "2024-10-17T00:00:00.000Z"
},
{
"from_currency": "RUB",
"conv_currency": "USD",
"rate": 0.01,
"date": "2024-10-18T00:00:00.000Z"
},
{
"from_currency": "RUB",
"conv_currency": "USD",
"rate": 0.01,
"date": "2024-10-19T00:00:00.000Z"
},
{
"from_currency": "RUB",
"conv_currency": "USD",
"rate": 0.01,
"date": "2024-10-20T00:00:00.000Z"
},
{
"from_currency": "RUB",
"conv_currency": "USD",
"rate": 0.01,
"date": "2024-10-21T00:00:00.000Z"
}
]
```