https://github.com/nyg/kraken-api-java
Java library to query the Kraken REST API.
https://github.com/nyg/kraken-api-java
balance bitcoin eoy kraken kraken-api kraken-exchange-api staking-rewards
Last synced: 9 months ago
JSON representation
Java library to query the Kraken REST API.
- Host: GitHub
- URL: https://github.com/nyg/kraken-api-java
- Owner: nyg
- License: isc
- Created: 2015-10-16T22:34:02.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-03-01T03:05:23.000Z (10 months ago)
- Last Synced: 2025-03-31T14:13:46.852Z (9 months ago)
- Topics: balance, bitcoin, eoy, kraken, kraken-api, kraken-exchange-api, staking-rewards
- Language: Java
- Homepage: https://central.sonatype.com/artifact/dev.andstuff.kraken/kraken-api
- Size: 222 KB
- Stars: 56
- Watchers: 7
- Forks: 28
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Kraken API client for Java
[](https://central.sonatype.com/artifact/dev.andstuff.kraken/kraken-api)
Query [Kraken's REST API][1] in Java.
## Maven
```xml
dev.andstuff.kraken
kraken-api
2.1.0
```
## Examples
The `examples` folder contains real-world examples that make use of this library. For most examples, you'll need to provide your API keys: rename `api-keys.properties.example`, located in `examples/src/main/resources`, to `api-keys.properties` and fill in your API keys. The examples can be run directly from your IDE, or using the command line:
```shell
# clone and build project
git clone https://github.com/nyg/kraken-api-java.git
cd kraken-api-java
mvn clean install
# run the staking rewards summary example
mvn -pl examples exec:java -Dexec.mainClass=dev.andstuff.kraken.example.StakingRewardsSummaryExample
```
### Staking Rewards Summary
This example will generate the `rewards-summary.csv` file, showing how much crypto rewards have been earned since the creation of your account. A picture is worth a thousand words:
### End-of-Year Balance
This example will generate the `eoy-balance.csv` file, showing the balance of your account at a given point in time. If you run the example from your IDE, modify the `dateTo` in `EoyBalanceExample.java`. Otherwise, you can run the example from the command line:
```sh
mvn -pl examples exec:java -Dexec.mainClass=dev.andstuff.kraken.example.EoyBalanceExample -Dexec.args="2025-01-31T00:00:00Z"
```
## Libary usage
### Public endpoints
Public endpoints that have been implemented by the library, can be queried in the following way:
```java
KrakenAPI api = new KrakenAPI();
Map assets = api.assetInfo(List.of("BTC", "ETH"));
// {BTC=AssetInfo[assetClass=currency, alternateName=XBT, maxDecimals=10, …
Map pairs = api.assetPairs(List.of("ETH/BTC", "ETH/USD"));
// {ETH/BTC=AssetPair[alternateName=ETHXBT, webSocketName=ETH/XBT, …
```
If the endpoint has not yet been implemented (feel free to submit a PR!), the generic `query` method can be used, which will return a `JsonNode` of the [Jackson][2] deserialization libary:
```java
JsonNode ticker = api.query(KrakenAPI.Public.TICKER, Map.of("pair", "XBTEUR"));
// {"XXBTZEUR":{"a":["62650.00000","1","1.000"],"b":["62649.90000","6","6.000"], …
```
It's also possible to specify the path directly, in case a new endpoint has been added by Kraken and not yet added in the library:
```java
JsonNode trades = api.queryPublic("Trades", Map.of("pair", "XBTUSD", "count", "1"));
// {"XXBTZUSD":[["68515.60000","0.00029628",1.7100231295628998E9,"s","m","",68007835]], …
```
### Private endpoints
Private endpoints can be queried in the same way as the public ones, but an API key and secret must be provided to the `KrakenAPI` instance:
```java
KrakenAPI api = new KrakenAPI("my key", "my secret");
JsonNode balance = api.query(KrakenAPI.Private.BALANCE);
// {"XXBT":"1234.8396278900", … :)
```
If the Kraken API call returns an error, an unchecked exception of type `KrakenException` is thrown:
```java
// API key doesn't have the permission to create orders
JsonNode order = api.query(KrakenAPI.Private.ADD_ORDER, Map.of(
"ordertype", "limit", "type", "sell",
"volume", "1", "pair", "XLTCZUSD",
"price", "1000", "oflags", "post,fciq",
"validate", "true"));
// Exception in thread "main" KrakenException(errors=[EGeneral:Permission denied])
```
### Custom REST requester
The current implementation of the library uses the JDK's HttpsURLConnection to make HTTP request. If that doesn't suit your needs and wish to use something else (e.g. Spring RestTemplate, Apache HttpComponents, OkHttp), you can implement the KrakenRestRequester interface and pass it to the KrakenAPI constructor:
```java
public class MyRestTemplateRestRequester implements KrakenRestRequester {
public T execute(PublicEndpoint endpoint) { /* your implementation */ }
public T execute(PrivateEndpoint endpoint) { /* your implementation */ }
}
KrakenAPI api = new KrakenAPI(MyRestTemplateRestRequest(apiKey, apiSecret));
```
See `DefaultKrakenRestRequester` for the default implementation.
### Custom nonce generator
For private endpoint requests, the nonce value is set to `System.currentTimeMillis()`. If you wish to use another value, you can specify a custom nonce generator when creating the `KrakenAPI` instance:
```java
KrakenAPI api = new KrakenAPI(
new KrakenCredentials(key, secret),
() -> Long.toString(System.currentTimeMillis() / 1000));
```
The second parameter is of type `KrakenNonceGenerator`, an interface containing a single `generate()` method returning a string.
[1]: https://docs.kraken.com/rest/
[2]: https://github.com/FasterXML/jackson
[3]: https://github.com/nyg/kraken-api-java/blob/v1.0.0/examples/src/main/java/dev/andstuff/kraken/example/Examples.java