diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 7e25d5f..b7c3e19 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -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' + }, ], }, ], diff --git a/docs/src/content/docs/docs/endpoints/endpoints-list.mdx b/docs/src/content/docs/docs/endpoints/endpoints-list.mdx index df0724b..07775c4 100644 --- a/docs/src/content/docs/docs/endpoints/endpoints-list.mdx +++ b/docs/src/content/docs/docs/endpoints/endpoints-list.mdx @@ -14,8 +14,8 @@ https://kekkai.redume.su/api/ 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 | \ No newline at end of file +| 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 | +| Metadata | `https://kekkai-api.redume.su/api/metadata/` | Shows the last and first dates of currency rate collection, as well as available currencies | \ No newline at end of file diff --git a/docs/src/content/docs/docs/endpoints/getrate.mdx b/docs/src/content/docs/docs/endpoints/getrate.mdx new file mode 100644 index 0000000..860f6a7 --- /dev/null +++ b/docs/src/content/docs/docs/endpoints/getrate.mdx @@ -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 + + + + + +```shell +curl --request GET --url https://kekkai-api.redume.su/api/getRate/?from_currency=RUB&conv_currency=USD&date=2024-10-16 +``` + + + + + + +```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()) +``` + + + + + + +```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); + }); +``` + + + + + +### 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 + + + + +## Get currency exchange rate for a certain period +Getting the list of the array with currency rate for a certain period of time. + + +### Request + + + + +```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 +``` + + + + + + +```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()) +``` + + + + + + +```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); + }); +``` + + + + + +### 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 + diff --git a/docs/src/content/docs/docs/getting-started/docker.mdx b/docs/src/content/docs/docs/getting-started/docker.mdx index fac92c2..7e67709 100644 --- a/docs/src/content/docs/docs/getting-started/docker.mdx +++ b/docs/src/content/docs/docs/getting-started/docker.mdx @@ -7,9 +7,7 @@ Below are the steps to deploy Kekkai with Docker Compose. Kekkai requires Docker Compose version 2.x. -import { Steps } from '@astrojs/starlight/components'; -import { Code } from '@astrojs/starlight/components'; - +import { Steps, Code } from '@astrojs/starlight/components'; 1. Preparing files