RussianInvestments / invest-api-java-sdk

Apache License 2.0
15 stars 2 forks source link

Version Release License ![GitHub Actions Status](<https://img.shields.io/github/workflow/status/RussianInvestments/invest-api-java-sdk/Java CI with Maven?logo=GitHub&style=flat-square>)

Java SDK для Tinkoff Invest API

Данный проект представляет собой инструментарий на языке Java для работы с API Тинькофф Инвестиции, который можно использовать для создания торговых роботов.

Требования

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

Для начала работы подключите к вашему проекту core-модуль

Система сборки Код
Maven \
      \ru.tinkoff.piapi\
      \java-sdk-core\
      \1.22\
\
Gradle with Groovy DSL implementation 'ru.tinkoff.piapi:java-sdk-core:1.22'
Gradle with Kotlin DSL implementation("ru.tinkoff.piapi:java-sdk-core:1.22")

После этого можно пользоваться инструментарием

import ru.tinkoff.piapi.core.InvestApi;

var token = "<secret-token>";
var api = InvestApi.create(token);

var order = api.getOrdersService().postOrderSync(...)

Для разработчиков

В main ветке snapshot версия следующего (разрабатываемого) релиза. Последний стабильный релиз отмечается тэгом с соответствующим номером релиза. Для внесения изменения и предложений по sdk сделайте fork репозитария, создайте ветку от main, внесите доработки и создайте pull request в этот репозиторий.

Сборка

JVM

Шаги для сборки: 1) скачать репозиторий git pull https://github.com/RussianInvestments/invest-api-java-sdk.git 2) перейдите в директорию проекта командой cd invest-api-java-sdk 3) для сборки перейдите в директорию проекта и соберите проект командой mvn clean package

Native

Для сборки native образа потребуется добавить зависимость от native-image-support в свой проект:

Maven:

<dependency>
 <groupId>com.google.cloud</groupId>
 <artifactId>native-image-support</artifactId>
 <version>0.14.1</version>
</dependency>

Gradle:

implementation 'com.google.cloud:native-image-support:0.14.1'

К аргументам сборки GraalVM необходимо добавить:

--initialize-at-build-time=ch.qos.logback,org.slf4j.LoggerFactory,org.slf4j.simple.SimpleLogger,org.slf4j.impl.StaticLoggerBinder,org.slf4j.MDC

Предложения и пожелания к SDK

Смело выносите свои предложения в Issues, задавайте вопросы. Pull Request'ы также принимаются.

У меня есть вопрос по работе API

Документация к API находится в отдельном репозитории. Там вы можете задать вопрос в Issues.