Перейти до вмісту
Spectre Docs
ПосібникРозробникам
Довідник SDK

Типи TypeScript

Типи відповідей, запитів і кадрів стріму.

Decimal

type Decimal = string

Десяткове число так, як його надсилає термінал: "67000.10" лишається "67000.10". Ніколи не перетворюйте його через Number() — для арифметики візьміть бібліотеку десяткових чисел.

Timestamp

type Timestamp = number

Мілісекунди UTC від початку епохи, ціле число.

InstrumentAddress

type InstrumentAddress = string

Адреса інструмента: exchange:market:symbol, біржа малими літерами.

Side

type Side = "buy" | "sell"

Сторона угоди.

Scope

type Scope = "market:read" | "connections:read" | "account:read" | "trading:write" | OpenString

Права токена, відомі v1. У межах v1 можуть з’являтися нові права.

MarketTopic

type MarketTopic = "trades" | "ticker" | "mark_price" | "book.top" | "clusters"

Ринкові топіки: під час підписки instrument обов’язковий, connection_id вибирається за загальним правилом.

AccountTopic

type AccountTopic = "account.orders" | "account.positions" | "account.balances" | "account.fills"

Топіки рахунку: під час підписки connection_id обов’язковий, instrument не використовується.

TerminalTopic

type TerminalTopic = "workspace" | "settings"

Власні топіки термінала: один на термінал, підписка без інструмента й підключення.

WorkspaceTopic

type WorkspaceTopic = "workspace"

Topic

type Topic = MarketTopic | AccountTopic | TerminalTopic

Топіки стріму, відомі v1.

ErrorCode

type ErrorCode = | "unauthorized"
  | "forbidden"
  | "forbidden_scope"
  | "not_found"
  | "invalid_request"
  | "unsupported"
  | "not_active"
  | "rate_limited"
  | "not_tradable"
  | "unavailable"
  | OpenString

Коди помилок контракту. У межах v1 можуть з’являтися нові коди.

ConnectionState

type ConnectionState = "disabled" | "enabled" | "connecting" | "connected" | "failed"

status.state підключення.

OrderType

type OrderType = "limit" | "market"

Тип заявки: limit потребує ціни, market її не приймає.

OrderStatus

type OrderStatus = "pending" | "open" | "partially_filled"

Статус відкритої заявки.

TriggerType

type TriggerType = "stop_loss" | "take_profit" | "stop"

Вид тригерної заявки.

TriggerRule

type TriggerRule = "price_above_or_equal" | "price_below_or_equal"

Коли спрацьовує тригер.

TriggerStatus

type TriggerStatus = "open" | "finished" | "inactive" | "invalid"

Статус тригерної заявки.

PositionSide

type PositionSide = "long" | "short"

Сторона позиції.

TimeInForce

type TimeInForce = "gtc" | "ioc" | "fok" | "post_only"

Строк дії поставленої заявки; відсутній — типове значення біржі.

ErrorEnvelope

Конверт помилки, який містить кожна відповідь не 2xx.

ПолеТипОпис
error{ code: ErrorCode; message: string; }

List

Списки загортаються в { data: [...] }.

ПолеТипОпис
dataT[]

Limits

Ліміти, які друкує /v1/meta.

ПолеТипОпис
ws_connections_per_tokennumber
subscriptions_per_connectionnumber
api_only_instrumentsnumber
exchange_subscriptions_per_secondnumber
commands_per_secondнеобов’язковийnumberТоргових команд на секунду на листенер. Відсутній у терміналах, старших за етап запису Local API.
workspace_commands_per_secondнеобов’язковийnumberКоманд робочого простору на секунду на листенер. Відсутній до етапу «Вікно».
settings_commands_per_secondнеобов’язковийnumberЗаписів налаштувань на секунду на листенер. Відсутній до етапу «Налаштування».

Meta

GET /v1/meta.

ПолеТипОпис
api_versionstring"1" для цього контракту.
app_versionstring
build_hashstring
build_envstring
featuresstringУвімкнені можливості збірки одним рядком.
scopesScope[]Права, надані токену, яким зроблено запит.
limitsLimits
topicsTopic[]Порожній, якщо термінал зібрано без відводу ринкових даних.

Health

GET /v1/health.

ПолеТипОпис
statusstring
uptime_msnumber
clientsnumberВідкриті з’єднання стріму.
streamsnumberПари, які тримає хаб.
api_only_instrumentsnumberПари, відкриті лише для API.
dropped_eventsnumberПодії, які хаб не прийняв із циклу ринкових даних.
dropped_framesnumberКадри, які не вмістилися в черги клієнтів.
overflow_closesnumberКлієнти, закриті з кодом 4008.
stream_availablebooleanfalse, якщо збірка не має відводу ринкових даних.

ConnectionEvent

Останній запис історії підключення.

ПолеТипОпис
codestringКод із тієї самої стрічки, яку показує Settings App.
tsTimestamp

ConnectionStatus

Статус підключення, виведений із перемикача і стрічки історії.

ПолеТипОпис
stateConnectionState
last_eventнеобов’язковийConnectionEventВідсутній, якщо в цій сесії підключення не має записів історії.

Connection

Підключення термінала. Не містить секретів: ні ключів, ні адреси, ні маски.

ПолеТипОпис
idnumber
exchangestringНазва біржі малими літерами, як в адресах інструментів.
marketstringspot, futures, …
labelstring
enabledboolean
read_onlybooleanПідключення без облікових даних, створене терміналом для ринкових даних.
has_credentialsboolean
proxy_boundboolean
statusConnectionStatus

Instrument

Інструмент із довідника біржі.

ПолеТипОпис
instrumentInstrumentAddress
exchangestring
marketstring
symbolstring
basestring
quotestring
statusstringЯк повідомила біржа: active, inactive, …
tick_sizeDecimal | nullnull, якщо біржа його не повідомила.
lot_sizeDecimal | null
min_sizeDecimal | null
contract_valueDecimal | null

InstrumentsPage

Одна сторінка GET /v1/instruments.

ПолеТипОпис
exchangestring
marketstring
dataInstrument[]
next_cursorstring | nullПередається як cursor для наступної сторінки; на останній сторінці — null.

Candle

Свічка; ts — час відкриття бара, volume — у базовій монеті.

ПолеТипОпис
tsTimestamp
openDecimal
highDecimal
lowDecimal
closeDecimal
volumeDecimal
quote_volumeDecimal
closedboolean

Candles

GET /v1/market/candles.

ПолеТипОпис
instrumentInstrumentAddress
connection_idnumber
intervalstring
dataCandle[]

Interval

Інтервал, який знає термінал; duration_ms — номінальна тривалість (30 днів для 1M).

ПолеТипОпис
idstring
duration_msnumber

Intervals

GET /v1/market/intervals.

ПолеТипОпис
candlesInterval[]
clustersInterval[]

Trade

Угода. ts — момент, коли вона пройшла через термінал.

ПолеТипОпис
idstring | nullІдентифікатор угоди на біржі; у v1 завжди null.
priceDecimal
qtyDecimal
sideSide
tsTimestamp
exchange_tsTimestamp

Trades

GET /v1/market/trades, від старих до нових.

ПолеТипОпис
instrumentInstrumentAddress
connection_idnumber
dataTrade[]

Level

type Level = [price: Decimal, size: Decimal]

Рівень стакана як [price, size].

Ticker

24-годинний тікер.

ПолеТипОпис
priceDecimal
change_24h_pctDecimal | null
volume_24hDecimal
high_24hDecimal | null
low_24hDecimal | null
best_bidDecimal | null
best_askDecimal | null
tsTimestamp

MarkPrice

Ціна маркування, data події mark_price.

ПолеТипОпис
mark_priceDecimal
tsTimestamp

Snapshot

GET /v1/market/snapshot: найсвіжіше, що хаб знає про пару.

ПолеТипОпис
instrumentInstrumentAddress
connection_idnumber
tsTimestamp
best_bidLevel | nullЗі стакана хаба; null, поки не надійшов знімок стакана.
best_askLevel | null
last_tradeTrade | null
mark_priceDecimal | null
tickerTicker | null

BookTop

Верх стакана: біди від найкращої ціни вниз, аски від найкращої вгору.

ПолеТипОпис
tsTimestamp
depthnumber
bidsLevel[]
asksLevel[]

Orderbook

interface Orderbook extends BookTop

GET /v1/market/orderbook.

ПолеТипОпис
instrumentInstrumentAddress
connection_idnumber

ClusterLevel

Один ціновий рівень бакета кластерів.

ПолеТипОпис
priceDecimal
volumeDecimal
buy_volumeDecimal
sell_volumeDecimal
buy_tradesnumber
sell_tradesnumber

ClusterBucket

Бакет кластерів; levels ідуть від найнижчої ціни до найвищої.

ПолеТипОпис
intervalstring
tsTimestampПочаток бакета.
end_tsTimestamp
volumeDecimal
buy_volumeDecimal
sell_volumeDecimal
tradesnumber
vwapDecimal | nullnull для бакета без угод.
min_priceDecimal | null
max_priceDecimal | null
completedboolean
last_trade_tsTimestamp0 для бакета з історії без часу угоди.
levelsClusterLevel[]

Clusters

GET /v1/market/clusters, від старих до нових, не більше десяти бакетів.

ПолеТипОпис
instrumentInstrumentAddress
connection_idnumber
intervalstringІнтервал, вибраний для інструмента в терміналі.
tsTimestamp
dataClusterBucket[]

Order

Відкрита заявка підключення.

ПолеТипОпис
keystring | nullКлюч заявки в терміналі (t-…); null, поки невідомий.
exchange_idstring | nullІдентифікатор заявки на біржі; null, поки невідомий.
instrumentInstrumentAddress
sideSide
typeOrderType
priceDecimal
sizeDecimalУ базовій монеті.
filledDecimal
remainingDecimal
notionalDecimal | nullСума у валюті котирування, яку ввів трейдер; null для заявки зі знімка біржі.
statusOrderStatus
created_tsTimestamp

TriggerOrder

Тригерна заявка (стоп-лос, тейк-профіт, стоп) підключення.

ПолеТипОпис
idstring
instrumentInstrumentAddress
typeTriggerType
trigger_priceDecimal
ruleTriggerRule
sizeDecimal | null
notionalDecimal | null
statusTriggerStatus
order_typestring | nullЗаявка, яка ставиться, коли тригер спрацьовує; null, якщо невідома.
client_idstring | null
created_tsTimestamp | null

AccountOrders

GET /v1/account/orders: відкриті заявки й тригерні заявки одного підключення.

ПолеТипОпис
connection_idnumber
dataOrder[]
triggersTriggerOrder[]

Position

Відкрита позиція.

ПолеТипОпис
instrumentInstrumentAddress
sidePositionSide
sizeDecimalУ базовій монеті; на MOEX — у лотах.
lot_sizeDecimalБазових одиниць в одному лоті.
entry_priceDecimal
notionalDecimalУ валюті котирування.
unrealized_pnlDecimalЯк рахує термінал.
mark_priceDecimal | nullЦіна маркування термінала: найкращий bid для лонга, найкращий ask для шорта; null до першого тика стакана.

AccountPositions

GET /v1/account/positions.

ПолеТипОпис
connection_idnumber
dataPosition[]

Balance

Останній баланс однієї валюти, як його повідомила біржа.

ПолеТипОпис
currencystring
totalDecimal
availableDecimal | nullnull, якщо біржа його не повідомляє.
lockedDecimal | null
tsTimestampЧас біржі, де він є, інакше — час отримання.

AccountBalances

GET /v1/account/balances: валюти, які змінилися відтоді, як увімкнено API.

ПолеТипОпис
connection_idnumber
dataBalance[]

Fill

Виконання власної заявки підключення.

ПолеТипОпис
trade_idstring
order_idstring
instrumentInstrumentAddress
sideSide
priceDecimal
qtyDecimal
feeDecimal
fee_currencystring
position_sidePositionSide | nulllong / short на біржах із режимом хеджування, інакше — null.
tsTimestamp

AccountFills

GET /v1/account/fills, від старих до нових.

ПолеТипОпис
connection_idnumber
dataFill[]

PlaceOrderRequest

Тіло POST /v1/orders, як воно надсилається.

ПолеТипОпис
connection_idnumber
instrumentInstrumentAddress
sideSide
typeOrderType
priceнеобов’язковийDecimalОбов’язкова для limit, відсутня для market.
sizeнеобов’язковийDecimalКількість у базовій монеті; рівно одне з size і notional.
notionalнеобов’язковийDecimalСума у валюті котирування; рівно одне з size і notional.
reduce_onlyнеобов’язковийboolean
post_onlyнеобов’язковийboolean
time_in_forceнеобов’язковийTimeInForce
client_keyнеобов’язковийstringКлюч ідемпотентності: повтор із тим самим ключем повертає попередню відповідь.

InstrumentCommandRequest

Тіло POST /v1/orders/cancel-all, POST /v1/orders/trigger/cancel-all і POST /v1/positions/close.

ПолеТипОпис
connection_idnumber
instrumentInstrumentAddress

PlaceTriggerRequest

Тіло POST /v1/orders/trigger. stop_loss і take_profit ставляться на відкриту позицію (сторона, розмір і правило беруться з неї); stop несе власні side, notional і необов’язкове rule.

ПолеТипОпис
connection_idnumber
instrumentInstrumentAddress
kindTriggerType
trigger_priceDecimal
sideнеобов’язковийSideЛише для stop.
notionalнеобов’язковийDecimalЛише для stop: сума у валюті котирування.
ruleнеобов’язковийTriggerRuleЛише для stop; без нього — вище ринку для купівлі, нижче для продажу.
client_keyнеобов’язковийstringКлюч ідемпотентності, як у POST /v1/orders.

AmendTriggerRequest

Тіло PATCH /v1/orders/trigger/{id}: нова тригерна ціна.

ПолеТипОпис
connection_idnumber
instrumentInstrumentAddress
kindTriggerType
trigger_priceDecimal
sideнеобов’язковийSideЛише для stop.
ruleнеобов’язковийTriggerRuleЛише для stop.

LeverageMode

type LeverageMode = "manual" | "max" | "smart"

Режим плеча інструмента в терміналі, а не на біржі.

MarginMode

type MarginMode = "cross" | "isolated"

Режим маржі ф’ючерсного інструмента.

Leverage

GET /v1/account/leverage: плече і режим маржі одного ф’ючерсного інструмента з кешу термінала. Інструмент, якого термінал ще не торкався, відповідає 409 not_active.

ПолеТипОпис
connection_idnumber
instrumentInstrumentAddress
leveragenumber
max_leveragenumber
modeLeverageMode
margin_modeMarginMode

SetLeverageRequest

Тіло POST /v1/account/leverage: рівно одне з leverage і mode.

ПолеТипОпис
connection_idnumber
instrumentInstrumentAddress
leverageнеобов’язковийnumberЦіле число, не менше за 1.
modeнеобов’язковий"max" | "smart"

SetMarginModeRequest

Тіло POST /v1/account/margin-mode.

ПолеТипОпис
connection_idnumber
instrumentInstrumentAddress
margin_modeMarginMode

Accepted

Відповідь на кожну торгову команду: прийнято терміналом, а не біржею. Підтвердження, виконання або відмова біржі надходять через account.orders у стрімі або GET /v1/account/orders.

ПолеТипОпис
acceptedboolean
operation_idstringОперація у файлі операцій термінала.
keystring | nullКлюч термінала, під яким заявка (t-…) або тригер (sl_…, tp_…, stop_…) з’являється в account.orders; null для скасувань, змін і плеча.
connection_idnumber
instrumentInstrumentAddress

CellPosition

Комірка сітки вкладки: колонка зліва направо, рядок згори донизу, комірка в рядку.

ПолеТипОпис
columnnumber
rownumber
cellnumber

Stack

Стек — стакан зі стрічкою угод і кластерами — у вкладці. widget_id глобальний для цього запуску термінала; instrument і connection_id дорівнюють null, поки стек empty; position дорівнює null для стека, схованого в групі стеків.

ПолеТипОпис
widget_idnumber
instrumentInstrumentAddress | null
connection_idnumber | null
emptyboolean
frozenboolean
positionCellPosition | null

Chart

Графік у вкладці; owner_widget_id — стек, за яким він іде, null для самостійного графіка.

ПолеТипОпис
widget_idnumber
instrumentInstrumentAddress | null
connection_idnumber | null
intervalstringКод інтервалу свічок (1m, 5m, …).
owner_widget_idnumber | null
positionCellPosition | null

Tab

Вкладка вікна: id нумерується в кожному вікні з 1; рівно одна вкладка вікна active.

ПолеТипОпис
idnumber
namestring
activeboolean
stacksStack[]
chartsChart[]

WindowGeometry

Положення і розмір вікна в логічних пікселях екрана.

ПолеТипОпис
xnumber
ynumber
widthnumber
heightnumber
maximizedboolean

Window

Вікно термінала; main через API закрити не можна, chart_window — відокремлений графік.

ПолеТипОпис
idnumber
mainboolean
chart_windowboolean
focusedboolean
geometryWindowGeometry
monitorstring | nullНазва монітора в ОС або null.
tabsTab[]

WorkspaceSnapshot

data у GET /v1/workspace і в події workspace: усі вікна за зростанням id.

ПолеТипОпис
windowsWindow[]

Workspace

GET /v1/workspace. Ідентифікатори внутрішні для цього запуску термінала.

ПолеТипОпис
dataWorkspaceSnapshot

WorkspaceWindow

GET /v1/workspace/windows/{id}.

ПолеТипОпис
dataWindow

OpenTarget

type OpenTarget = "new_tab" | "new_window"

Куди потрапляє відкрите в робочому просторі.

OpenStackRequest

Тіло POST /v1/workspace/stacks.

ПолеТипОпис
instrumentInstrumentAddress
connection_idнеобов’язковийnumber
chartнеобов’язковийbooleanГрафік того самого інструмента над стеком.
targetнеобов’язковийOpenTargetnew_tab (типово) або new_window.
window_idнеобов’язковийnumberВікно для нової вкладки; без нього — вікно у фокусі.
activateнеобов’язковийbooleanfalse відкриває вкладку у фоні; нове вікно завжди отримує фокус.

OpenMultiviewRequest

Тіло POST /v1/workspace/multiview.

ПолеТипОпис
basestringМонета (BTC) або пара (BTC/USDT).
targetнеобов’язковийOpenTargetБез нього вирішує налаштування «Відкривати» мультив’ю.
window_idнеобов’язковийnumber
activateнеобов’язковийboolean

TabItemRequest

Одна колонка POST /v1/workspace/tabs і …/tabs/{tab}/stacks: стек і, з chart, графік над ним.

ПолеТипОпис
instrumentInstrumentAddress
connection_idнеобов’язковийnumber
chartнеобов’язковийboolean

OpenTabRequest

Тіло POST /v1/workspace/tabs: колонка на кожен елемент, від одного до п’ятдесяти.

ПолеТипОпис
itemsTabItemRequest[]
nameнеобов’язковийstringДо 64 символів; без неї термінал називає вкладку за інструментами.
targetнеобов’язковийOpenTarget
window_idнеобов’язковийnumber
activateнеобов’язковийboolean

AddStacksRequest

Тіло POST /v1/workspace/windows/{id}/tabs/{tab}/stacks.

ПолеТипОпис
itemsTabItemRequest[]

StackInstrumentRequest

Тіло PATCH /v1/workspace/stacks/{widget_id}.

ПолеТипОпис
instrumentInstrumentAddress
connection_idнеобов’язковийnumber

WorkspaceOutcome

Що зробило вікно за командою робочого простору. Для відкриття: вікно, нова вкладка та її stacks і charts у порядку колонок. Для закриття й активації: зачеплені ідентифікатори, решта — null або порожня.

ПолеТипОпис
window_idnumber | null
tab_idnumber | null
stacksnumber[]
chartsnumber[]

SettingRow

Один рядок таблиці налаштувань термінала, як він зберігається. scope — global або order_book; scope_id — default, адреса інструмента або null для гарячих клавіш; connection_id — підключення-власник або null. value — декодований JSON, числа як записано. writable каже, чи приймає ключ PATCH /v1/settings; кадр стріму settings такого прапорця не несе.

ПолеТипОпис
scopestring
scope_idstring | null
connection_idnumber | null
categorystring
keystring
valueunknown
writableнеобов’язковийboolean

Settings

GET /v1/settings: рядки так, як вони зберігаються, без підставлених типових значень.

ПолеТипОпис
dataSettingRow[]

ResolvedFrom

type ResolvedFrom = "instrument" | "connection" | "app_instrument" | "global" | OpenString

Рівень, з якого взято налаштування стека.

OrderbookSetting

Одне налаштування стека з рівнем, з якого воно взяте.

ПолеТипОпис
valueunknown
resolved_fromResolvedFrom
writableboolean

OrderbookSettings

GET /v1/settings/orderbook: data[category][key] такими, як їх бачить стек інструмента.

ПолеТипОпис
connection_idnumber
instrumentInstrumentAddress
dataRecord<string, Record<string, OrderbookSetting>>

SettingChange

Одна зміна PATCH /v1/settings. instrument адресує рядок пари (область order_book); connection_id із scope: "order_book" і без інструмента адресує типове значення підключення; без обох адресується глобальне типове значення. Глобальні налаштування підключення не приймають.

ПолеТипОпис
scopeнеобов’язковий"global" | "order_book"
instrumentнеобов’язковийInstrumentAddress
connection_idнеобов’язковийnumber
categorystring
keystring
valueunknown

UpdateSettingsRequest

Тіло PATCH /v1/settings.

ПолеТипОпис
changesSettingChange[]

SettingsApplied

PATCH /v1/settings: скільки змін застосовано (усі, інакше виклик відхилено).

ПолеТипОпис
appliednumber

BookTopParams

Параметри підписки book.top; інші топіки їх не приймають. Назви як на дроті.

ПолеТипОпис
depthнеобов’язковийnumber1–200, типово 50.
interval_msнеобов’язковийnumberІнтервал конфляції, не менше 50, типово 100.

SubscribeRequest

Запит subscribe, як він надсилається.

ПолеТипОпис
type"subscribe"
request_idstring
topicTopic
instrumentнеобов’язковийInstrumentAddressОбов’язковий для ринкових топіків, для account.* не передається.
connection_idнеобов’язковийnumberДля ринкових топіків вибирається за загальним правилом, для account.* обов’язковий.
paramsнеобов’язковийBookTopParams

UnsubscribeRequest

Запит unsubscribe, як він надсилається.

ПолеТипОпис
type"unsubscribe"
request_idstring
substring

SubscribedFrame

Відповідь сервера на subscribe.

ПолеТипОпис
type"subscribed"
request_idнеобов’язковийstring
substringІдентифікатор підписки, "{stream}:{topic}" ("{connection}:account.<topic>", "workspace"); передавайте його в unsubscribe.
connection_idнеобов’язковийnumberПідключення, вибране для ринкових топіків і топіків рахунку; відсутнє для workspace.

UnsubscribedFrame

Відповідь сервера на unsubscribe.

ПолеТипОпис
type"unsubscribed"
request_idнеобов’язковийstring
substring

ErrorFrame

Кадр error: з request_id він відповідає на запит, із sub і без request_id каже, що сервер зняв цю підписку.

ПолеТипОпис
type"error"
request_idнеобов’язковийstring
subнеобов’язковийstring
codeErrorCode
messagestring

EventFrame

Кадр event, як він надходить, до того як клієнт позначить його топіком.

ПолеТипОпис
type"event"
substring
seqnumberНомер події в підписці; для trades зростає на одиницю.
tsTimestamp
dataT

Gap

Кадр gap: події from_seq..to_seq підписки trades втрачено.

ПолеТипОпис
type"gap"
substring
from_seqnumber
to_seqnumber
reasonstring

SubscriptionError

Сервер зняв підписку (кадр error із sub і без request_id).

ПолеТипОпис
type"error"
substring
codeErrorCode
messagestring

Subscribed

interface Subscribed extends SubscribedFrame

З чим виконується subscribe: кадр subscribed плюс те, що було запитано.

ПолеТипОпис
topicTopic
instrumentнеобов’язковийInstrumentAddressВідсутній для підписок account.*.

OrdersUpdate

data події account.orders: заявки й тригери одного інструмента після зміни.

ПолеТипОпис
instrumentInstrumentAddress
ordersOrder[]
triggersTriggerOrder[]

PositionUpdate

data події account.positions; закриття надходить як position: null.

ПолеТипОпис
instrumentInstrumentAddress
positionPosition | null

TradesEvent

interface TradesEvent extends EventFrame<Trade[]>

Усі події, які клієнт може позначити топіком; topic читається з sub (частина після першої двокрапки).

ПолеТипОпис
topic"trades"

TickerEvent

interface TickerEvent extends EventFrame<Ticker>
ПолеТипОпис
topic"ticker"

MarkPriceEvent

interface MarkPriceEvent extends EventFrame<MarkPrice>
ПолеТипОпис
topic"mark_price"

BookTopEvent

interface BookTopEvent extends EventFrame<BookTop>
ПолеТипОпис
topic"book.top"

ClustersEvent

interface ClustersEvent extends EventFrame<ClusterBucket>
ПолеТипОпис
topic"clusters"

AccountOrdersEvent

interface AccountOrdersEvent extends EventFrame<OrdersUpdate>
ПолеТипОпис
topic"account.orders"

AccountPositionsEvent

interface AccountPositionsEvent extends EventFrame<PositionUpdate>
ПолеТипОпис
topic"account.positions"

AccountBalancesEvent

interface AccountBalancesEvent extends EventFrame<Balance>
ПолеТипОпис
topic"account.balances"

AccountFillsEvent

interface AccountFillsEvent extends EventFrame<Fill>
ПолеТипОпис
topic"account.fills"

WorkspaceEvent

interface WorkspaceEvent extends EventFrame<WorkspaceSnapshot>

data події workspace: уся розкладка; перший кадр — поточний знімок.

ПолеТипОпис
topic"workspace"

SettingsEvent

interface SettingsEvent extends EventFrame<SettingRow>

data події settings: один записаний рядок, без writable.

ПолеТипОпис
topic"settings"

UnknownTopicEvent

interface UnknownTopicEvent extends EventFrame<unknown>

Подія топіка, якого ця версія клієнта не знає (у межах v1 контракт може додавати топіки). topic дорівнює undefined; сира назва топіка — це частина sub після двокрапки.

ПолеТипОпис
topicundefined

Event

type Event = | TradesEvent
  | TickerEvent
  | MarkPriceEvent
  | BookTopEvent
  | ClustersEvent
  | AccountOrdersEvent
  | AccountPositionsEvent
  | AccountBalancesEvent
  | AccountFillsEvent
  | WorkspaceEvent
  | SettingsEvent
  | UnknownTopicEvent

Кадр події, розрізнюваний за topic.

StreamFrame

type StreamFrame = Event | Gap | SubscriptionError

Що видає перебір Stream, у порядку надходження.

Зібрано з коду @spectre-trade/terminal, коміт 2d1c324.

TypeScript SDK

Клієнт, стрім, пошук термінала й помилки пакета @spectre-trade/terminal.

На цій сторінці

DecimalTimestampInstrumentAddressSideScopeMarketTopicAccountTopicTerminalTopicWorkspaceTopicTopicErrorCodeConnectionStateOrderTypeOrderStatusTriggerTypeTriggerRuleTriggerStatusPositionSideTimeInForceErrorEnvelopeListLimitsMetaHealthConnectionEventConnectionStatusConnectionInstrumentInstrumentsPageCandleCandlesIntervalIntervalsTradeTradesLevelTickerMarkPriceSnapshotBookTopOrderbookClusterLevelClusterBucketClustersOrderTriggerOrderAccountOrdersPositionAccountPositionsBalanceAccountBalancesFillAccountFillsPlaceOrderRequestInstrumentCommandRequestPlaceTriggerRequestAmendTriggerRequestLeverageModeMarginModeLeverageSetLeverageRequestSetMarginModeRequestAcceptedCellPositionStackChartTabWindowGeometryWindowWorkspaceSnapshotWorkspaceWorkspaceWindowOpenTargetOpenStackRequestOpenMultiviewRequestTabItemRequestOpenTabRequestAddStacksRequestStackInstrumentRequestWorkspaceOutcomeSettingRowSettingsResolvedFromOrderbookSettingOrderbookSettingsSettingChangeUpdateSettingsRequestSettingsAppliedBookTopParamsSubscribeRequestUnsubscribeRequestSubscribedFrameUnsubscribedFrameErrorFrameEventFrameGapSubscriptionErrorSubscribedOrdersUpdatePositionUpdateTradesEventTickerEventMarkPriceEventBookTopEventClustersEventAccountOrdersEventAccountPositionsEventAccountBalancesEventAccountFillsEventWorkspaceEventSettingsEventUnknownTopicEventEventStreamFrame