GET

8.12.0

Описание

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

Поддерживаемые рынки

  • ✅ Spot (спот)

  • ✅ Futures (фьючерсы)

Алиасы

Нет

Синтаксис

action=get;value=VALUE[;дополнительные_параметры]

Сокращенная запись:

get=VALUE[;дополнительные_параметры]

Обязательные параметры

value

Тип запрашиваемой информации

value=BALANCE      # баланс аккаунта
value=SYMPRICE     # цена торгового инструмента
value=OPENPOS      # открытые позиции

Типы запросов

Информация об аккаунте

BALANCE - баланс аккаунта

action=get;value=BALANCE;mktype=spot

RESTRICTIONS - ограничения API ключа

action=get;value=RESTRICTIONS;mktype=futures

TRADEFEE - торговые комиссии

action=get;value=TRADEFEE;symbol=BTCUSDT;mktype=spot

Информация о рынке

PRICE - текущая цена инструмента

action=get;value=PRICE;symbol=BTCUSDT;mktype=spot

Обязательный параметр: symbol.

SYMINFO - информация о торговом инструменте

action=get;value=SYMINFO;symbol=ETHUSDT;mktype=futures

SYMLIST - список торговых инструментов

action=get;value=SYMLIST;mktype=spot

Позиции (только futures)

POSITIONS - открытые позиции

action=get;value=POSITIONS;symbol=BTCUSDT;mktype=futures

Если параметр symbol не задан, будут возвращены позиции по всем доступным символам.

Ордера

ORDERS - открытые ордера

action=get;value=ORDERS;symbol=ETHUSDT;mktype=spot

Если параметр symbol не задан, будут возвращены ордера по всем доступным символам.

ORDERSTATUS - статус конкретного ордера

action=get;value=ORDERSTATUS;symbol=BTCUSDT;orderid=123456;mktype=spot
action=get;value=ORDERSTATUS;symbol=BTCUSDT;clientorderid=abc-123;mktype=spot

Обязательный параметр: symbol. Опциональный параметр: либо номер ордера orderid, либо идентификатор clientorderid.

История торговли

TRADELIST - история сделок

action=get;value=TRADELIST;symbol=ADAUSDT;mktype=futures

TRANSFERLOG - история переводов

action=get;value=TRANSFERLOG;mktype=spot

Расчетные функции

QUQTY - конвертация в квотовое количество

action=get;value=QUQTY;qty=100;price=50000;mktype=spot

FILTERQTY - фильтрация количества по правилам биржи

action=get;value=FILTERQTY;qty=0.123456;symbol=BTCUSDT;mktype=spot

PROCTOQTY - процент от баланса в количество

action=get;value=PROCTOQTY;pro=50;symbol=ETHUSDT;mktype=futures

PRICEPRO - цена по проценту от базовой цены

action=get;value=PRICEPRO;price=3000;pricepro=5;mktype=futures

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

Получение баланса

action=get;value=BALANCE;mktype=spot
get=BALANCE;mktype=futures

Получение цены Bitcoin

action=get;value=PRICE;symbol=BTCUSDT;mktype=spot
get=PRICE;symbol=BTCUSDT;mktype=futures

Обязательный параметр: symbol.

Проверка открытых позиций

get=POSITIONS;symbol=BTCUSDT;mktype=futures

Если параметр symbol не задан, будут возвращены позиции по всем доступным символам.

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

get=SYMINFO;symbol=ETHUSDT;mktype=spot

История торговли за период

get=TRADELIST;symbol=ADAUSDT;starttime=1640995200000;endtime=1641081600000;mktype=futures

Особенности

Сокращенная запись Вместо action=get;value=BALANCE можно использовать get=BALANCE

Требования к параметрам Некоторые запросы требуют дополнительных параметров (symbol, orderid и т.д.)

Универсальность Единый интерфейс для получения любой доступной информации

Кэширование и ключ rest! Для запросов BALANCE, ORDERS и POSITIONS можно использовать ключ rest!. Если он указан, данные будут запрошены напрямую с биржи, минуя локальный кэш состояния. Это позволяет получить максимально актуальную информацию.

Результат выполнения

Возвращает запрашиваемую информацию в структурированном виде. Формат ответа зависит от типа запроса.

Связанные экшены

  • SET - установка параметров

  • NEWORDER - создание ордеров с использованием полученных данных | TRANSFERLOG | Получение истории трансферов между рынками внутри аккаунта |

RESTRICTIONS

get=restrictions;mktype=spot

PRICE

get=PRICE;symbol=BTCUSDT;mktype=spot

Обязательный параметр: symbol.

TRADEFEE

get=tradefee;symbol=BTCUSDT;mktype=spot

BALANCE

get=balance;mktype=spot;rest!

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

PreviousTURNOVERNextSET

Last updated