mirror of
https://github.com/Redume/Kekkai.git
synced 2025-03-13 03:54:37 +03:00
docs: create metadata page
This commit is contained in:
parent
7de6cf13d3
commit
5a1043e7e6
2 changed files with 84 additions and 1 deletions
|
@ -34,9 +34,13 @@ export default defineConfig({
|
|||
slug: 'docs/endpoints/getrate'
|
||||
},
|
||||
{
|
||||
label: 'Create Charts - /api/getChart',
|
||||
label: 'Create charts - /api/getChart',
|
||||
slug: 'docs/endpoints/create-chart'
|
||||
},
|
||||
{
|
||||
label: 'Get metadata - /api/metadata',
|
||||
slug: 'docs/endpoints/metadata'
|
||||
}
|
||||
],
|
||||
},
|
||||
],
|
||||
|
|
79
docs/src/content/docs/docs/endpoints/metadata.mdx
Normal file
79
docs/src/content/docs/docs/endpoints/metadata.mdx
Normal file
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
title: Get metadata - /api/metadata
|
||||
---
|
||||
|
||||
Currencies are identified by standard three-letter `ISO 4217` currency codes.
|
||||
|
||||
import { Tabs, TabItem, Aside } from '@astrojs/starlight/components';
|
||||
|
||||
## Get data on available dates and currencies.
|
||||
### Request
|
||||
|
||||
<Tabs>
|
||||
<TabItem label='Shell'>
|
||||
<Tabs>
|
||||
<TabItem label='curl'>
|
||||
```shell
|
||||
curl --request GET --url https://kekkai-api.redume.su/api/metadata/
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</TabItem>
|
||||
<TabItem label='Python'>
|
||||
<Tabs>
|
||||
<TabItem label='requests'>
|
||||
```python
|
||||
import requests
|
||||
|
||||
res = requests.get('https://kekkai-api.redume.su/api/metadata/', 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/metadata/')
|
||||
.then((res) => {
|
||||
console.log(JSON.stringify(res.json()));
|
||||
})
|
||||
.catch((err) => {
|
||||
console.error(err);
|
||||
});
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Response
|
||||
|
||||
<Aside title='Output'>
|
||||
```json
|
||||
{
|
||||
"first_date": "2024-11-26T21:00:00.000Z",
|
||||
"last_date": "2025-01-01T21:00:00.000Z",
|
||||
"currencies": {
|
||||
"crypto": [
|
||||
"USDT",
|
||||
"TON",
|
||||
"BTC",
|
||||
"ETH"
|
||||
],
|
||||
"fiat": [
|
||||
"USD",
|
||||
"RUB",
|
||||
"EUR",
|
||||
"UAH",
|
||||
"TRY",
|
||||
"KZT"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
</Aside>
|
Loading…
Add table
Add a link
Reference in a new issue