Insight.Tinkoff.InvestSdk 1.3.0

Unofficial Tinkoff Invest OpenApi csharp Sdk

Install-Package Insight.Tinkoff.InvestSdk -Version 1.3.0
dotnet add package Insight.Tinkoff.InvestSdk --version 1.3.0
<PackageReference Include="Insight.Tinkoff.InvestSdk" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Insight.Tinkoff.InvestSdk --version 1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Unofficial Tinkoff Invest .Net Sdk

Build Status
nuget version
Nuget

About

Данное sdk предназначено для взаимодействия с OpenApi Тинькофф Инвестиций. Так как на момент публикации официального sdk больше половины работы над данным проектом было закончено, я решил, что буду пользоваться им и поддерживать по мере возможности. Вопросы и предложения прошу в Issues.

Get started

Для начала вам необходимо получить токен, процедура подробно описана здесь

Структура SDK

Взаимодействие с API происходит через следующие сервисы:

  • MarketService - Получение информации об инструментах (Rest, реализует IMarketService)
  • OrderService - Получение информации о лимитных заявках, а также их размещение (Rest, реализует IOrderService)
  • PortfolioService - Получение информации о портфолио (Rest, реализует IPortfolioService)
  • OperationService - Получение информации об операциях (Rest, реализует IOperationService)
  • SandboxService - Взаимодействие с песочницей (Rest, реализует ISandboxService)
  • StreamMarketService - Взаимодействие с API по протоколу WebSocket (WebSocket, Реализует IStreamMarketService)

Все Rest сервисы инициализируются объектом конфигурации типа RestConfiguration:

  • string AccessToken - Токен доступа к API
  • string BaseUrl - Базовый адрес API, default = "https://api-invest.tinkoff.ru"
  • bool SandboxMode - Признак активна ли песочница, default = true

StreamMarketService инициализируется объектом конфигурации типа StreamConfiguration:

  • string AccessToken - Токен доступа к API
  • string Address - Адрес, по которому доступен WebSocket, default = "wss://api-invest.tinkoff.ru/openapi/md/v1/md-openapi/ws"

StreamMarketService

Механизм взаимодействия взят из официального sdk. StreamMarketService реализует интерфейс IStreamMarketService:

public interface IStreamMarketService
{
    Task Send(IWsMessage message);

    IObservable<WsMessage> AsObservable();
}

Соотвественно метод Send служит для отправки сообщений на подписку/отписку от событий. Типы исходящих сообщений реализуют интерфейс IWsMessage: SubscribeCandleMessage, UnsubscribeCandleMessage, SubscribeOrderBookMessage, UnsubscribeOrderBookMessage, SubscribeInstrumentInfoMessage, UnsubscribeInstrumentInfoMessage;
Метод AsObservable() реализован с помощью System.Reactive, а именно с помощью Observable.FromEventPattern, благодаря этому вы получаете Push коллекцию, в которую будут приходить сообщения типа WsMessage: CandleMessage, OrderBookMessage, InstrumentInfoMessage. На выходе сообщения десериализуются в правильный тип на основе свойства Event, вы можете использовать Pattern Matching. Пример кода:

public sealed class Program {
  private StreamConfiguration _config;
  
  public Program(StreamConfiguration config) {
    if(config == null)
      throw new ArgumentNullException(nameof(config));
      
    _config = config;
  }
  
  public async Task DoWork() {
    using (var client = new StreamMarketService(_config))
    {
      IDisposable subscription = client
        .AsObservable()
        .Do(x =>
        {
          switch (x)
          {
            case CandleMessage message:
              Console.WriteLine($"type: {message}, figi: {message.Payload.Figi}");
              break;
            default:
              Console.WriteLine("Unknown message type");
              break;
          }
        }, ex => { throw ex; })
        .Subscribe();
    
      await client.Send(new SubscribeCandleMessage
      {
        Figi = "{figi}",
        Interval = CandleInterval.Minute
      });

      await Task.Delay(1000 * 5);

      await client.Send(new UnsubscribeCandleMessage()
      {
        Figi = "{figi}",
        Interval = CandleInterval.Minute
      });
      
      subscription?.Dispose();
    }
  }
}

Тесты

Вы можете запустить примитивные тесты для Rest сервисов добавив в файл Insight.Tinkoff.Invest.Tests/appsettings.json токен для сандбокса. По дефолту изменения файла игнорируются в .gitignore

Unofficial Tinkoff Invest .Net Sdk

Build Status
nuget version
Nuget

About

Данное sdk предназначено для взаимодействия с OpenApi Тинькофф Инвестиций. Так как на момент публикации официального sdk больше половины работы над данным проектом было закончено, я решил, что буду пользоваться им и поддерживать по мере возможности. Вопросы и предложения прошу в Issues.

Get started

Для начала вам необходимо получить токен, процедура подробно описана здесь

Структура SDK

Взаимодействие с API происходит через следующие сервисы:

  • MarketService - Получение информации об инструментах (Rest, реализует IMarketService)
  • OrderService - Получение информации о лимитных заявках, а также их размещение (Rest, реализует IOrderService)
  • PortfolioService - Получение информации о портфолио (Rest, реализует IPortfolioService)
  • OperationService - Получение информации об операциях (Rest, реализует IOperationService)
  • SandboxService - Взаимодействие с песочницей (Rest, реализует ISandboxService)
  • StreamMarketService - Взаимодействие с API по протоколу WebSocket (WebSocket, Реализует IStreamMarketService)

Все Rest сервисы инициализируются объектом конфигурации типа RestConfiguration:

  • string AccessToken - Токен доступа к API
  • string BaseUrl - Базовый адрес API, default = "https://api-invest.tinkoff.ru"
  • bool SandboxMode - Признак активна ли песочница, default = true

StreamMarketService инициализируется объектом конфигурации типа StreamConfiguration:

  • string AccessToken - Токен доступа к API
  • string Address - Адрес, по которому доступен WebSocket, default = "wss://api-invest.tinkoff.ru/openapi/md/v1/md-openapi/ws"

StreamMarketService

Механизм взаимодействия взят из официального sdk. StreamMarketService реализует интерфейс IStreamMarketService:

public interface IStreamMarketService
{
    Task Send(IWsMessage message);

    IObservable<WsMessage> AsObservable();
}

Соотвественно метод Send служит для отправки сообщений на подписку/отписку от событий. Типы исходящих сообщений реализуют интерфейс IWsMessage: SubscribeCandleMessage, UnsubscribeCandleMessage, SubscribeOrderBookMessage, UnsubscribeOrderBookMessage, SubscribeInstrumentInfoMessage, UnsubscribeInstrumentInfoMessage;
Метод AsObservable() реализован с помощью System.Reactive, а именно с помощью Observable.FromEventPattern, благодаря этому вы получаете Push коллекцию, в которую будут приходить сообщения типа WsMessage: CandleMessage, OrderBookMessage, InstrumentInfoMessage. На выходе сообщения десериализуются в правильный тип на основе свойства Event, вы можете использовать Pattern Matching. Пример кода:

public sealed class Program {
  private StreamConfiguration _config;
  
  public Program(StreamConfiguration config) {
    if(config == null)
      throw new ArgumentNullException(nameof(config));
      
    _config = config;
  }
  
  public async Task DoWork() {
    using (var client = new StreamMarketService(_config))
    {
      IDisposable subscription = client
        .AsObservable()
        .Do(x =>
        {
          switch (x)
          {
            case CandleMessage message:
              Console.WriteLine($"type: {message}, figi: {message.Payload.Figi}");
              break;
            default:
              Console.WriteLine("Unknown message type");
              break;
          }
        }, ex => { throw ex; })
        .Subscribe();
    
      await client.Send(new SubscribeCandleMessage
      {
        Figi = "{figi}",
        Interval = CandleInterval.Minute
      });

      await Task.Delay(1000 * 5);

      await client.Send(new UnsubscribeCandleMessage()
      {
        Figi = "{figi}",
        Interval = CandleInterval.Minute
      });
      
      subscription?.Dispose();
    }
  }
}

Тесты

Вы можете запустить примитивные тесты для Rest сервисов добавив в файл Insight.Tinkoff.Invest.Tests/appsettings.json токен для сандбокса. По дефолту изменения файла игнорируются в .gitignore

Release Notes

SDK objects serialization fixed
   ExtendedOperationType extended with new types
   Renamings:
   - IOrderService.PostLimitOrder -> IOrderService.PlaceLimitOrder
   - Order.OperationType -> Order.Operation
   - LimitOrderRequest -> PlaceLimitOrderRequest
   - TinkoffRestServiceConfiguration -> RestConfiguration
   - StreamMarketServiceConfiguration -> StreamConfiguration
   - StreamMarketServiceConfiguration.Token -> StreamConfiguration.AccessToken

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.3.0 64 11/14/2019
1.2.1 50 11/8/2019
1.2.0 48 11/8/2019
1.1.1 89 10/18/2019
1.0.1 65 10/16/2019
1.0.0 60 10/16/2019