tbank_invest

Languages: English · Русский

Unofficial Dart client for T‑Invest (T‑Bank) Invest API — REST (Dio) + dart:io WebSocket, OpenAPI code‑generated request/response models (V1* in lib/src/generated/, exported from the package) plus hand-written helpers. Not an official SDK.

More docs (full package): doc/README.md — structure, config, all REST services, WSS, errors/retry, models, platforms, and OpenAPI codegen (EN + RU).

Flutter Web / browser: not supported — the main import pulls in dart:io (see Platform support).

English

Dart client for T‑Invest:

REST — thin wrappers over every method from the official OpenAPI (POST + JSON), using Dio.
OpenAPI DTOs — every Invest*Api method takes a V1*Request and returns a V1*Response (or a rare generated name such as Contractv1OrderState); see lib/src/generated/ and docs (service regen, codegen).
WebSocket — WebSocket helper with Authorization and the json subprotocol for streaming endpoints.

Platform support

Where	What to expect
Flutter on iOS, Android, macOS, Windows, and Dart CLI on the same desktop OSes	Use the package as documented: REST (`TinvestClient`) and `InvestWebSocket` both work.
Flutter Web, dart2js, or other browser / JS targets	Unsupported today. The default barrel file `tbank_invest.dart` exports `invest_websocket.dart`, which imports `dart:io`, so the project will not compile for web — not only streaming, but the entire `import 'package:tbank_invest/tbank_invest.dart'` graph. A web-capable build would need a separate entry point without `dart:io` (not shipped in this version).

Features

Area	Notes
REST	One class per gRPC/OpenAPI service (`InvestUsersApi`, `InvestMarketDataApi`, …). Each method maps 1:1 to a path in `InvestApiPaths`.
DTOs	`InvestApi` methods are fully typed* (`V1Request` / `V1Response` from codegen). Use `InvestHttpClient.post` only for advanced cases or the package’s integration smokes. See rest-and-services, service-regeneration.
Auth	Bearer token on every request; optional `x-app-name` via `InvestConfig.appName`.
WebSocket	`InvestWebSocket.connect` builds `wss://…` URLs from `InvestConfig` + `InvestApiPaths`.
Reliability	`InvestRetryPolicy` for idempotent REST methods, `InvestRateLimitException` with `retryAfter`, and `InvestStreamManager` (reconnect + resubscribe + heartbeat).
Helpers	`MoneyValue`, `Quotation`, `InvestApiException` (HTTP status, gRPC code, `x-tracking-id` when present).

Supported API coverage

Service area	Status
`UsersService`, `InstrumentsService`, `MarketDataService`, `OperationsService`, `OrdersService`, `StopOrdersService`, `SandboxService`, `SignalService`	Implemented as REST service wrappers in `lib/src/services/`.
`MarketDataStreamService`, `OrdersStreamService`, `OperationsStreamService`	Path constants + WebSocket support via `InvestWebSocket`.
OpenAPI DTOs	Full set of `V1` (and related) request/response types; `InvestApi` uses them directly** in method signatures. `lib/src/services/*_api.dart` is regenerated with `tool/_generate_service_dart_types.py` when the spec changes.
Flutter Web/browser target	Not supported in current default import graph (`dart:io`).

Installation

dependencies:
  tbank_invest: ^0.6.2

Path dependency is intended for local development of this package only:

dependencies:
  tbank_invest:
    path: packages/tbank_invest

Quick start (REST)

import 'package:tbank_invest/tbank_invest.dart';

Future<void> main() async {
  final client = TinvestClient(
    InvestConfig(
      token: 't.your_token_here',
      environment: InvestEnvironment.sandbox,
    ),
  );

  try {
    final res =
        await client.users.getAccounts(const V1GetAccountsRequest());
    final list = res.accounts ?? <V1Account>[];
    print('Accounts: ${list.length}');
  } on InvestApiException catch (e) {
    print(e);
  } finally {
    client.close();
  }
}

Token via CLI:

dart run --define=TBANK_TOKEN=t.xxx bin/your_app.dart

const token = String.fromEnvironment('TBANK_TOKEN', defaultValue: '');

Configuration

Field	Purpose
`token`	API token (`t.…`), without `Bearer` .
`environment`	`production` or `sandbox` — REST/WSS base URLs.
`appName`	Optional `x-app-name` if registered with T‑Bank.
`logHttpTraffic`	If `true`, Dio logs bodies (not `Authorization`). Default `false`.
`allowInsecureSandboxTls`	Debug-only TLS bypass for `sandbox` REST calls. Ignored in `production`. Default `false`.
Timeouts	`connectTimeout`, `receiveTimeout`, `sendTimeout`.

WebSocket

Same path segments as REST (InvestApiPaths), wss://, subprotocol json, Authorization: Bearer <token>. Payloads: official WebSocket / protobuf JSON (asyncapi, WS docs).

Last-price subscribe example:

import 'dart:convert';
import 'dart:io' show WebSocket;

import 'package:tbank_invest/tbank_invest.dart';

Future<void> lastPriceExample(InvestConfig config) async {
  final ws = await InvestWebSocket.connect(
    config: config,
    apiPath: InvestApiPaths.marketDataStreamServiceMarketDataStream,
  );

  ws.add(jsonEncode({
    'subscribeLastPriceRequest': {
      'subscriptionAction': 'SUBSCRIPTION_ACTION_SUBSCRIBE',
      'instruments': [
        {'instrumentId': '<instrument-uuid>'},
      ],
    },
  }));

  await for (final data in ws) {
    final text = data is String ? data : utf8.decode(data as List<int>);
    print(text);
  }
}

Platforms: dart:io WebSocket works on Flutter iOS, Android, desktop; Flutter Web needs another transport.

Errors

InvestApiException — optional httpStatusCode, grpcCode, businessCode, trackingId.
InvestDecodeException — unexpected JSON.
InvestException — generic client error.

Documentation (extra)

Doc	Content
doc/README.md	Master index: EN + RU links for every topic.
doc/structure-and-exports.md	Public exports, `TinvestClient`, `lib/src/` map. RU: structure-and-exports.ru.md.
doc/configuration.md	`InvestConfig`, environments, retry, TLS. RU: configuration.ru.md.
doc/rest-and-services.md	`InvestHttpClient`, all `Invest*Api` methods. RU: rest-and-services.ru.md.
doc/websocket-and-streams.md	WSS, `InvestStreamManager`. RU: websocket-and-streams.ru.md.
doc/exceptions-and-retry.md	Error types, `InvestRetryPolicy`. RU: exceptions-and-retry.ru.md.
doc/models-and-dto.md	Hand helpers vs `V1*` (post–0.6.2). RU: models-and-dto.ru.md.
doc/platform.md	Web vs VM. RU: platform.ru.md.
doc/openapi-dto.md / openapi-dto.ru.md	`build_runner`, `t_invest.swagger` DTOs, `tool/`.
doc/service-regeneration.md	Regenerate `lib/src/services/*_api.dart`. RU: service-regeneration.ru.md.

pubspec.yaml uses documentation: pointing to the docs folder on GitHub.

Package layout

lib/
  tbank_invest.dart
  src/
    invest_config.dart
    invest_http_client.dart
    invest_websocket.dart
    invest_exception.dart
    api_paths.dart
    json_types.dart
    generated/       # OpenAPI DTOs (t_invest.swagger.dart, …) — do not hand-edit
    models/
    services/
    tinvest_client.dart
tool/
  t_invest.openapi.swagger              # spec for swagger codegen + Python service mapper
  _generate_service_dart_types.py       # see doc/service-regeneration.md
doc/              # see doc/README.md — full index (EN/RU) + *.md, *.ru.md
example/
  example.dart

Contributing

Contributions are welcome. Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md before opening a PR.

Limitations

No Flutter Web / browser — default import includes dart:io WebSocket; see Platform support.
REST — Invest*Api is fully DTO-typed; for raw JSON, InvestHttpClient.post, postDto, postRequest. See docs, rest-and-services, service-regeneration.
Quotas and stream rules are enforced by T‑Bank.

Example app

dart run --define=TBANK_TOKEN=t.xxx example/example.dart

License

MIT — see LICENSE.

Русский

Неофициальный Dart-клиент для API Т‑Инвест (Т‑Банк):

REST — обёртки над методами из OpenAPI (POST + JSON), транспорт Dio.
OpenAPI DTO — Invest*Api на V1*Request/Response, скрипт пересборки lib/src/services/*_api — service-regeneration.ru.md; индекс, codegen.
WebSocket — помощник на базе WebSocket из dart:io с заголовком Authorization и подпротоколом json.

Официальным SDK пакет не является; контракты и лимиты — в документации Т‑Банка.

Flutter Web / браузер: не поддерживается — основной импорт тянет dart:io (см. Поддержка платформ).

Поддержка платформ

Где Что ждать

Flutter на iOS, Android, macOS, Windows и Dart CLI на тех же ОС Полный сценарий: REST (TinvestClient) и InvestWebSocket.

Flutter Web, dart2js, браузер / JS Сейчас не поддерживается. Файл tbank_invest.dart реэкспортирует invest_websocket.dart с dart:io, поэтому сборка под веб не проходит — страдает не только стрим, но и любой import 'package:tbank_invest/tbank_invest.dart'. Отдельная точка входа без dart:io в этой версии не поставляется.

Где	Что ждать
Flutter на iOS, Android, macOS, Windows и Dart CLI на тех же ОС	Полный сценарий: REST (`TinvestClient`) и `InvestWebSocket`.
Flutter Web, dart2js, браузер / JS	Сейчас не поддерживается. Файл `tbank_invest.dart` реэкспортирует `invest_websocket.dart` с `dart:io`, поэтому сборка под веб не проходит — страдает не только стрим, но и любой `import 'package:tbank_invest/tbank_invest.dart'`. Отдельная точка входа без `dart:io` в этой версии не поставляется.

Содержание (RU)

Поддержка платформ
Возможности
Покрытие API
Установка
Быстрый старт (REST)
Конфигурация
WebSocket (стримы)
Ошибки
Документация (доп.)
Структура пакета
Как контрибьютить
Ограничения
Пример
Лицензия

Возможности

Область	Описание
REST	Один класс на сервис OpenAPI (`InvestUsersApi`, `InvestMarketDataApi`, …), путь 1:1 с `InvestApiPaths`.
DTO	Методы `InvestApi` — `V1Request` / `V1Response`. `post` / сырой map — низкоуровнево. доки, сервисы, пересборка `_api`.
Авторизация	Bearer на каждый запрос; опционально `x-app-name` через `InvestConfig.appName`.
WebSocket	`InvestWebSocket.connect` собирает `wss://…` из `InvestConfig` и `InvestApiPaths`.
Надёжность	`InvestRetryPolicy` для идемпотентных REST-вызовов, `InvestRateLimitException` с `retryAfter`, `InvestStreamManager` (reconnect + resubscribe + heartbeat).
Утилиты	`MoneyValue`, `Quotation`, `InvestApiException`.

Покрытие API

Область сервиса	Статус
`UsersService`, `InstrumentsService`, `MarketDataService`, `OperationsService`, `OrdersService`, `StopOrdersService`, `SandboxService`, `SignalService`	Реализованы как REST-обёртки в `lib/src/services/`.
`MarketDataStreamService`, `OrdersStreamService`, `OperationsStreamService`	Константы путей + поддержка WebSocket через `InvestWebSocket`.
DTO по OpenAPI	Полный набор типов; сигнатуры *`InvestApi` — DTO*; `lib/src/services/_api.dart` — скрипт `tool/_generate_service_dart_types.py`.
Flutter Web/браузер	Пока не поддерживается из-за `dart:io` в стандартном импорте.

Установка

dependencies:
  tbank_invest: ^0.6.2

Локальная зависимость по пути нужна только при разработке самого пакета:

dependencies:
  tbank_invest:
    path: packages/tbank_invest

Быстрый старт (REST)

import 'package:tbank_invest/tbank_invest.dart';

Future<void> main() async {
  final client = TinvestClient(
    InvestConfig(
      token: 't.ВАШ_ТОКЕН',
      environment: InvestEnvironment.sandbox,
    ),
  );

  try {
    final res =
        await client.users.getAccounts(const V1GetAccountsRequest());
    final list = res.accounts ?? <V1Account>[];
    print('Accounts: ${list.length}');
  } on InvestApiException catch (e) {
    print(e);
  } finally {
    client.close();
  }
}

Токен без хардкода:

dart run --define=TBANK_TOKEN=t.xxx bin/your_app.dart

const token = String.fromEnvironment('TBANK_TOKEN', defaultValue: '');

Конфигурация

Поле	Назначение
`token`	Токен API (`t.…`), без префикса `Bearer` .
`environment`	`production` или `sandbox` — базовые URL REST/WSS.
`appName`	Опционально, заголовок `x-app-name`, если зарегистрировано в Т‑Банке.
`logHttpTraffic`	При `true` Dio пишет тела запросов/ответов (заголовок `Authorization` не логируется). По умолчанию `false`.
`allowInsecureSandboxTls`	Отладочный bypass TLS для REST в `sandbox`. В `production` игнорируется. По умолчанию `false`.
Таймауты	`connectTimeout`, `receiveTimeout`, `sendTimeout`.

WebSocket (стримы)

Те же сегменты пути, что и у REST (InvestApiPaths), схема wss://, подпротокол json, Authorization: Bearer <token>. Формат тел сообщений — как в asyncapi и документации WS.

Пример подписки на последнюю цену — см. раздел English → WebSocket (тот же код).

Платформы: для Flutter подходят iOS, Android, desktop; веб — другой транспорт.

Ошибки

InvestApiException — тело ошибки API, при необходимости httpStatusCode, grpcCode, trackingId.
InvestDecodeException — неожиданная форма JSON.
InvestException — прочие ошибки клиента.

Документация (доп.)

Файл	Содержание
doc/README.md	Оглавление: все разделы EN + RU
doc/structure-and-exports.ru.md	Экспорт, фасад, структура `lib/src/`
doc/configuration.ru.md	`InvestConfig`, среда, retry, TLS
doc/rest-and-services.ru.md	Список REST-методов по сервисам
doc/websocket-and-streams.ru.md	WSS, `InvestStreamManager`
doc/exceptions-and-retry.ru.md	Исключения, повторы
doc/models-and-dto.ru.md	Модели и `V1*`
doc/platform.ru.md	Платформы
doc/openapi-dto.ru.md	Кодоген, `build_runner`
doc/service-regeneration.ru.md	Скрипт `*_api.dart` из OpenAPI

В pubspec.yaml — documentation: на каталог docs на GitHub.

Структура пакета

lib/
  tbank_invest.dart      # Экспорт
  src/
    invest_config.dart
    invest_http_client.dart
    invest_websocket.dart
    invest_exception.dart
    api_paths.dart       # Константы путей
    json_types.dart
    generated/           # OpenAPI DTO (t_invest.swagger.dart, …) — не править вручную
    models/
    services/
    tinvest_client.dart
tool/
  t_invest.openapi.swagger
  _generate_service_dart_types.py
doc/              # см. doc/README.md
example/
  example.dart

Как контрибьютить

Перед pull request прочитай CONTRIBUTING.md и CODE_OF_CONDUCT.md.

Ограничения

Нет Flutter Web / браузера — в дефолтном импорте есть WebSocket на dart:io; см. Поддержка платформ.
REST — Invest*Api только DTO; сырой JSON: http.post, postDto, postRequest (docs, REST).
Лимиты API и правила стримов задаёт Т‑Банк.

Пример

Из корня пакета:

dart run --define=TBANK_TOKEN=t.xxx example/example.dart

Лицензия

MIT — файл LICENSE.