mirror of
https://github.com/Redume/Kekkai.git
synced 2025-03-13 12:04:38 +03:00
docs: endpoints list page
This commit is contained in:
parent
fe8959577c
commit
9c9d0352c6
2 changed files with 29 additions and 0 deletions
|
@ -23,6 +23,14 @@ export default defineConfig({
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
label: 'Endpoints',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'Endpoints list', slug: 'docs/endpoints/endpoints-list'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
},
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
|
|
21
docs/src/content/docs/docs/endpoints/endpoints-list.mdx
Normal file
21
docs/src/content/docs/docs/endpoints/endpoints-list.mdx
Normal 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 |
|
Loading…
Add table
Add a link
Reference in a new issue