Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oshliaer/tinkoff-rest-api-via-google-apps-script
Обёртка Tinkoff API на Google Apps Script (не официальная)
https://github.com/oshliaer/tinkoff-rest-api-via-google-apps-script
Last synced: 4 days ago
JSON representation
Обёртка Tinkoff API на Google Apps Script (не официальная)
- Host: GitHub
- URL: https://github.com/oshliaer/tinkoff-rest-api-via-google-apps-script
- Owner: oshliaer
- Created: 2021-01-11T17:08:35.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-11T14:11:09.000Z (almost 4 years ago)
- Last Synced: 2024-04-09T21:12:33.251Z (7 months ago)
- Homepage: https://tinkoffcreditsystems.github.io/invest-openapi/
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
TinkoffApp
========
Обёртка Tinkoff API на Google Apps Script
## Ключ библиотеки
```
1uEtkgmmDPIQJ607pToZJX-0R2xa3g2hEw2Jx3KZmUni93T7FH2Vf4th1
```
## Версии
[https://script.google.com/macros/library/versions/d/1uEtkgmmDPIQJ607pToZJX-0R2xa3g2hEw2Jx3KZmUni93T7FH2Vf4th1](https://script.google.com/macros/library/versions/d/1uEtkgmmDPIQJ607pToZJX-0R2xa3g2hEw2Jx3KZmUni93T7FH2Vf4th1)
## Как использовать
### Кратко
1. Подключите библиотеку `TinkoffApp` к своему проекту - [Инструкция](https://developers.google.com/apps-script/guide_libraries?hl=ru)
2. Получите API токен в [кабинете Тинькофф Инвестиции](https://www.tinkoff.ru/invest/)
3. Пользуйтесь
```javascript
function myFunction() {
// Настройка
const token = '1234567890'; // укажите здесь свой токен
// Создаём API
var tAPI = TinkoffApp.auth(token);
// Используем API
var my_balance = tAPI.portfolioCurrencies(); // например, получаем валютные активы
}
```
### Чуть подробнее
Все методы аналогичны указанным в официальной документации - https://tinkoffcreditsystems.github.io/invest-openapi/swagger-ui/
Названия методов в библиотеке сформированы из пути обращения, с капитализацией первого символа идушего за спецсимволами, и удалением спецсимволов:
```
/market/search/by-ticker -> .marketSearchByTicker()
```
#### Методы
sandbox
- .sandboxRegister() - Регистрация клиента в sandbox
- .sandboxCurrenciesBalance(request, brokerAccountId) - Выставление баланса по валютным позициям
- .sandboxPositionsBalance(request, brokerAccountId) - Выставление баланса по инструментным позициям
- .sandboxRemove(brokerAccountId) - Удаление счета
- .sandboxClear(brokerAccountId) - Удаление всех позиций
orders
- .orders(brokerAccountId) - Получение списка активных заявок
- .ordersLimitOrder(request, figi, brokerAccountId) - Создание лимитной заявки
- .ordersMarketOrder(request, figi, brokerAccountId) - Создание рыночной заявки
- .ordersCancel(orderId, brokerAccountId) - Отмена заявки
portfolio
- .portfolio(brokerAccountId) - Получение портфеля клиента
- .portfolioCurrencies(brokerAccountId) - Получение валютных активов клиента
market
- .marketStocks() - Получение списка акций
- .marketBonds() - Получение списка облигаций
- .marketEtfs() - Получение списка ETF
- .marketCurrencies() - Получение списка валютных пар
- .marketOrderbook(figi, depth) - Получение стакана по FIGI
- .marketCandles(figi, from, to, interval) - Получение исторических свечей по FIGI
- .marketSearchByFigi(figi) - Получение инструмента по FIGI
- .marketSearchByTicker(ticker) - Получение инструмента по тикеру
operations
- .operations(from, to, figi, brokerAccountId) - Получение списка операций
user
- .userAccounts() - Получение брокерских счетов клиента