tinkoff_invest_api 0.1.0
tinkoff_invest_api: ^0.1.0 copied to clipboard

OpenAPI API client

tinkoff_invest_api #

Dart client for Tinkoff Investment open API

See https://github.com/TinkoffCreditSystems/invest-openapi

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 0.1.0
  • Build package: org.openapitools.codegen.languages.DartDioNextClientCodegen

Requirements #

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage #

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

name: tinkoff_invest_api
version: 0.1.0
description: OpenAPI API client
dependencies:
  tinkoff_invest_api:
    git: https://github.com/ILAgent/tinkoff_invest_api

Local #

To use the package in your local drive, please include the following in pubspec.yaml

dependencies:
  tinkoff_invest_api:
    path: /path/to/tinkoff_invest_api

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:tinkoff_invest_api/tinkoff_invest_api.dart';


final api = MarketApi();

try {
    final response = await api.marketBondsGet();
    print(response);
} catch on DioError (e) {
    print("Exception when calling MarketApi->marketBondsGet: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://api-invest.tinkoff.ru/openapi

ClassMethodHTTP requestDescription
MarketApimarketBondsGetget /market/bondsПолучение списка облигаций
MarketApimarketCandlesGetget /market/candlesПолучение исторических свечей по FIGI
MarketApimarketCurrenciesGetget /market/currenciesПолучение списка валютных пар
MarketApimarketEtfsGetget /market/etfsПолучение списка ETF
MarketApimarketOrderbookGetget /market/orderbookПолучение стакана по FIGI
MarketApimarketSearchByFigiGetget /market/search/by-figiПолучение инструмента по FIGI
MarketApimarketSearchByTickerGetget /market/search/by-tickerПолучение инструмента по тикеру
MarketApimarketStocksGetget /market/stocksПолучение списка акций
OperationsApioperationsGetget /operationsПолучение списка операций
OrdersApiordersCancelPostpost /orders/cancelОтмена заявки
OrdersApiordersGetget /ordersПолучение списка активных заявок
OrdersApiordersLimitOrderPostpost /orders/limit-orderСоздание лимитной заявки
OrdersApiordersMarketOrderPostpost /orders/market-orderСоздание рыночной заявки
PortfolioApiportfolioCurrenciesGetget /portfolio/currenciesПолучение валютных активов клиента
PortfolioApiportfolioGetget /portfolioПолучение портфеля клиента
SandboxApisandboxClearPostpost /sandbox/clearУдаление всех позиций
SandboxApisandboxCurrenciesBalancePostpost /sandbox/currencies/balanceВыставление баланса по валютным позициям
SandboxApisandboxPositionsBalancePostpost /sandbox/positions/balanceВыставление баланса по инструментным позициям
SandboxApisandboxRegisterPostpost /sandbox/registerРегистрация клиента в sandbox
SandboxApisandboxRemovePostpost /sandbox/removeУдаление счета
UserApiuserAccountsGetget /user/accountsПолучение брокерских счетов клиента

Documentation For Models #

Documentation For Authorization #

sso_auth #

  • Type: HTTP basic authentication

Author #

n.v.melnikov@tinkoff.ru