Программный сервис взаимодействия (API)

API предназначен для взимодействия BlackTerminal.ru с другими web-сайтами и приложениями. С помощью API можно получить информацию, имеющуюся в базе данных BlackTerminal.ru.

API находится по адресу: https://blackterminal.ru/api/0.0.8

Все запросы производятся путем отправки данных в формате json методом POST.
Ответы сервера приходят в формате JSON в кодировке utf8.
Для работы с API требуется ключ приложения. Получить ключ можно направив запрос на адрес электронной почты support@blackterminal.com
Для настройки и тестирования API можно использовать ключ TEST

Ниже приведен перечень информации, которую можно получить при помощи API


Получение списка эмитентов

Отправить POST-запрос с параметрами ("getemlist", "key"), где:
getemlist - флаг (может быть пустым)
варианты ответа:
Успех - <emitters_list> - json-кодированная информация об эмитентах
curl --header "Content-Type: application/json" --request POST --data '{"getemlist":"flag","key":"TEST"}' https://blackterminal.ru/api/0.0.8

Получение списка акций

Отправить POST-запрос с параметрами ("getsharelist", "key"), где:
getsharelist - флаг (может быть пустым)
варианты ответа:
Успех - <shares_list> - json-кодированная строка со спиком акций
curl --header "Content-Type: application/json" --request POST --data '{"getsharelist":"flag","key":"TEST"}' https://blackterminal.ru/api/0.0.8

Получение информации об эмитенте

Отправить POST-запрос с параметрами ("getemitent", "eid", "key"), где:
getemitent - флаг (может быть пустым)
eid - emitent id (id эмитента)
варианты ответа:
Успех - <emitent> - json-кодированная информация об эмитенте
Эмитент не найден - "emitent_not_found"
curl --header "Content-Type: application/json" --request POST --data '{"getemitent":"flag","eid":"1243","key":"TEST"}' https://blackterminal.ru/api/0.0.8

Получение информации об акции

Отправить POST-запрос с параметрами ("getshare", "id", "key"), где:
getshare - флаг (может быть пустым)
id - код акции (например, GAZP)
варианты ответа:
Успех - <share> - json-кодированная информация об акции
Акция не найдена - "share_not_found"
curl --header "Content-Type: application/json" --request POST --data '{"getshare":"flag","id":"GAZP","key":"TEST"}' https://blackterminal.ru/api/0.0.8

Получение списка новостей

Отправить POST-запрос с параметрами ("getnewsfeed", "key"), где:
getnewsfeed - флаг (может быть пустым)
варианты ответа:
Успех - объект {"last_id":"id последней новости","news_array":[]}
curl --header "Content-Type: application/json" --request POST --data '{"getnewsfeed":"flag","key":"YOUR_KEY"}' https://blackterminal.ru/api/0.0.8

Использование параметров offset, id
Параметр offset служит для указания направления "листания" списка новостей, может принимать значения before и after чтобы получать более "старые" и "новые" новости соответственно. Используется совместно с параметром id (id новости) который указывает, относительно какой новости двигаться по списку во время "листания".

Параметр count (опциональный) указывает, сколько новостей выводить в массиве news_array. Может принимать значения от 0 до 100. Значение по умолчанию - 10.
curl --header "Content-Type: application/json" --request POST --data '{"getnewsfeed":"flag","count":10,"offset":"after","id":"5d3ff14961618961e3638690","key":"YOUR_KEY"}' https://blackterminal.ru/api/0.0.8