Redume/Kekkai
1
0
Fork 0
mirror of https://github.com/Redume/Kekkai.git synced 2025-03-13 03:54:37 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Wrote a page about getting currency

Browse source
This commit is contained in:
Данил 2025-02-25 17:14:11 +03:00
parent ac52635834
commit 6269512daa
2 changed files with 204 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/astro.config.mjs
View file

@ -28,7 +28,11 @@ export default defineConfig({
items: [
{
label: 'Endpoints list', slug: 'docs/endpoints/endpoints-list'
}
},
{
label: 'Get currency rate - /api/getRate',
slug: 'docs/endpoints/getrate'
},
],
},
],

199
docs/src/content/docs/docs/endpoints/getrate.mdx Normal file
View file

@ -0,0 +1,199 @@
---
title: Get currency rate - /api/getRate
---
Currencies are identified by standard three-letter `ISO 4217` codes.
import { Tabs, TabItem, Aside } from '@astrojs/starlight/components';
## Getting the currency rate for a certain day.
### Request
<Tabs>
<TabItem label='Shell'>
<Tabs>
<TabItem label='curl'>
```shell
curl --request GET --url https://kekkai-api.redume.su/api/getRate/?from_currency=RUB&conv_currency=USD&date=2024-10-16
```
</TabItem>
</Tabs>
</TabItem>
<TabItem label='Python'>
<Tabs>
<TabItem label='requests'>
```python
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())
```
</TabItem>
</Tabs>
</TabItem>
<TabItem label='Node.JS'>
<Tabs>
<TabItem label='axios'>
```javascript
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);
});
```
</TabItem>
</Tabs>
</TabItem>
</Tabs>
### 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` |
| `conv_amount` | Multiplier for number conversion (Optional) |
`*` - Required arguments
### Response
<Aside title='Output'>
```json
[
{
"from_currency": "RUB",
"conv_currency": "USD",
"rate": 0.01,
"date": "2024-10-17T00:00:00.000Z"
}
]
```
</Aside>
## Get currency exchange rate for a certain period
Getting the list of the array with currency rate for a certain period of time.
### Request
<Tabs>
<TabItem label='Shell'>
<Tabs>
<TabItem label='curl'>
```shell
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
```
</TabItem>
</Tabs>
</TabItem>
<TabItem label='Python'>
<Tabs>
<TabItem label='requests'>
```python
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())
```
</TabItem>
</Tabs>
</TabItem>
<TabItem label='Node.JS'>
<Tabs>
<TabItem label='axios'>
```javascript
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(JSON.stringify(res.json()));
})
.catch((err) => {
console.error(err);
});
```
</TabItem>
</Tabs>
</TabItem>
</Tabs>
### 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 |
| `start_date`* | Start date of the period in the format `YYYYY-DD-MM` |
| `end_date`* | Period end date in the format `YYYYY-DD-MM` |
`*` - Required arguments
### Response
<Aside title='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"
}
]
```
</Aside>