tinkoff_invest_api

Description:

tinkoff invest api

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
copied to clipboard
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
copied to clipboard
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");
}

copied to clipboard
Documentation for API Endpoints #
All URIs are relative to https://api-invest.tinkoff.ru/openapi



Class
Method
HTTP request
Description




MarketApi
marketBondsGet
get /market/bonds
Получение списка облигаций


MarketApi
marketCandlesGet
get /market/candles
Получение исторических свечей по FIGI


MarketApi
marketCurrenciesGet
get /market/currencies
Получение списка валютных пар


MarketApi
marketEtfsGet
get /market/etfs
Получение списка ETF


MarketApi
marketOrderbookGet
get /market/orderbook
Получение стакана по FIGI


MarketApi
marketSearchByFigiGet
get /market/search/by-figi
Получение инструмента по FIGI


MarketApi
marketSearchByTickerGet
get /market/search/by-ticker
Получение инструмента по тикеру


MarketApi
marketStocksGet
get /market/stocks
Получение списка акций


OperationsApi
operationsGet
get /operations
Получение списка операций


OrdersApi
ordersCancelPost
post /orders/cancel
Отмена заявки


OrdersApi
ordersGet
get /orders
Получение списка активных заявок


OrdersApi
ordersLimitOrderPost
post /orders/limit-order
Создание лимитной заявки


OrdersApi
ordersMarketOrderPost
post /orders/market-order
Создание рыночной заявки


PortfolioApi
portfolioCurrenciesGet
get /portfolio/currencies
Получение валютных активов клиента


PortfolioApi
portfolioGet
get /portfolio
Получение портфеля клиента


SandboxApi
sandboxClearPost
post /sandbox/clear
Удаление всех позиций


SandboxApi
sandboxCurrenciesBalancePost
post /sandbox/currencies/balance
Выставление баланса по валютным позициям


SandboxApi
sandboxPositionsBalancePost
post /sandbox/positions/balance
Выставление баланса по инструментным позициям


SandboxApi
sandboxRegisterPost
post /sandbox/register
Регистрация клиента в sandbox


SandboxApi
sandboxRemovePost
post /sandbox/remove
Удаление счета


UserApi
userAccountsGet
get /user/accounts
Получение брокерских счетов клиента



Documentation For Models #

BrokerAccountType
Candle
CandleResolution
Candles
CandlesResponse
Currencies
Currency
CurrencyPosition
Empty
Error
ErrorPayload
InstrumentType
LimitOrderRequest
LimitOrderResponse
MarketInstrument
MarketInstrumentList
MarketInstrumentListResponse
MarketInstrumentResponse
MarketOrderRequest
MarketOrderResponse
MoneyAmount
Operation
OperationStatus
OperationTrade
OperationType
OperationTypeWithCommission
Operations
OperationsResponse
Order
OrderResponse
OrderStatus
OrderType
Orderbook
OrderbookResponse
OrdersResponse
PlacedLimitOrder
PlacedMarketOrder
Portfolio
PortfolioCurrenciesResponse
PortfolioPosition
PortfolioResponse
SandboxAccount
SandboxCurrency
SandboxRegisterRequest
SandboxRegisterResponse
SandboxSetCurrencyBalanceRequest
SandboxSetPositionBalanceRequest
SearchMarketInstrument
SearchMarketInstrumentResponse
TradeStatus
UserAccount
UserAccounts
UserAccountsResponse

Documentation For Authorization #
sso_auth #

Type: HTTP basic authentication

Author #
[email protected]