Инициализация класса
import { SandboxService } from '@tomasevich/tinkoff'
// Для работы с реальными данными
const realServer = new SandboxService('<REAL_TOKEN>', false)
// Для работы с данными в тестовом режиме
const sandboxServer = new SandboxService('<SANDBOX_TOKEN>', true)
Токен приложения
Флаг включения режима Песочницы
Метод получения облигации по её идентификатору
import { InstrumentsService, InstrumentIdType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instrument } = await instrumentsService.BondBy({
idType: InstrumentIdType.INSTRUMENT_ID_TYPE_TICKER,
classCode: 'TQCB',
id: 'RU000A105WZ4'
})
console.log(instrument)
Метод получения списка облигаций
import { InstrumentsService, InstrumentStatus } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.Bonds({
instrumentStatus: InstrumentStatus.INSTRUMENT_STATUS_BASE
})
console.log(instruments)
Метод получения списка валют
import { InstrumentsService, InstrumentStatus } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.Currencies({
instrumentStatus: InstrumentStatus.INSTRUMENT_STATUS_BASE
})
console.log(instruments)
Метод получения валюты по её идентификатору
import { InstrumentsService, InstrumentIdType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instrument } = await instrumentsService.CurrencyBy({
idType: InstrumentIdType.INSTRUMENT_ID_TYPE_TICKER,
classCode: 'CETS',
id: 'AMDRUB_TOM'
})
console.log(instrument)
Метод редактирования списка избранных инструментов
import { InstrumentsService, EditFavoritesActionType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { favoriteInstruments } = await instrumentsService.EditFavorites({
instruments: [{ figi: 'BBG00YTS96G2' }],
actionType: EditFavoritesActionType.EDIT_FAVORITES_ACTION_TYPE_ADD
})
console.log(favoriteInstruments)
Метод получения инвестиционного фонда по его идентификатору
import { InstrumentsService, InstrumentIdType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instrument } = await instrumentsService.EtfBy({
idType: InstrumentIdType.INSTRUMENT_ID_TYPE_TICKER,
classCode: 'SPBXM',
id: 'DRIV'
})
console.log(instrument)
Метод получения списка инвестиционных фондов
import { InstrumentsService, InstrumentStatus } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.Etfs({
instrumentStatus: InstrumentStatus.INSTRUMENT_STATUS_BASE
})
console.log(instruments)
Метод поиска инструмента
import { InstrumentsService, InstrumentType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.FindInstrument({
query: 'Tinkoff',
instrumentKind: InstrumentType.INSTRUMENT_TYPE_SHARE,
apiTradeAvailableFlag: true
})
console.log(instruments)
Метод получения фьючерса по его идентификатору
import { InstrumentsService, InstrumentIdType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instrument } = await instrumentsService.FutureBy({
idType: InstrumentIdType.INSTRUMENT_ID_TYPE_TICKER,
classCode: 'SPBFUT',
id: 'GKZ3'
})
console.log(instrument)
Метод получения списка фьючерсов
import { InstrumentsService, InstrumentStatus } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.Futures({
instrumentStatus: InstrumentStatus.INSTRUMENT_STATUS_BASE
})
console.log(instruments)
Метод получения накопленного купонного дохода по облигации
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { accruedInterests } = await instrumentsService.GetAccruedInterests({
figi: 'TCS00A105WZ4',
from: '2023-07-12T00:00:00:000Z',
to: '2023-07-13T23:59:59:999Z'
})
console.log(accruedInterests)
Метод получения актива по его идентификатору
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const asset = await instrumentsService.GetAssetBy({
id: 'b6a73950-20a8-46c7-8b49-9dfbc14fe0ba'
})
console.log(asset)
Метод получения списка активов
import { InstrumentsService, InstrumentType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { assets } = await instrumentsService.GetAssets({
instrumentType: InstrumentType.INSTRUMENT_TYPE_BOND
})
console.log(assets)
Метод работает для всех инструментов, за исключением срочных - опционов и фьючерсов
Метод получения графика выплат купонов по облигации
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { events } = await instrumentsService.GetBondCoupons({
figi: 'TCS00A105WZ4',
from: '2023-07-12T00:00:00:000Z',
to: '2023-07-13T23:59:59:999Z'
})
console.log(events)
Метод получения бренда по его идентификатору
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const brand = await instrumentsService.GetBrandBy({
id: '8c478c0a-c4e3-412c-ab4d-a2df4648d97f'
})
console.log(brand)
Метод получения списка брендов
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { brands } = await instrumentsService.GetBrands({})
console.log(brands)
Метод получения списка стран
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { countries } = await instrumentsService.GetCountries({})
console.log(countries)
Метод для получения событий выплаты дивидендов по инструменту
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { dividends } = await instrumentsService.GetDividends({
figi: 'BBG00YTS96G2',
from: '2023-07-12T00:00:00:000Z',
to: '2023-07-13T23:59:59:999Z'
})
console.log(dividends)
Метод получения списка избранных инструментов
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { favoriteInstruments } = await instrumentsService.GetFavorites({})
console.log(favoriteInstruments)
Метод получения размера гарантийного обеспечения по фьючерсам
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const futuresMargin = await instrumentsService.GetFuturesMargin({
figi: 'FUTGMKN12230'
})
console.log(futuresMargin)
Метод получения основной информации об инструменте
import { InstrumentsService, InstrumentIdType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.GetInstrumentBy({
idType: InstrumentIdType.INSTRUMENT_ID_TYPE_TICKER,
classCode: 'SPBXM',
id: 'APA'
})
console.log(instruments)
Метод получения опциона по его идентификатору
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instrument } = await instrumentsService.OptionBy({
idType: InstrumentIdType.INSTRUMENT_ID_TYPE_TICKER,
classCode: 'SPBFUT',
id: 'GKZ3'
})
console.log(instrument)
Метод получения списка опционов
import { InstrumentsService, InstrumentStatus } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.Options({
instrumentStatus: InstrumentStatus.INSTRUMENT_STATUS_BASE
})
console.log(instruments)
В документации указано как Deprecated, хотя метод работает
Метод получения списка опционов
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.OptionsBy({
basicAssetUid: 'b6a73950-20a8-46c7-8b49-9dfbc14fe0ba',
basicAssetPositionUid: ''
})
console.log(instruments)
Метод получения акции по её идентификатору
import { InstrumentsService, InstrumentIdType } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.ShareBy({
idType: InstrumentIdType.INSTRUMENT_ID_TYPE_TICKER,
classCode: 'SPBXM',
id: 'APA'
})
console.log(instruments)
Метод получения списка акций
import { InstrumentsService, InstrumentStatus } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { instruments } = await instrumentsService.Shares({
instrumentStatus: InstrumentStatus.INSTRUMENT_STATUS_BASE
})
console.log(instruments)
Метод получения расписания торгов торговых площадок
import { InstrumentsService } from '@tomasevich/tinkoff'
const instrumentsService = new InstrumentsService('<TOKEN>', true)
const { exchanges } = await instrumentsService.TradingSchedules({
from: '2023-07-12T00:00:00:000Z',
to: '2023-07-13T23:59:59:999Z',
exchange: 'MOEX_MORNING'
})
console.log(exchanges)
Protected requestМетод HTTP запроса к серверу Tinkoff Invest API
import { Common } from '@tomasevich/tinkoff'
class Application extends Common {
public SandboxService(body) {
return this.request('SandboxService', 'GetSandboxOrders', body)
}
}
const app = new Application('<TOKEN>', true)
const { orders } = await app.SandboxService({
accountId: '<ACCOUNT_ID>'
})
console.log(orders)
Имя сервиса
Имя операции
Тело запроса
Static MoneyСтатичный метод конвертирования денежной суммы в определенной валюте в строку
import { Common } from '@tomasevich/tinkoff'
console.log(Common.MoneyValueToString({ units: '114', nano: 250000000, currency: 'rub' })) // '114.25 rub'
console.log(Common.MoneyValueToString({ units: '-200', nano: -200000000, currency: 'usd' })) // '-200.20 usd'
console.log(Common.MoneyValueToString({ units: '-0', nano: -10000000, currency: 'eur' })) // '-0.01 eur'
Static QuotationСтатичный метод конвертирования котировки в строку
import { Common } from '@tomasevich/tinkoff'
console.log(Common.QuotationToString({ units: '114', nano: 250000000 })) // '114.25'
console.log(Common.QuotationToString({ units: '-200', nano: -200000000 })) // '-200.20'
console.log(Common.QuotationToString({ units: '-0', nano: -10000000 })) // '-0.01'
Static StringСтатичный метод конвертирования строки в денежную сумму в определенной валюте
import { Common } from '@tomasevich/tinkoff'
console.log(Common.StringToMoneyValue('114.25 rub')) // { units: '114', nano: 250000000, currency: 'rub' }
console.log(Common.StringToMoneyValue('-200.20 usd')) // { units: '-200', nano: -200000000, currency: 'usd' }
console.log(Common.StringToMoneyValue('-0.01 eur')) // { units: '-0', nano: -10000000, currency: 'eur' }
Static StringСтатичный метод конвертирования строки в котировку
import { Common } from '@tomasevich/tinkoff'
console.log(Common.StringToQuotation('114.25')) // { units: '114', nano: 250000000 }
console.log(Common.StringToQuotation('-200.20')) // { units: '-200', nano: -200000000 }
console.log(Common.StringToQuotation('-0.01')) // { units: '-0', nano: -10000000 }
Generated using TypeDoc
Сервис предназначен для получения:
See
https://tinkoff.github.io/investAPI/instruments/#instrumentsservice