API получения официального курса белорусского рубля по отношению к иностранным валютам, устанавливаемого Национальным банком Республики Беларусь
1. Полный перечень иностранных валют, по отношению к которым Национальным банком устанавливается официальный курс белорусского рубля:
Адрес запроса: https://www.nbrb.by/api/exrates/currencies[/{cur_id}]
Результат: Возвращает массив объектов класса Currency. Если указан cur_id, то возвращается один объект Currency.
Класс Currency содержит следующие свойства:
- Cur_ID – внутренний код
- Cur_ParentID – этот код используется для связи, при изменениях наименования, количества единиц к которому устанавливается курс белорусского рубля, буквенного, цифрового кодов и т.д. фактически одной и той же валюты*.
- Cur_Code – цифровой код
- Cur_Abbreviation – буквенный код
- Cur_Name – наименование валюты на русском языке
- Cur_Name_Bel – наименование на белорусском языке
- Cur_Name_Eng – наименование на английском языке
- Cur_QuotName – наименование валюты на русском языке, содержащее количество единиц
- Cur_QuotName_Bel – наименование на белорусском языке, содержащее количество единиц
- Cur_QuotName_Eng – наименование на английском языке, содержащее количество единиц
- Cur_NameMulti – наименование валюты на русском языке во множественном числе
- Cur_Name_BelMulti – наименование валюты на белорусском языке во множественном числе*
- Cur_Name_EngMulti – наименование на английском языке во множественном числе*
- Cur_Scale – количество единиц иностранной валюты
- Cur_Periodicity – периодичность установления курса (0 – ежедневно, 1 – ежемесячно)
- Cur_DateStart – дата включения валюты в перечень валют, к которым устанавливается официальный курс бел. рубля
- Cur_DateEnd – дата исключения валюты из перечня валют, к которым устанавливается официальный курс бел. рубля
Примеры использования:
- полный перечень валют: https://www.nbrb.by/api/exrates/currencies
- российский рубль с 01.07.2016: https://www.nbrb.by/api/exrates/currencies/298, до 01.07.2016: https://www.nbrb.by/api/exrates/currencies/190
2. Официальный курс белорусского рубля по отношению к иностранным валютам, устанавливаемый Национальным банком на конкретную дату:
Адрес запроса: https://www.nbrb.by/api/exrates/rates[/{cur_id}]
Параметры (GET):
- ondate** – дата, на которую запрашивается курс (если не задана, то возвращается курс на сегодня)
- periodicity – периодичность установления курса (0 – ежедневно, 1 – ежемесячно)
- parammode – формат аргумента cur_id: 0 – внутренний код валюты, 1 – трехзначный цифровой код валюты в соответствии со стандартом ИСО 4217, 2 – трехзначный буквенный код валюты (ИСО 4217). По умолчанию = 0
При использовании буквенного или цифрового кода валюты (ИСО 4217) учитывайте его значение на запрашиваемую дату.
Результат: Возвращает массив объектов класса Rate. Если указан cur_id, то возвращается один объект Rate.
Класс Rate содержит следующие свойства:
- Cur_ID – внутренний код
- Date – дата, на которую запрашивается курс
- Cur_Abbreviation – буквенный код
- Cur_Scale – количество единиц иностранной валюты
- Cur_Name – наименование валюты на русском языке во множественном, либо в единственном числе, в зависимости от количества единиц
- Cur_OfficialRate – курс*
Примеры использования:
- получение официального курса белорусского рубля по отношению к иностранным валютам, устанавливаемого ежедневно, на сегодня: https://www.nbrb.by/api/exrates/rates?periodicity=0
- получение официального курса белорусского рубля по отношению к иностранным валютам, устанавливаемого ежедневно, на 6 июля 2016 года: https://www.nbrb.by/api/exrates/rates?ondate=2016-7-6&periodicity=0
- получение официального курса белорусского рубля по отношению к иностранным валютам, устанавливаемого ежемесячно, на 1 июля 2016 года: https://www.nbrb.by/api/exrates/rates?ondate=2016-7-1&periodicity=1
- получение официального курса белорусского рубля по отношению к 1 Доллару США на сегодня: https://www.nbrb.by/api/exrates/rates/145
– по внутреннему коду валюты
https://www.nbrb.by/api/exrates/rates/840?parammode=1 – по цифровому коду валюты (ИСО 4217)
https://www.nbrb.by/api/exrates/rates/USD?parammode=2 – по буквенному коду валюты (ИСО 4217) - получение официального курса белорусского рубля по отношению к 100 Российским рублям на 5 июля 2016 года: https://www.nbrb.by/api/exrates/rates/298?ondate=2016-7-5
3. Получение динамики официального курса белорусского рубля по отношению к заданной иностранной валюте (не более чем за 365 дней):
Адрес запроса: https://www.nbrb.by/api/exrates/rates/dynamics/{cur_id}
Параметры (GET):
- startdate** – дата начала запрашиваемого периода
- enddate** – дата окончания запрашиваемого периода
Результат: Возвращает массив объектов класса RateShort.
Класс RateShort содержит следующие свойства:
- Cur_ID – внутренний код
- Date – дата, на которую запрашивается курс
- Cur_OfficialRate – курс*
Примеры использования:
Примечание. Если в любой из перечисленных методов передается неверный код валюты, то возвращается 404 ошибка. Если на запрашиваемую дату курс не установлен, возвращается пустой массив.
Классы для разработки приложений на C#.
Пример использования API (на javascript)
* Поле может принимать пустое значение (null).
** Полный перечень поддерживаемых форматов дат можно найти по адресу: https://msdn.microsoft.com/ru-ru/library/az4se3k1(v=vs.110).aspx
Ваши замечания и предложения по работе API просьба направлять на адрес: email@nbrb.by.