Skip to content

Latest commit

 

History

History
61 lines (53 loc) · 3.36 KB

README.md

File metadata and controls

61 lines (53 loc) · 3.36 KB

tinkoff_exporter

Prometheus экспортер данных из OpenAPI Тинькофф Инвестиции.

Метрики

Название Описание Метки
currency Остатки денег на счёту currency – валюта
currency_blocked Заблокированная сумма на счету currency – валюта
stock Цена отдельной бумаги currency – валюта, in_portfolio – наличие в портфеле, ticker – тикер бумаги, type – типа ценной бумаги (Etf - ETF, Stock - акция, Bond – облигация)
stock_count Колличество бумаг в портфеле ticker – тикер бумаги, type – типа ценной бумаги (Etf - ETF, Stock - акция, Bond – облигация)
stock_expected_yield Ожидаемая на настоящий момент доходность по бумаге currency – валюта, ticker – тикер бумаги, type – типа ценной бумаги (Etf - ETF, Stock - акция, Bond – облигация)
total Итоговая сумма на счёте по текущему курсу
total_payin Общая сумма пополнений счёта
total_payout Общая сумма выведенных средств со счёта
xirr Внутренняя ставка доходности

Параметры

Единственным обязательным аргументом для запуска программы является token (инструкция по получению токена). Он может быть передан либо как переменная окружения TINKOFF_EXPORTER_TOKEN либо как часть конфигурационного файла config.yml:

---
endpoint: "/metrics"
port: 8000
token: "t.TOKEN"
tickers:
  - "YNDX"
  - "MTSS"
sectors:
  materials:
    - GMKN
  industrials:
    - CAT
    - AFLT
  utilities: []
  consumer_cyclical:
    - BABA
    - DHI
    - GM
    - DSKY
  technology:
    - AMAT
  information_technology:
    - YNDX
    - TCBR
Параметр Описание Переменная окружения Значение по умолчанию
endpoint Путь на котором будут отдаваться метрики TINKOFF_EXPORTER_ENDPOINT /metrics
port Порт на котором будет отвечать сервис TINKOFF_EXPORTER_PORT 8000
token Токен доступа к OpenAPI TINKOFF_EXPORTER_TOKEN
tickers Список тикеров тех ценных бумаг котрых у вас в портфеле нет но вы, тем не менее, хотите собирать по ним статистику TINKOFF_EXPORTER_TICKERS []
sectors Список секторов и ценных бумаг в них, заполняется вручную, под потребности

Запуск в Docker

docker run -p 8000:8000 --env TINKOFF_EXPORTER_TOKEN=t.token maksim77/tinkoff_exporter