binance-connector-java

Migration Guide: Binance Spot Connector Modularization

With the transition to a modularized structure, the Binance Connector has been split into separate NPM libraries, each focusing on a distinct product (e.g., Auto Invest, Futures, etc.).

Key Changes

  1. Package Name:
    The modularised Spot Connector has been moved to a new package:

    Old: ```xml

io.github.binance binance-connector-java 3.0.5 
   **New:**
```xml
<dependency>
  <groupId>io.github.binance</groupId>
  <artifactId>binance-spot</artifactId>
  <version>6.0.0</version>
</dependency>

2Imports:
Update your import paths.

Old:

import com.binance.connector.client.SpotClient;

New:

import com.binance.connector.client.spot.rest.api.SpotRestApi;

  1. Configuration and Client Initialization:
    The new structure keeps the existing configuration options but modularized clients into SpotRestApi.

    Old:

SpotClient client = new SpotClientImpl(PrivateConfig.API_KEY, PrivateConfig.SECRET_KEY);
String result = client.<givenMethod>(parameters);
System.out.println(result);

New:

 ClientConfiguration clientConfiguration = AlgoRestApiUtil.getClientConfiguration();
 SignatureConfiguration signatureConfiguration = new SignatureConfiguration();
 signatureConfiguration.setApiKey("apiKey");
 signatureConfiguration.setPrivateKey("path/to/private.key");
 clientConfiguration.setSignatureConfiguration(signatureConfiguration);
 
 SpotRestApi api = new SpotRestApi(clientConfiguration);
  1. Examples and Documentation:
    Updated examples can be found in the new repository folders:
    • REST API: examples/spot/

Migration Steps

1. Replace the maven dependency

Replace the maven dependency:

 <dependency>
     <groupId>io.github.binance</groupId>
     <artifactId>binance-connector-java</artifactId>
     <version>3.0.5</version>
 </dependency>

by:

 <dependency>
     <groupId>io.github.binance</groupId>
     <artifactId>binance-spot</artifactId>
     <version>6.0.0</version>
 </dependency>

3. Update Import Paths

Replace all occurrences of:

import com.binance.connector.client.SpotClient;

With:

import com.binance.connector.client.spot.rest.api.SpotRestApi;

4. Update Client Initialization

Adjust your code to use the modularized structure. For example:

Old:

SpotClient client = new SpotClientImpl(PrivateConfig.API_KEY, PrivateConfig.SECRET_KEY);

New:

 ClientConfiguration clientConfiguration = SpotRestApiUtil.getClientConfiguration();
 SignatureConfiguration signatureConfiguration = new SignatureConfiguration();
 signatureConfiguration.setApiKey("apiKey");
 signatureConfiguration.setPrivateKey("path/to/private.key");
 clientConfiguration.setSignatureConfiguration(signatureConfiguration);
 clientConfiguration.setCompression(false); //disable compression
 SpotRestApi api = new SpotRestApi(clientConfiguration);

5. Test and Verify

Run your application to ensure everything works as expected. Refer to the new documentation for any advanced features or configuration options.

Additional Notes

For more details, refer to the updated README and Examples.

This site is open source. Improve this page.