bitflyer4j

🇺🇸 English
🇯🇵 日本語

Overview

bitflyer4j (bitFlyer for Java) is a Java wrapper library for the bitFlyer Lightning API.

bitFlyer is a crytocurrency exchange based in Japan, offering JSON+REST API just like many of the other bitcoin and altcoin exchanges. This library aims to capsulize the raw message formats and protocols, and provide a strictly-typed API library in addition to the handy features.

Strictly-typed method calls, parameters and return types.
Asynchronous method calls with java.util.concurrent.CompletableFuture for background message queueing/throttling and method chaining.
Out-of-the-box listener callbacks for realtime data subscriptions.
Private API tokens actually kept private.
Battle-tested by the author.

Getting Started

Download

Use Maven or Gradle to automatically fetch the library jars and its dependencies from The Central Repository.

Maven (`pom.xml`)

<dependency>
    <groupId>com.after_sunrise.cryptocurrency</groupId>
    <artifactId>bitflyer4j</artifactId>
    <version>${VERSION}</version>
</dependency>

Sample Codes

Copy and paste the following code snippets into the main and execute.

Query Tick

Query for the latest tick data (price/size for best-bid/ask/last, accumulated volume, etc).

public class QueryTickSample {

    public static void main(String[] args) throws Exception {

        Bitflyer4j api = new Bitflyer4jFactory().createInstance();

        Tick.Request request = Tick.Request.builder().product("ETH_BTC").build();

        System.out.println(api.getMarketService().getTick(request).get());

        api.close();

    }

}

Send New Order

Send a new order. Note that this is for the "Child Order" in bitFlyer's terminology.

public class SendOrderSample {

    public static void main(String[] args) throws Exception {

        Bitflyer4j api = new Bitflyer4jFactory().createInstance();

        OrderCreate.Request request = OrderCreate.Request.builder()
                .product("FX_BTC_JPY").type(ConditionType.LIMIT).side(SideType.BUY)
                .price(new BigDecimal("12345.6789")).size(BigDecimal.ONE).build();

        System.out.println(api.getOrderService().sendOrder(request).get());

        api.close();

    }

}

Cancel Existing Order

Cancel an existing order. Specify either one of the order id or the acceptance id.

public class CancelOrderSample {

    public static void main(String[] args) throws Exception {

        Bitflyer4j api = new Bitflyer4jFactory().createInstance();

        OrderCancel.Request request = OrderCancel.Request.builder()
                .product("BTCJPY_MAT1WK").orderId("JOR20150707-055555-022222").build();

        System.out.println(api.getOrderService().cancelOrder(request).get());

        api.close();

    }

}

Subscribe to Realtime Feed

Initiate a subscription for the steaming market data. (Automatic reconnect with subscription recovery upon unsolicited disconnect.)

public class RealtimeSample {

    public static void main(String[] args) throws Exception {

        Bitflyer4j api = new Bitflyer4jFactory().createInstance();

        api.getRealtimeService().addListener(new RealtimeListenerAdapter() {
            @Override
            public void onTicks(String product, List<Tick> values) {
                System.out.println("(" + product + ")" + values);
            }
        });

        System.out.println(api.getRealtimeService().subscribeTick(Arrays.asList("BTC_JPY")).get());

        TimeUnit.SECONDS.sleep(30L);

        api.close();

    }

}

For the full list of supported features and sample codes, please refer to Bitflyer4jTest.

Features & Configurations

Below are some of the features and configurations available, which may be useful for specific use cases and executing environments.

Private API Authentication

In order to use the Private API, specify the following properties in the environment variables and/or the configuration files:

bitflyer4j.auth_key
bitflyer4j.auth_secret

When the API library is initialized, it will try to search these properties in the following priority:

Java runtime properties. (java -Dbitflyer4j.auth_key=... -Dbitflyer4j.auth_secret=...)
${HOME}/.bitflyer4j properties file.
bitflyer4j-site.properties file in the classpath.

The library will scan from the top of the list, skipping the ones which are not available/accessible, and will use the first one found per variable.

Note that Confidential parameters shall only be stored privately, preferably by using the local ${HOME}/.bitflyer4j properties file. DO NOT COMMIT, LOG, NOR DISSEMINATE THE CREDENTIALS.

# Authentication
bitflyer4j.auth_key=MY_KEY_HERE
bitflyer4j.auth_secret=MY_SECRET_HERE

A template of the .bitflyer4j file can be downloaded from here.

Network Proxy

In case if this library is to be used behind a network proxy, specify the following environment variables. The variables are fetched by the library in the same manner, as described previously in the authentication section.

# HTTP Proxy
bitflyer4j.http_proxy_type=HTTP
bitflyer4j.http_proxy_host=127.0.0.1
bitflyer4j.http_proxy_port=8080

HTTP Access Throttling

bitFlyer limits the number of HTTP requests allowed per interval.

In this library, each HTTP calls are queued first, and a background thread takes them out of the queue, with a throttling mechanism to avoid DOS-attacking the service and comply with the limit. Therefore, each HTTP calls are designed to return a java.util.concurrent.CompletableFuture instance, which is completed only after the HTTP request has been actually executed by the background thread.

To make these asynchronous HTTP calls synchronous, simply call the CompletableFuture#get() method.

Other Configurations

Although there should be no need to overwrite the default configurations, the following parameters are externalized and can be overwritten by the environment variables. For the complete list of configurable parameters and details, refer to the KeyType javadoc.

Property Key	Default Value	Description
bitflyer4j.site	local	Optional free-text label to identify the environment which the client app is running.
bitflyer4j.auth_key		Authentication key for the private API.
bitflyer4j.auth_secret		Authentication secret for the private API.
bitflyer4j.http_url	https://api.bitflyer.jp	Endpoint URL of the service.
bitflyer4j.http_proxy_type		Proxy type (DIRECT/HTTP/SOCKS) used for HTTP calls. Leave empty to disable proxy.
bitflyer4j.http_proxy_host		Address of the proxy server. Proxy type must be specified for the proxy enablement.
bitflyer4j.http_proxy_port		Port of the proxy server. Proxy type must be specified for the proxy enablement.
bitflyer4j.http_timeout	180000	HTTP socket/read timeout interval in millis. Leave empty for no timeout.
bitflyer4j.http_threads	8	HTTP threads to utilize for HTTP access.
bitflyer4j.http_limit_interval	300000	HTTP access throttling interval in millis.
bitflyer4j.http_limit_criteria_address	500	Number of allowed HTTP access for a single source IP, within the throttling interval.
bitflyer4j.http_limit_criteria_private	500	Number of allowed HTTP access for private API calls, within the throttling interval.
bitflyer4j.realtime_type		Implementaion type to utilize for realtime subcription.
bitflyer4j.socket_endpoint	https://io.lightstream.bitflyer.com	Endpoint URL of the Socket.IO.

Endpoint Paths

Currently implemented API endpoint paths are as follows:

HTTP Public API
- Market List : /v1/markets
- Market List USA : /v1/markets/usa
- Market List EUR : /v1/markets/eu
- Order Book : /v1/board
- Ticker : /v1/ticker
- Execution History : /v1/executions
- Chat : /v1/getchats
- Chat USA : /v1/getchats/usa
- Chat EUR : /v1/getchats/eu
- Exchange Status : /v1/gethealth
- Board State : /v1/getboardstate
HTTP Private API
- Account Detail
  - Permissions : /v1/me/getpermissions
  - Balance : /v1/me/getbalance
  - Collateral : /v1/me/getcollateral
  - Margin : /v1/me/getcollateralaccounts
  - Address : /v1/me/getaddresses
  - Coin In : /v1/me/getcoinins
  - Coin Out : /v1/me/getcoinouts
  - Bank : /v1/me/getbankaccounts
  - Deposit : /v1/me/getdeposits
  - Withdrawal : /v1/me/getwithdrawals
- Account Action
  - Withdraw : /v1/me/withdraw
- Order Action
  - New Child Order /v1/me/sendchildorder
  - Cancel Child Order /v1/me/cancelchildorder
  - New Parent Order /v1/me/sendparentorder
  - Cancel Parent Order /v1/me/cancelparentorder
  - Cancel All Orders /v1/me/cancelallchildorders
- Order Detail
  - Child Order List /v1/me/getchildorders
  - Parent Order List /v1/me/getparentorders
  - Parent Order Detail /v1/me/getparentorder
  - Executions /v1/me/getexecutions
  - Open Interest Summary /v1/me/getpositions
  - Margin Change History /v1/me/getcollateralhistory
  - Trading Commission /v1/me/gettradingcommission
Realtime API
- Socket.IO
  - Order Book Update lightning_board_*
  - Order Book Snapshot lightning_board_snapshot_*
  - Ticker lightning_ticker_*
  - Execution lightning_executions_*

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

bitflyer4j

Overview

Getting Started

Download

Maven (`pom.xml`)

Sample Codes

Query Tick

Send New Order

Cancel Existing Order

Subscribe to Realtime Feed

Features & Configurations

Private API Authentication

Network Proxy

HTTP Access Throttling

Other Configurations

Endpoint Paths

Files

README.md

Latest commit

History

README.md

File metadata and controls

bitflyer4j

Overview

Getting Started

Download

Maven (pom.xml)

Sample Codes

Query Tick

Send New Order

Cancel Existing Order

Subscribe to Realtime Feed

Features & Configurations

Private API Authentication

Network Proxy

HTTP Access Throttling

Other Configurations

Endpoint Paths

Maven (`pom.xml`)