> For the complete documentation index, see [llms.txt](https://colibri-2.gitbook.io/colibri-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://colibri-2.gitbook.io/colibri-docs/colibri-terminal/nastroiki/local-api.md).

# Local API (виджеты)

Local API — локальный интерфейс терминала для внешних виджетов и программ. С ним терминал перестаёт быть «закрытой коробкой»: поверх него можно строить свои инструменты — от виджета позиций на втором мониторе до собственных алертов и интеграций.

Через Local API программа на вашем компьютере может:

* **получать рыночные данные** в реальном времени — стакан, лента сделок, кластеры, фандинг по любой монете с подключённых бирж;
* **читать состояние счёта** — позиции, ордера, балансы по вашим подключениям;
* **ставить сигнальные уровни** прямо в стакане терминала и получать событие, когда цена их касается;
* **управлять терминалом** — открыть монету или комбо-стакан, показать уведомление;
* **торговать** — выставлять и отменять ордера, включая паник-команды «отменить всё» и «закрыть все позиции» (только по отдельному разрешению, см. ниже).

## Где включить

Раздел **Настройки → Программа → Local API**.

<figure><img src="/files/WNAT3TkaRVAUUmiVvVkp" alt=""><figcaption></figcaption></figure>

* **«Включить Local API»** — запускает локальный сервер. Он принимает подключения только с этого компьютера (адрес `127.0.0.1`) — из интернета или локальной сети к нему обратиться нельзя.
* **«Порт»** — номер порта, на котором работает сервер. Терминал подбирает его автоматически из диапазона `18845–18854`.
* **«Токен доступа»** — «пароль», по которому программы подключаются к API. Кнопка **«Копировать»** копирует токен, **«Сменить»** генерирует новый — при этом все подключённые виджеты отключаются, пока не получат новый токен. Виджеты Colibri находят порт и токен автоматически.
* **«Разрешить доступ из браузера»** — по умолчанию выключено: к API подключаются только обычные (нативные) приложения. Если включить, по адресу `http://localhost:<порт>/` откроется встроенный веб-дашборд, а подключаться смогут и веб-виджеты — обычные страницы в браузере. Токен нужен по-прежнему, так что чужой сайт без него действовать от вашего имени не сможет.

## Разрешения на торговлю через API

Сам по себе токен даёт доступ **только на чтение**. Чтобы виджет мог выставлять реальные ордера, в блоке **«Разрешения на торговлю через API»** нужно отдельно отметить галочкой каждое подключение, которому вы это разрешаете.

{% hint style="warning" %}
Ставьте галочку торговли только тем аккаунтам, которыми действительно хотите позволить торговать виджетам. Защита здесь трёхуровневая: сервер работает только локально, доступ — по токену, а торговля по умолчанию запрещена для всех подключений.
{% endhint %}

## Что можно построить

* Виджет позиций и P\&L на второй монитор или оверлей для стрима в OBS.
* Свои алерты: скрипт следит за рынком, ставит сигнальные уровни в стакан и шлёт уведомления в терминал.
* Интеграции: клик по монете во внешней программе — и её стакан открывается в терминале.
* Торговые панели и паник-кнопки (например, на Stream Deck) — при включённом разрешении на торговлю.

## Документация для разработчиков

Кнопка **«Документация API и SDK»** на странице настроек ведёт на сайт документации: [colibriecosystem.github.io/colibri-sdk](https://colibriecosystem.github.io/colibri-sdk/). Там — справочник по всем командам API, SDK с исходным кодом и интерактивный тестер: можно ввести порт и токен и посмотреть живые данные терминала прямо в браузере.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://colibri-2.gitbook.io/colibri-docs/colibri-terminal/nastroiki/local-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.