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.0.1
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
Requirements
Dart 1.20.0 or later OR Flutter 0.0.20 or later
Installation & Usage
Github
name: tinkoff_invest_api
version: 0.0.1
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/api.dart';
var api_instance = new MarketApi();
try {
var result = api_instance.marketBondsGet();
print(result);
} catch (e) {
print("Exception when calling MarketApi->marketBondsGet: $e\n");
}
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
IL_Agent
Libraries
- api_key_auth
- api_util
- auth
- basic_auth
- broker_account_type
- candle
- candle_resolution
- candles
- candles_response
- currencies
- currency
- currency_position
- empty
- error
- error_payload
- instrument_type
- limit_order_request
- limit_order_response
- market_api
- market_instrument
- market_instrument_list
- market_instrument_list_response
- market_instrument_response
- market_order_request
- market_order_response
- money_amount
- oauth
- operation
- operation_status
- operation_trade
- operation_type
- operation_type_with_commission
- operations
- operations_api
- operations_response
- order
- order_response
- order_status
- order_type
- orderbook
- orderbook_response
- orders_api
- orders_response
- placed_limit_order
- placed_market_order
- portfolio
- portfolio_api
- portfolio_currencies_response
- portfolio_position
- portfolio_response
- sandbox_account
- sandbox_api
- sandbox_currency
- sandbox_register_request
- sandbox_register_response
- sandbox_set_currency_balance_request
- sandbox_set_position_balance_request
- search_market_instrument
- search_market_instrument_response
- serializers
- tinkoff_invest_api.api
- trade_status
- user_account
- user_accounts
- user_accounts_response
- user_api