Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.47 KB

Readme.md

File metadata and controls

53 lines (35 loc) · 2.47 KB
Raw

Java client library for LAtoken exchange

Java library for interacting with Latoken API, providing complete API coverage, and supporting synchronous and asynchronous requests, as well as event streaming via WebSockets.

Installation

Clone this project and run mvn install to add the library to your local repository, or add as a dependency to your pom.xml

<dependency>
    <groupId>com.latoken</groupId>
    <artifactId>latoken-java-client</artifactId>
    <version>1.0.0</version>
</dependency>

for gradle add this to your dependencies section

implementation("com.latoken.latoken-java-client:1.0.0")

How to use

There are many examples available in /src/test/java, however your entry point is always static class Latoken which will have methods to create both REST and Websocket clients.

All threads created by this library are daemon threads.

Logging is done via slf4j, if you use it your existing logging implementation will be used within the library.

Before starting to use the library make sure to generate your api keys.

// for REST v2 api simply do
Latoken.asyncClientV2("your-key", "your-secret")
// for Websocket api
Latoken.websocketV2Client("your-key", "your-secret");

After that api is quite straight forward. All async rest calls return CompletableFuture<T> and all websocket calls take a subscriber/consumer Consumer<T> and return a Subscription which you can use to unsubscribe from topic.

Make sure to to .start() websocket client before any subscriptions and use .stop() to gracefully shutdown websocket client.

Note that api that is marked @Experimental may change with future versions, we seek community feedback before finalizing the api, so please don't hesitate to engage with the project via Github Issues. We will be actively maintaining this project to provide the best possible api experience for our customers.

How to contribute

Before you work on the code there are few simple conventions in this project to keep in mind.

  • Mark all your classes final unless they are meant to be extended.
  • Take advantage of package visibility to not leak any unnecessary classes outside the project.
  • Do not create non daemon threads.
  • No checked exceptions, only exception we can throw from any of the library functions is LatokenApiException with as much detail captured as possible causing it.