From 76a064daeb35d392bc4282be40c30b2bd6bda0a8 Mon Sep 17 00:00:00 2001 From: Redume Date: Mon, 18 Nov 2024 12:58:58 +0300 Subject: [PATCH] docs: create endopint list --- docs/endpoints/list-endpoints.md | 16 ++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 17 insertions(+) create mode 100644 docs/endpoints/list-endpoints.md diff --git a/docs/endpoints/list-endpoints.md b/docs/endpoints/list-endpoints.md new file mode 100644 index 0000000..ccaeb26 --- /dev/null +++ b/docs/endpoints/list-endpoints.md @@ -0,0 +1,16 @@ +## API Base URL +All requests to our API should be directed to the URL below: + +``` +https://kekkai-api.redume.su/api/ +``` + + +## API Endpoints +Kekkai has 3 API endpoints: `getRate`, `getChart` and `configurations`. 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-api.redume.su/api/getRate/` | Get currency exchange rate for a specific day or period | +| Create Chart | `https://kekkai-api.redume.su/api/getChart` | Creating a chart with exchange rate | +| Get Config | `https://kekkai-api.redume.su/api/configurations/json` | Get instance config file | \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 0bd4930..c8a5a03 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,6 +15,7 @@ nav: - Manual: getting-started/manual.md - Contributing: getting-started/contributing.md - Endpoints: + - Endpoints list: endpoints/list-endpoints.md - Get currency rate - /api/getRate: endpoints/get-rate.md - Create Charts - /api/getChart: endpoints/create-chart.md - Config: