Skip to main content

Установка

Для Ziplime нужен Python 3.12+. Российский рынок подключается библиотекой zipfinam: она ставит движок как зависимость и добавляет провайдер данных finam, календари Мосбиржи и исполнение заявок через Финам.
Базовая установка движка — только ядро. Дополнительные возможности ставятся как pip extras:
Для данных Финама нужен токен Finam Trade API из личного кабинета. Положите его в переменную окружения или в файл .env в рабочей папке:

Быстрый старт

Порядок всегда один: сначала справочник инструментов, затем бары, затем запуск.
Тикеры Мосбиржи пишите с кодом площадки: SBER@MISX для акций, RTSX — для срочного рынка. Для акций Мосбиржи передавайте календарь -c XMOS: по умолчанию CLI использует американский XNYS. Не называйте свои переменные context.assets — это имя занято движком.

Командная строка

Ошибки выводятся в stderr с подсказкой, что делать, а код возврата отражает результат. Параметры любой команды — по ключу -h.

Значения ziplime run по умолчанию

CLI не берёт комиссию, пока вы не передадите --commission-per-share. Брокерская комиссия на Мосбирже обычно считается в процентах от оборота, поэтому для реалистичного результата задайте её через Python API: equity_commission=PerDollar(cost=0.0004). Подробнее — в разделе «Расходы и комиссии».

Python API

ziplime.core.run_simulation.run_simulation — то, что вызывает CLI. Используйте его, когда нужны собственные источники данных, модели комиссий или файл конфигурации.
run_simulation по умолчанию использует same_bar_execution=True ради обратной совместимости — в отличие от CLI и MCP-сервера. Передайте same_bar_execution=False, чтобы заявки исполнялись на следующем баре.
Полезные параметры: result.perf — DataFrame pandas с одной строкой на сессию, включая всё, что записано через context.record(...). Готовые скрипты загрузки, бэктеста и реальной торговли для Мосбиржи лежат в examples репозитория zipfinam.