Инициализация класса
import { SandboxService } from '@tomasevich/tinkoff'
// Для работы с реальными данными
const realServer = new SandboxService('<REAL_TOKEN>', false)
// Для работы с данными в тестовом режиме
const sandboxServer = new SandboxService('<SANDBOX_TOKEN>', true)
Токен приложения
Флаг включения режима Песочницы
Метод получения брокерского отчёта
import { OperationsService } from '@tomasevich/tinkoff'
const operationsService = new OperationsService('<TOKEN>', true)
const brokerReport = await operationsService.GetBrokerReport({
generateBrokerReportRequest: {
accountId: '<ACCOUNT_ID>',
from: '2023-07-18T00:00:00:000Z',
to: '2023-08-19T00:00:00:000Z'
},
getBrokerReportRequest: { taskId: '', page: 0 }
})
console.log(brokerReport)
Метод получения отчёта "Справка о доходах за пределами РФ"
import { OperationsService } from '@tomasevich/tinkoff'
const operationsService = new OperationsService('<TOKEN>', true)
const dividendsForeignIssuer = await operationsService.GetDividendsForeignIssuer({
generateDivForeignIssuerReport: {
accountId: '<ACCOUNT_ID>',
from: '2023-07-18T00:00:00:000Z',
to: '2023-08-19T00:00:00:000Z'
},
getDivForeignIssuerReport: { taskId: '', page: 0 }
})
console.log(dividendsForeignIssuer)
Метод получения списка операций по счёту
import { OperationsService, OperationState } from '@tomasevich/tinkoff'
const operationsService = new OperationsService('<TOKEN>', true)
const { operations } = await operationsService.GetOperations({
accountId: '<ACCOUNT_ID>',
from: '2023-07-18T00:00:00:000Z',
to: '2023-08-19T00:00:00:000Z',
state: OperationState.OPERATION_STATE_CANCELED,
figi: 'BBG00YTS96G2'
})
console.log(operations)
При работе с данным методом необходимо учитывать особенности взаимодействия с данным методом
https://tinkoff.github.io/investAPI/operations/#getoperations
Метод получения списка операций по счёту с пагинацией
import { OperationsService, OperationState, OperationType } from '@tomasevich/tinkoff'
const operationsService = new OperationsService('<TOKEN>', true)
const operationsByCursor = await operationsService.GetOperationsByCursor({
accountId: '<ACCOUNT_ID>',
instrumentId: '6afa6f80-03a7-4d83-9cf0-c19d7d021f76',
from: '2023-07-18T00:00:00:000Z',
to: '2023-08-19T00:00:00:000Z',
cursor: '',
limit: 10,
state: OperationState.OPERATION_STATE_CANCELED,
operationTypes: [
OperationType.OPERATION_TYPE_BUY,
OperationType.OPERATION_TYPE_SELL
],
withoutCommissions: false,
withoutTrades: false,
withoutOvernights: false
})
console.log(operationsByCursor)
При работе с данным методом необходимо учитывать особенности взаимодействия с данным методом
https://tinkoff.github.io/investAPI/operations/#getoperationsbycursor
Метод получения портфеля по счёту
import { OperationsService, PortfolioRequestCurrencyRequest } from '@tomasevich/tinkoff'
const operationsService = new OperationsService('<TOKEN>', true)
const portfolio = await operationsService.GetPortfolio({
accountId: '<ACCOUNT_ID>',,
currency: PortfolioRequestCurrencyRequest.RUB
})
console.log(portfolio)
Метод получения списка позиций по счёту
import { OperationsService } from '@tomasevich/tinkoff'
const operationsService = new OperationsService('<TOKEN>', true)
const positions = await operationsService.GetPositions({
accountId: '<ACCOUNT_ID>'
})
console.log(positions)
Метод получения доступного остатка для вывода средств
import { OperationsService } from '@tomasevich/tinkoff'
const operationsService = new OperationsService('<TOKEN>', true)
const withdrawLimits = await operationsService.GetWithdrawLimits({
accountId: '<ACCOUNT_ID>'
})
console.log(withdrawLimits)
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/operations/#operationsservice