diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index b7c3e19..552b24b 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -33,6 +33,10 @@ export default defineConfig({ label: 'Get currency rate - /api/getRate', slug: 'docs/endpoints/getrate' }, + { + label: 'Create Charts - /api/getChart', + slug: 'docs/endpoints/create-chart' + }, ], }, ], diff --git a/docs/src/content/docs/docs/endpoints/create-chart.mdx b/docs/src/content/docs/docs/endpoints/create-chart.mdx new file mode 100644 index 0000000..a14063f --- /dev/null +++ b/docs/src/content/docs/docs/endpoints/create-chart.mdx @@ -0,0 +1,172 @@ +--- +title: Create Charts - /api/getChart +--- + +Creating a currency rate chart. + +import { Tabs, TabItem, Aside } from '@astrojs/starlight/components'; + + +## Creating a graph for a certain period +### Request + + + + + +```shell +curl --request GET --url https://kekkai-api.redume.su/api/getChart/week?from_currency=RUB&conv_currency=USD +``` + + + + + + +```python +import requests + +res = requests.get('https://kekkai-api.redume.su/api/getChart/week', { + 'from_currency': 'USD', + 'conv_currency': 'RUB', +}, timeout=3) + +print(res.json()) +``` + + + + + + +```javascript +const axios = require('axios'); + +axios.get('https://kekkai-api.redume.su/api/getChart/week', { + timeout: 3000, + 'from_currency': 'USD', + 'conv_currency': 'RUB', +}) + .then((res) => { + console.log(res['data']); + }) + .catch((err) => { + console.error(err); + }); +``` + + + + + + + +### Query params +| 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 | + +### URL params +| Parameter | Description | +|---------------|-------------------------------------------------------------------------| +| `period` | Available parameters: `week`, `month`, `quarter`, `year` | + +`*` - Required arguments + +### Response + + + +## Creating a schedule for specific days +### Request + + + + + +```shell +curl --request GET --url https://kekkai-api.redume.su/api/getChart/?from_currency=RUB&conv_currency=USD&start_date=2024-10-31&end_date=2024-11-08 +``` + + + + + + +```python +import requests + +res = requests.get('https://kekkai-api.redume.su/api/getChart/', { + 'from_currency': 'USD', + 'conv_currency': 'RUB', + 'start_date': '2024-10-31', + 'end_date': '2024-11-08' +}, timeout=3) + +print(res.json()) +``` + + + + + + +```javascript +const axios = require('axios'); + +axios.get('https://kekkai-api.redume.su/api/getChart/', { + timeout: 3000, + 'from_currency': 'USD', + 'conv_currency': 'RUB', + 'start_date': '2024-10-31', + 'end_date': '2024-11-08' +}) + .then((res) => { + console.log(res['data']); + }) + .catch((err) => { + console.error(err); + }); +``` + + + + + +### Query params +| 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 + + + +## What the name of the chart file consists of +Example: ``.../RUB_USD_20241108_DQVDN7.png`` + +- `RUB_USD` - Name of currencies. +- `20241108` - Schedule request date in `YYYMMDD` format. +- `DQVDN7` - Random file character identifier. + +All charts are in the charts folder, which is in the root directory (`/chart`) \ No newline at end of file