Tinkoff Invest API

Неофициальная библиотека для работы с Тинькофф Инвестиции

Мотивация

• Отсутствует официальная библиотека для зыков JavaScript/TypeScript
• Swagger v1.4 покрывает все API, но толком не описан
• Документация v1.5 описана с ошибками, но отличается от Swagger

Приемущества

• 0 зависимостей
• Просканировано CodeQL и Dependabot
• Написано на Typescript
• Покрыто тестами Jest
• Покрыто документацией TypeDoc
• Тонна реальных Примеров

Сообщество

• Проект на GitHub
• Документация по API
• Обсуждения идей
• Предложения по развитию

Установка

npm i @tomasevich/tinkoff
Copy

Настройка

Для получения Токена читаем инструкцию

Использование

Остальные примеры можно найти в описании к методам

import { SandboxService } from '@tomasevich/tinkoff'

const sandboxService = new SandboxService('<TOKEN>', true)
const { orders } = await sandboxService.GetSandboxOrders({
  accountId: '<ACCOUNT_ID>'
})

console.log(orders)
Copy

Разработка

Тестирование

Для запуска тестов, необходимо настроить переменные окружения

1. Копируем настройки окружения

cp .env .env.test
Copy

2. Заполняем поля своими данными и запускаем тесты (с покрытием)

npm run test:coverage
Copy

Контрибютерам

1. Кодекс поведения
2. Руководство по содействию
3. Политика безопасности