Рабочее пространство

Для чтения раскладки нужно право workspace:read. Для изменения нужно workspace:write. Стек — это стакан с лентой сделок и кластерами.

Прочитать раскладкуСкопировать ссылку на раздел

workspace = terminal.workspace()
for window in workspace.windows:
    for tab in window.tabs:
        print(window.id, tab.id, tab.name, [stack.instrument for stack in tab.stacks])

В ответе перечислены все окна с их вкладками и все вкладки с их стеками и графиками. Все поля есть в справочнике.

Идентификаторы действуют один запускСкопировать ссылку на раздел

У окна и вкладки есть id, у стека и графика — widget_id. Вкладки нумеруются внутри каждого окна, поэтому вкладка адресуется окном и вкладкой вместе.

Все идентификаторы действуют только в текущем запуске терминала. После перезапуска прочитайте раскладку заново.

Открыть стекСкопировать ссылку на раздел

opened = terminal.open_stack("binance:futures:BTCUSDT", chart=True)
print(opened.window_id, opened.tab_id, opened.stacks, opened.charts)

Ответ называет окно, вкладку и идентификаторы открытых виджетов. Все команды на этой странице отвечают в этой форме.

Открыть вкладку с несколькими инструментамиСкопировать ссылку на раздел

from spectre_terminal import TabItem

opened = terminal.open_tab(
    [TabItem("binance:futures:BTCUSDT", chart=True), "binance:futures:ETHUSDT"],
    name="Majors",
)
print(opened.tab_id, opened.stacks, opened.charts)

Каждый элемент становится колонкой, в порядке списка. В списке от 1 до 50 элементов, name — до 64 символов. Если хотя бы один элемент отклонён, не открывается ничего.

target, window_id и activate работают так же, как в Открыть стек.

Добавить стеки во вкладкуСкопировать ссылку на раздел

added = terminal.add_stacks(1, 2, ["binance:futures:SOLUSDT"])
print(added.stacks, added.charts)

Первые два аргумента — окно и вкладка. Новые колонки встают после последней. В ответе перечислены только добавленные виджеты.

Открыть монету на всех биржахСкопировать ссылку на раздел

opened = terminal.open_multiview("BTC", target="new_window")
print(opened.window_id, opened.stacks, opened.charts)

Это кнопка «Мультивью» в терминале: монета открывается на всех биржах, включённых в настройке «Раскладка бирж». Передайте монету, BTC, или пару, BTC/USDT. Без target терминал следует своей настройке «Мультивью».

Сменить инструмент стекаСкопировать ссылку на раздел

terminal.set_stack_instrument(14, "binance:futures:ETHUSDT")

Первый аргумент — это widget_id стека. Его графики тоже переключаются.

Закрыть стек, вкладку или окноСкопировать ссылку на раздел

terminal.close_stack(14)
terminal.close_tab(1, 2)
terminal.close_window(2)

Подтверждения нет. Главное окно, помеченное в раскладке как main, и единственную вкладку окна закрыть нельзя: вызов отвечает 400 invalid_request.

Вывести вкладку или окно на передний планСкопировать ссылку на раздел

terminal.activate_tab(1, 2)
terminal.activate_window(2)

Первый вызов выбирает вкладку, не меняя фокус окна. Второй выводит окно на передний план.

Следить за изменениямиСкопировать ссылку на раздел

import asyncio
from spectre_terminal import Event

async def main():
    async with terminal.stream() as stream:
        await stream.subscribe("workspace")
        async for frame in stream:
            if isinstance(frame, Event) and frame.topic == "workspace":
                for window in frame.data.windows:
                    print(window.id, [tab.name for tab in window.tabs])

asyncio.run(main())

Первый кадр — это текущая раскладка. Затем на каждое изменение приходит кадр со всей раскладкой. Подробнее в разделе Стриминг.

Когда команда не удаласьСкопировать ссылку на раздел

Что недоступноСкопировать ссылку на раздел

API не переносит стеки между вкладками, не меняет ширину колонок и не управляет другими окнами, например скринером.