Skip to content

Latest commit

 

History

History
437 lines (257 loc) · 12.6 KB

openapi.md

File metadata and controls

437 lines (257 loc) · 12.6 KB
Raw

@tinkoff/invest-openapi-js-sdk - v1.2.7 › Globals › OpenAPI

Class: OpenAPI

Hierarchy

  • OpenAPI

Index

Constructors

Methods

Constructors

constructor

+ new OpenAPI(__namedParameters: object): OpenAPI

Parameters:

▪ __namedParameters: object

Name Type Description
apiURL string REST api url см документацию
secretToken string токен доступа см получение токена доступа
socketURL string Streaming api url см документацию

Returns: OpenAPI

Methods

bonds

▸ bonds(): Promise‹MarketInstrumentList›

Метод для получения всех доступных облигаций

Returns: Promise‹MarketInstrumentList›

cancelOrder

▸ cancelOrder(__namedParameters: object): Promise‹void›

Метод для отмены активных заявок

Parameters:

▪ __namedParameters: object

Name Type Description
orderId string идентифткатор заявки

Returns: Promise‹void›

candle

▸ candle(__namedParameters: object, cb: function): (Anonymous function)

Метод для подписки на данные по свечному графику инструмента

example см. метод orderbook

Parameters:

▪ __namedParameters: object

Name Type Default Description
figi string - идентификатор инструмента
interval "1min" | "2min" | "3min" | "5min" | "10min" | "15min" | "30min" | "hour" | "day" | "week" | "month" | "2hour" | "4hour" "1min" интервал для свечи

▪Default value cb: function= console.log

функция для обработки новых данных по свечи

▸ (x: CandleStreaming): any

Parameters:

Name Type
x CandleStreaming

Returns: (Anonymous function)

функция для отмены подписки

candlesGet

▸ candlesGet(__namedParameters: object): Promise‹Candles›

Метод для получения исторических свечей по FIGI

Parameters:

▪ __namedParameters: object

Name Type Default Description
figi string - Figi-идентификатор инструмента
from string - Начало временного промежутка в формате ISO 8601
interval "1min" | "2min" | "3min" | "5min" | "10min" | "15min" | "30min" | "hour" | "day" | "week" | "month" "1min" интервал для свечи
to string - Конец временного промежутка в формате ISO 8601

Returns: Promise‹Candles›

currencies

▸ currencies(): Promise‹MarketInstrumentList›

Метод для получения всех доступных валютных инструментов

Returns: Promise‹MarketInstrumentList›

etfs

▸ etfs(): Promise‹MarketInstrumentList›

Метод для получения всех доступных валютных ETF

Returns: Promise‹MarketInstrumentList›

instrumentInfo

▸ instrumentInfo(__namedParameters: object, cb: log): (Anonymous function)

Метод для подписки на данные по инструменту

example см. метод orderbook

Parameters:

▪ __namedParameters: object

Name Type Description
figi string идентификатор инструмента

▪Default value cb: log= console.log

функция для обработки новых данных по инструменту

Returns: (Anonymous function)

функция для отмены подписки

instrumentPortfolio

▸ instrumentPortfolio(params: InstrumentId): Promise‹PortfolioPosition | null›

Метод для получение данных по инструменту в портфеле

Parameters:

Name Type
params InstrumentId

Returns: Promise‹PortfolioPosition | null›

limitOrder

▸ limitOrder(__namedParameters: object): Promise‹PlacedLimitOrder›

Метод для выставления заявки

Parameters:

▪ __namedParameters: object

Name Type Description
figi string идентификатор инструмента
lots number количество лотов для заявки
operation "Buy" | "Sell" тип заявки
price number цена лимитной заявки

Returns: Promise‹PlacedLimitOrder›

marketOrder

▸ marketOrder(__namedParameters: object): Promise‹PlacedMarketOrder›

Метод для выставления заявки

Parameters:

▪ __namedParameters: object

Name Type Description
figi string идентификатор инструмента
lots number количество лотов для заявки
operation "Buy" | "Sell" тип заявки

Returns: Promise‹PlacedMarketOrder›

operations

▸ operations(__namedParameters: object): Promise‹Operations›

Метод для получения операций по цб по инструменту

Parameters:

▪ __namedParameters: object

Name Type Description
figi string Figi-идентификатор инструмента
from string Начало временного промежутка в формате ISO 8601
to string Конец временного промежутка в формате ISO 8601

Returns: Promise‹Operations›

orderbook

▸ orderbook(__namedParameters: object, cb: function): (Anonymous function)

Метод для подписки на данные по стакану инструмента

example

const { figi } = await api.searchOne({ ticker: 'AAPL' });
const unsubFromAAPL = api.orderbook({ figi }, (ob) => { console.log(ob.bids) });
// ... подписка больше не нужна
unsubFromAAPL();

Parameters:

▪ __namedParameters: object

Name Type Default Description
depth 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 3 -
figi string - идентификатор инструмента

▪Default value cb: function= console.log

функция для обработки новых данных по стакану

▸ (x: OrderbookStreaming): any

Parameters:

Name Type
x OrderbookStreaming

Returns: (Anonymous function)

функция для отмены подписки

orderbookGet

▸ orderbookGet(__namedParameters: object): Promise‹Orderbook›

Метод для получение стакана

Parameters:

▪ __namedParameters: object

Name Type Default Description
depth 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 3
figi string - Figi-идентификатор инструмента

Returns: Promise‹Orderbook›

orders

▸ orders(): Promise‹Order[]›

Метод для получения всех активных заявок

Returns: Promise‹Order[]›

portfolio

▸ portfolio(): Promise‹Portfolio›

Метод для получение портфеля цб

Returns: Promise‹Portfolio›

portfolioCurrencies

▸ portfolioCurrencies(): Promise‹Currencies›

Метод для получения валютных активов клиента

Returns: Promise‹Currencies›

sandboxClear

▸ sandboxClear(): Promise‹any›

Метод для очистки песочницы

Returns: Promise‹any›

search

▸ search(params: InstrumentId): Promise‹MarketInstrumentList›

Метод для поиска инструментов по figi или ticker

Parameters:

Name Type Description
params InstrumentId

Returns: Promise‹MarketInstrumentList›

searchOne

▸ searchOne(params: InstrumentId): Promise‹MarketInstrument | null›

Метод для поиска инструмента по figi или ticker

Parameters:

Name Type Description
params InstrumentId

Returns: Promise‹MarketInstrument | null›

setCurrenciesBalance

▸ setCurrenciesBalance(params: SandboxSetCurrencyBalanceRequest): Promise‹void›

Метод для задания баланса по валютам

Parameters:

Name Type Description
params SandboxSetCurrencyBalanceRequest см. описание типа

Returns: Promise‹void›

setPositionBalance

▸ setPositionBalance(params: SandboxSetPositionBalanceRequest): Promise‹void›

Метод для задания баланса по бумагам

Parameters:

Name Type Description
params SandboxSetPositionBalanceRequest см. описание типа

Returns: Promise‹void›

stocks

▸ stocks(): Promise‹MarketInstrumentList›

Метод для получения всех доступных акций

Returns: Promise‹MarketInstrumentList›