go-binance SDK

Websocket functionality does not require a Client instance. Instead, you call specialized binance.WsXxxServe functions, passing a handler for events and an error handler. These functions are blocking; they return a doneC channel that signals when the connection is closed, and a stopC channel that you can use to manually trigger a shutdown.

To use a proxy with Websockets, you can either set the HTTPS_PROXY or HTTP_PROXY environment variables or use binance.SetWsProxyUrl(url) in your code.

When using the go-binance library, follow these security guidelines:

• Never commit API credentials to version control.
• Use environment variables for production deployments instead of hardcoding keys.
• Use the Testnet for testing and development to avoid accidental real-money trades.
• Always validate your configuration before making API calls.

REST API interactions follow a chain-style pattern. A service instance represents a specific endpoint and is initialized via a client.NewXXXService() method. You chain configuration methods (like .Symbol() or .Price()) and must call .Do(context.Background()) at the end to execute the HTTP request.

For testing purposes without sending real requests, you can use .Test() instead of .Do().

You can configure your Binance API credentials using either environment variables or direct configuration in the code. Using environment variables is the recommended approach for security and production deployments.

Option 1: Environment Variables (Recommended)

Set the following environment variables in your shell:

• BINANCE_API_KEY: Your Binance API key.
• BINANCE_SECRET_KEY: Your Binance secret key.
• BINANCE_USE_TESTNET: Set to "true" for testing or "false" for production.

Option 2: Direct Configuration

Update the AppConfig variable in config.go with your credentials.

export BINANCE_API_KEY="your_api_key_here"
export BINANCE_SECRET_KEY="your_secret_key_here"
export BINANCE_USE_TESTNET="true"  # Set to "false" for production

Depending on the services you need, import the main v2 package and optional sub-packages for futures, delivery, or options:

import (
    "github.com/adshao/go-binance/v2"
    "github.com/adshao/go-binance/v2/futures" // optional
    "github.com/adshao/go-binance/v2/delivery" // optional
    "github.com/adshao/go-binance/v2/options" // optional
)

import (
    "github.com/adshao/go-binance/v2"
    "github.com/adshao/go-binance/v2/futures" // optional package
    "github.com/adshao/go-binance/v2/delivery" // optional package
    "github.com/adshao/go-binance/v2/options" // optional package
)

The v1 API has been moved to a separate branch. To use the v1 version, run:

go get github.com/adshao/go-binance/v1

To install the latest version (v2) of the go-binance library, use the following command:

go get github.com/adshao/go-binance/v2

To run all available examples in the directory at once, use the following command:

go run .

Before making API calls, you should validate the AppConfig to ensure credentials are present and valid. This prevents runtime errors during API execution.

if err := AppConfig.Validate(); err != nil {
    fmt.Printf("Configuration error: %v\n", err)
    return
}

The Client maintains an internal RequestList to track the id of every message sent via Write.

1. Tracking: When Write is called, the id is added to the list. When a message is read from the socket, the client unmarshals the id field and removes it from the list.
2. Reconnection: If the connection fails, the read loop signals the handleReconnect goroutine. The client uses a backoff.Backoff strategy to restore the connection.
3. State Recovery: Upon successful reconnection, the RequestList is recreated (RecreateList) to clear out stale pending requests from the previous connection, preventing the client from waiting indefinitely for responses that will never arrive.