Currency Bot API

Эта документация показывает основные методы API для телеграм-бота Currency trading simulator. Документация содержит описание всех доступных методов с их подробным описанием и документацией.

Base URI

https://d5detadf1prvd301k0p5.apigw.yandexcloud.net
Выводит валюту и ее отношение к основным валютам
GET /get_rates/{currency_code}

Этот запрос приводит к списку основных валют и их отношение к той валюте, которую запросили. Информация берется из внешнего API на основе самых новых данных.

Path variables

currency_code
string required

Дефолтнное значение: USD. Формат: XXX.

Responses

200 200

Данные о валюте получены

400 default

Ошибка запроса

Пример использования

Попробуем узнать о рубле сегодня

https://d5detadf1prvd301k0p5.apigw.yandexcloud.net/get_rates/USD
Выводит сравнение двух валют
GET /compare_currencies/{currency_code1}-{currency_code2}

Этот запррос дает возможность сравнить две валюты друг с другом на основе самых последних данных.

Path variables

currency_code1
string required

Дефолтнное значение: USD. Формат: XXX.

currency_code2
string required

Дефолтнное значение: RUB. Формат: XXX.

Responses

200 200

Данные о валютах получены

400 default

Ошибка запроса

Пример использования

Попробуем сравнить юань с австралийским долларом

https://d5detadf1prvd301k0p5.apigw.yandexcloud.net/compare_currencies/JPY-AUD
Показывает валюту и ее отношение к другим валютам в опредененный день
GET /currency_on_date/{currency_code}-{date}

Этот метод во многом копирует первый, но дает возможность настроить дату отображения валюты. В этом методе можно получить исторические данные об отношении выбранной валюты к другим в определенный год, день и месяц.

Path variables

currency_code
string required

Дефолтнное значение: USD. Формат: XXX.

date
string required

Дефолтного значения нет. Формат: YYYY-MM-DD

Responses

200 200

Данные о валюте получены

Пример использования

Попробуем узнать отношение рубля к популярным валютам на 1 января, 2023

https://d5detadf1prvd301k0p5.apigw.yandexcloud.net/currency_on_date/RUB-2023-01-01
Выводит сравнение двух валют в определенный день
GET /compare_currencies_on_date/{currency_code1}-{currency_code2}-{date}

Этот метод позволит узнать о том, каково было отношение одной валюты к другой в определенный день.

Path variables

currency_code1
string required

Дефолтнное значение: USD. Формат: XXX.

currency_code2
string required

Дефолтнное значение: RUB. Формат: XXX.

date
string required

Дефолтного значения нет. Формат: YYYY-MM-DD

Responses

200 200

Данные о валюте получены

Пример использования

А какого было отношения рубля к юаню 1 января 2023?

https://d5detadf1prvd301k0p5.apigw.yandexcloud.net/compare_currencies_on_date/RUB-JPY-2023-01-01
Рисует график отображающий историческое изменение значения конкретной валюты
GET /create_plot/{currency_code}

Этот метод позволит узнать об изменении валюты за прошедщий год. График выводится в виде png и на основе него могут приниматься решения об инвестировании в определенную валюту.

Path variables

currency_code
string required

Дефолтнное значение: USD. Формат: XXX.

Responses

200 200

Данные о валюте получены

Пример использования

Попробуем отобразить график евро

https://d5detadf1prvd301k0p5.apigw.yandexcloud.net/create_plot/EUR
Сохраняет данные о сделке коды валют количество тип операции
POST /transaction_details/{userID}-{currency_code}-{amount}-{operation_type}

Этот метод позволяет записать данные о сделках пользователей в базу данных для дальшейшего анализа и интерпретации.

Path variables

userID
string required

ID пользователя, формируется на основе ника в Телеграм

currency_code
string required

Дефолтнное значение: USD. Формат: XXX.

amount
integer required

Количество валют, заполняется пользователем.

operation_type
boolean required

Тип сделки: купить (0) или продать (1). Заполняется пользователем.

Responses

200 200

Данные о валюте получены

Рисует график отображающий будущее изменение значения валюты
GET /get_prediction_line/{currency_code}

Этот метод позволяет получить данные о будущем значении валюты. CI 95%.

Path variables

currency_code
string required

Дефолтнное значение: USD. Формат: XXX.

Responses

200 200

Данные о валюте получены

Пример использования
https://d5detadf1prvd301k0p5.apigw.yandexcloud.net/get_prediction_line/RUB
Дает информацию о полном и коротком названии валюты в определнной стране
GET /country_currency/{country}

Этот метод удобен тем, что обычно пользователи не всегда понимают, какая валюта в какой стране. А если мы ориентируемся также и на неопытных трейдеров, то надо учитывать, что они могут не знать сокращения валют.

Path variables

country
string required

Название страны на английской. По дефолту Раша.

Responses

200 200

Данные о валюте получены

Пример использования
https://d5detadf1prvd301k0p5.apigw.yandexcloud.net/country_currency/Russia
Operations
Last Import