README.md
# An unofficial Java implementation of the Bitfinex Websocket (v2) API
<a href="https://github.com/jnidzwetzki/bitfinex-v2-wss-api-java/actions/workflows/build.yml">
<img alt="Build Status" src="https://github.com/jnidzwetzki/bitfinex-v2-wss-api-java/actions/workflows/build.yml/badge.svg">
</a><a href="https://repo1.maven.org/maven2/com/github/jnidzwetzki/bitfinex-v2-wss-api/"><img alt="Maven Central Version" src="https://maven-badges.herokuapp.com/maven-central/com.github.jnidzwetzki/bitfinex-v2-wss-api/badge.svg" />
</a><a href="https://codecov.io/gh/jnidzwetzki/bitfinex-v2-wss-api-java">
<img src="https://codecov.io/gh/jnidzwetzki/bitfinex-v2-wss-api-java/branch/master/graph/badge.svg" />
</a><a href="https://scan.coverity.com/projects/jnidzwetzki-bitfinex-v2-wss-api-java">
<img alt="Coverity Scan Build Status"
src="https://scan.coverity.com/projects/14740/badge.svg"/>
</a><a href="http://makeapullrequest.com">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" />
</a><a href="https://codeclimate.com/github/jnidzwetzki/bitfinex-v2-wss-api-java/maintainability">
<img src="https://api.codeclimate.com/v1/badges/9bb1a95de6767a8c6820/maintainability" />
</a><a href="https://gitter.im/bitfinex-v2-wss-api-java/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
<img alt="Join the chat at https://gitter.im/bitfinex-v2-wss-api-java/Lobby" src="https://badges.gitter.im/Join%20Chat.svg">
</a><a href='https://sourcespy.com/github/bitfinex/' title='SourceSpy Dashboard'><img src='https://sourcespy.com/shield.svg'/></a>
This project provides a Java client library for the [Bitfinex WebSocket API (v2)](https://docs.bitfinex.com/v2/reference). Public and private channels (candles, ticks, executed trades, (raw) orderbooks, orders, and wallets) are implemented.
In contrast to other implementations, this project uses the WSS (_web socket secure_) streaming API of Bitfinex. Most other projects are poll the REST-API periodically, which leads to delays in data processing. In this implementation, you can register callback methods on ticks, candles or orders. The callbacks are executed, as soon as new data is received from Bitfinex (see the examples section for more details).
**Warning:** Trading carries significant financial risk; you could lose a lot of money. If you are planning to use this software to trade, you should perform many tests and simulations first. This software is provided 'as is' and released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
## Contact / Stay informed
* If you like the project, please star it on GitHub!
* You need help or do you have questions? Join our chat at [gitter](https://gitter.im/bitfinex-v2-wss-api-java/Lobby).
* For reporting issues, visit our [bug tracking system](https://github.com/jnidzwetzki/bitfinex-v2-wss-api-java/issues).
* For contributing, see our [contributing guide](https://github.com/jnidzwetzki/bitfinex-v2-wss-api-java/blob/master/CONTRIBUTING.md). Project architecture outline can be found [here](https://sourcespy.com/github/bitfinex/).
* You are interested in a crypto currency trading bot? See my [crypto-bot](https://github.com/jnidzwetzki/crypto-bot) project.
* You need a highly available MySQL server for your trading? Have a look at the following [project](https://github.com/jnidzwetzki/mysql-ha-cloud).
* For more information see [https://github.com/jnidzwetzki](https://github.com/jnidzwetzki).
# Examples
You will find some examples [here](https://github.com/jnidzwetzki/bitfinex-v2-wss-api-java/blob/master/EXAMPLES.md).
# Usage
Check for latest version of library at https://mvnrepository.com/artifact/com.github.jnidzwetzki/bitfinex-v2-wss-api
## Maven
Add these lines to your ``pom.xml`` file
```xml
<dependency>
<groupId>com.github.jnidzwetzki</groupId>
<artifactId>bitfinex-v2-wss-api</artifactId>
<version>${bitfinex-v2-wss-api.version}</version>
</dependency>
```
## Gradle
Add these lines to your ``build.gradle`` file
```groovy
compile 'com.github.jnidzwetzki:bitfinex-v2-wss-api:${bitfinex-v2-wss-api.version}'
```
# Changelog
You will find the changelog of the project [here](https://github.com/jnidzwetzki/bitfinex-v2-wss-api-java/blob/master/CHANGELOG.md).
# Recent API changes
## Version 0.7.1
The old order flags are deprecated by Bitfinex and replaced by the new 'WSv2 order flag'. This change is adapted in this version. Methods like `BitfinexOrderBuilder.setHidden()` or `BitfinexOrderBuilder.setReduce()` are replaced by `BitfinexOrderBuilder.withOrderFlag(BitfinexOrderFlag)`.
## Version 0.7.0
Major refactoring has been made around the library. Library is operating in non-blocking manner fully from this version.
User may register handlers to listen on upcoming server events through exposed callbacks API.
Review [Low-level channel subscriptions](https://github.com/jnidzwetzki/bitfinex-v2-wss-api-java/blob/master/EXAMPLES.md#Low-level-channel-subscription) section of Examples for more details.
``BitfinexCurrencyPair`` is no longer auto-registering currency pairs in JVM. User should call BitfinexCurrencyPair#registerDefaults() explicitily if one wishes to use them.
## Version 0.6.9
The class ``BitfinexCurrencyPair`` now supports dynamic currency creation. Therefore, the old enum consts are removed.
```java
# Old (version <= 0.6.8)
BitfinexCurrencyPair.BTC_USD
# New (version > 0.6.8)
BitfinexCurrencyPair.of("BTC","USD")
```
## Version 0.6.7
The class ``BitfinexTick`` was renamed to ``BitfinexCandle`` and a new class for ticks was introduced.
## Version 0.6.3
Starting with version 0.6.3 the value for uninitialized BigDecimal values was unified to null (in version 0.6.2 sometimes -1 and sometimes null was used).
<details>
<summary>View Details</summary>
The BitfinexTick.INVALID_VOLUME is removed and replaced by a Java 8 optional
```java
# Old (version <= 0.6.2)
if (tick.getVolume() != BitfinexTick.INVALID_VOLUME) {
tick.getVolume().doubleValue()
}
# New (version > 0.6.2)
if(tick.getVolume().isPresent()) {
tick.getVolume().get().doubleValue()
}
```
</details>
## Version 0.6.2
Since version 0.6.2, the double data type is replaced by the BigDecimal data type for increased precision.
## Version 0.6.1
Since version 0.6.1, the Wallets are new managed by the Wallet manager.
<details>
<summary>View Details</summary>
The WalletManager provides the same methods as the BitfinexAPIBroker in previous versions. Execute your wallet related calls on the new WalletManager.
```java
# Old (version <= 0.6.0)
bitfinexClient.getWallets();
# New (version > 0.6.0)
bitfinexClient.getWalletManager().getWallets();
```
</details>
## Version 0.6.0
With version 0.6.0 the [ta4j](https://github.com/ta4j/ta4j) dependency was removed.
<details>
<summary>View Details</summary>
For quotes, the API implementation now returns instances of the class `BitfinexTick`. To convert a `BitfinexTick` into a ta4j `Bar`, you can use the following code:
```java
final BitfinexTick tick = ....;
final Instant instant = Instant.ofEpochMilli(tick.getTimestamp());
final ZonedDateTime time = ZonedDateTime.ofInstant(instant, Const.BITFINEX_TIMEZONE);
final Bar bar = new BaseBar(time, tick.getOpen().doubleValue(),
tick.getHigh().doubleValue(),
tick.getLow().doubleValue(),
tick.getClose().doubleValue(),
tick.getVolume().orElse(BigDecimal.ZERO).doubleValue());
```
</details>