NiceHash Exchange REST Clients

Client library for the NiceHash Exchange API — synchronous, asynchronous, and WebSocket clients with request signing (API key/secret). Built as a small multi-module Maven project (com.nicehash:rest-clients:1-SNAPSHOT) and consumed by backend services that need exchange access.

Not to be confused with platform-utils/platform-clients, which holds the typed inter-service HTTP clients — this library targets the public Exchange API surface.

---

Module Map

flowchart LR
    subgraph rest-clients
        UTIL[util<br/>OptionMap, Options]
        COMMON[common<br/>ClientFactory, callbacks,<br/>signing, ClientException]
        DOMAIN[domain<br/>Trade, DepthEvent, DTOs]
        EXCHANGE[exchange<br/>ExchangeClient, Async, WebSocket]
        EXAMPLES[examples]
    end

    EXCHANGE --> COMMON
    EXCHANGE --> DOMAIN
    COMMON --> UTIL
    EXAMPLES --> EXCHANGE

    subgraph Consumers
        MAIN[main]
        APIFRONT[api-front]
        EXR[exchange-rate]
        ACC[simple-accounting]
    end

    MAIN --> EXCHANGE
    APIFRONT --> EXCHANGE
    EXR --> EXCHANGE
    ACC --> EXCHANGE

Loading

Module	Provides
util	OptionMap / Options configuration primitives
common	Client plumbing: ClientFactory, ClientGenerator, ClientCallback / AbstractClientCallback, ClientException, converters
domain	Exchange DTOs (Trade, DepthEvent, order book types, …)
exchange	ExchangeClient (sync), ExchangeAsyncClient, ExchangeWebSocketClient, ExchangeClientFactory
examples	Runnable usage examples

---

Usage

Synchronous client

OptionMap options = OptionMap.builder()
                             .set(Options.BASE_URL, "https://api-test.nicehash.com/exchange/")
                             .set(Options.KEY, "<KEY>")
                             .set(Options.SECRET, "<SECRET>")
                             .getMap();

ExchangeClientFactory factory = ExchangeClientFactory.newInstance(options);
ExchangeClient client = factory.newClient();
List<Trade> trades = client.getMyTrades("LTCBTC");

Asynchronous client

client.getMyTrades("LTCBTC", 100, new AbstractClientCallback<List<Trade>>() {
    @Override
    public void onResponse(List<Trade> trades) {
        System.out.println("Trades = " + trades);
    }
});

WebSocket client

try (ExchangeWebSocketClient client = ExchangeClientFactory.newWebSocketClient("https://exchange-test.nicehash.com/ws")) {
    client.onDepthEvent("LTCBTC", new AbstractClientCallback<DepthEvent>() {
        @Override
        public void onResponse(DepthEvent result) {
            System.out.println("Result = " + result);
        }
    });
}

Authentication is handled by the factory from Options.KEY / Options.SECRET; per-request signing lives in common.

---

Build

mvn clean install -DskipTests

Branches

Branch	Stack
master	Java 21 · jakarta.* (the nicehash-v3 migration has been merged in)
nicehash-v3	Migration branch, merged into master and kept in sync