docs: endpoints list page

This commit is contained in:
Данил 2025-02-24 20:21:15 +03:00
parent fe8959577c
commit 9c9d0352c6
2 changed files with 29 additions and 0 deletions

View file

@ -23,6 +23,14 @@ export default defineConfig({
},
],
},
{
label: 'Endpoints',
items: [
{
label: 'Endpoints list', slug: 'docs/endpoints/endpoints-list'
}
],
},
],
}),
],

View file

@ -0,0 +1,21 @@
---
title: Endpoints list
---
## API Base URL
All requests to our API should be directed to the URL below:
```
https://kekkai.redume.su/api/
```
## API Endpoints
Kekkai has 3 API endpoints: `getRate`, `getChart` and `metadata`.
Below you will find a list of parameters that each endpoint requires and a description of what the API does.
| Service | API Endpoint | Description |
|--------------|------------------------------------------|---------------------------------------------------------------------------------------------|
| Get Rate | `https://kekkai.redume.su/api/getRate/` | Get currency exchange rate for a specific day or period |
| Create Chart | `https://kekkai.redume.su/api/getChart/` | Creating a chart with exchange rate |
| Metadata | `https://kekkai.redume.su/api/metadata/` | Shows the last and first dates of currency rate collection, as well as available currencies |