binance-connector-java

repository·master·Indexed 20 days ago

https://github.com/binance/binance-connector-java

A collection of auto-generated Java connectors for various Binance APIs, including Spot, Futures, Margin, Algo, Alpha, C2C, Convert, and Copy Trading. The library provides REST and WebSocket interfaces and requires Java 11 or newer. It includes a binance-common utility package for shared functions regarding API requests, timestamps, and cryptographic signatures.

Tokens
531.1K
Snippets
777
Records
842
Agent score
66%

What's inside binance-connector-java

  1. Overview of binance-common features

    master

    The binance-common package is a lightweight utility library designed to streamline development with Binance REST and WebSocket APIs. Key features include:

    • Common Utility Functions: Helpers for managing API requests, timestamps, and cryptographic signatures.
    • Optimized Integration: Specifically built to ensure seamless compatibility with other Binance modular connectors.
    • Lightweight Design: Optimized to be tree-shakeable, allowing you to import only the specific utilities required for your implementation.
  2. Use MarketDataApi for Alpha trading data

    master

    The MarketDataApi provides access to various market data endpoints for Alpha trading, including aggregated trades, order book depth, exchange information, klines (candlestick bars), and tickers. All URIs are relative to https://www.binance.com. Most endpoints do not require authorization.

    import com.binance.connector.client.alpha.ApiClient;
    import com.binance.connector.client.alpha.Configuration;
    import com.binance.connector.client.alpha.rest.api.MarketDataApi;
    
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://www.binance.com");
    MarketDataApi apiInstance = new MarketDataApi(defaultClient);
  3. OnChainYieldsApi Overview

    master

    The OnChainYieldsApi provides access to On-chain Yields Locked features. It includes endpoints for retrieving personal quotas, product lists, product positions, redemption records, rewards history, subscription previews, and subscription records. It also supports actions like redeeming products, setting auto-subscribe preferences, and subscribing to products.

    All URIs are relative to https://api.binance.com.

  4. AccountApi Overview

    master

    The AccountApi provides endpoints for managing margin trading accounts, including adjusting leverage, managing isolated margin accounts, and querying account status and fees. All URIs are relative to https://api.binance.com.

    Available Methods:

    • adjustCrossMarginMaxLeverage: Adjust cross margin max leverage (USER_DATA)
    • disableIsolatedMarginAccount: Disable Isolated Margin Account (TRADE)
    • enableIsolatedMarginAccount: Enable Isolated Margin Account (TRADE)
    • getBnbBurnStatus: Get BNB Burn Status (USER_DATA)
    • getSummaryOfMarginAccount: Get Summary of Margin account (USER_DATA)
    • queryCrossIsolatedMarginCapitalFlow: Query Cross Isolated Margin Capital Flow (USER_DATA)
    • queryCrossMarginAccountDetails: Query Cross Margin Account Details (USER_DATA)
    • queryCrossMarginFeeData: Query Cross Margin Fee Data (USER_DATA)
    • queryEnabledIsolatedMarginAccountLimit: Query Enabled Isolated Margin Account Limit (USER_DATA)
    • queryIsolatedMarginAccountInfo: Query Isolated Margin Account Info (USER_DATA)
    • queryIsolatedMarginFeeData: Query Isolated Margin Fee Data (USER_DATA)
  5. SolStakingApi Overview

    master

    The SolStakingApi provides endpoints for managing SOL staking on Binance. It includes capabilities for claiming boost rewards, retrieving BNSOL rate and rewards history, managing SOL redemption, and checking staking account details.

    Endpoints are categorized by security type:

    • TRADE: Requires 'Enable Spot & Margin Trading' permission for the API Key.
    • USER_DATA: Accesses user-specific staking and history information.

    All URIs are relative to https://api.binance.com.

  6. MarketApi Overview

    master

    The MarketApi provides access to various market data endpoints via WebSocket API requests. All URIs are relative to the configured base path (e.g., http://localhost).

    Available methods include:

    • avgPrice: Current average price
    • blockTradesHistorical: Historical Block Trades
    • depth: Order book
    • klines: Klines (candlestick bars)
    • referencePrice: Query Reference Price
    • referencePriceCalculation: Query Reference Price Calculation
    • ticker: Rolling window price change statistics
    • ticker24hr: 24hr ticker price change statistics
    • tickerBook: Symbol order book ticker
    • tickerPrice: Symbol price ticker
    • tickerTradingDay: Trading Day Ticker
    • tradesAggregate: Aggregate trades
    • tradesHistorical: Historical trades
    • tradesRecent: Recent trades
    • uiKlines: UI Klines
  7. Use AccountApi for Spot account data

    master

    The AccountApi class provides access to various user-data endpoints for the Binance Spot API. These endpoints allow you to query account commission rates, unfilled order counts, account status, order history, and more. Most methods require a USER_DATA security type, though the documentation for these specific methods indicates no explicit authorization header is required in the request (authentication is typically handled by the ApiClient configuration).

    AccountApi apiInstance = new AccountApi(defaultClient);
  8. Use MarketDataApi for VIP Loan data

    master
    The MarketDataApi provides endpoints to retrieve various market-related data for VIP Loans, including interest rates, collateral asset data, and loanable assets. All requests are relative to https://api.binance.com. Most methods require USER_DATA security type, though the documentation notes 'No authorization required' for these specific endpoints in the provided segment. Common parameters include recvWindow for request timing and specific asset identifiers like loanCoin or collateralCoin.
  9. EthStakingApi overview

    master

    The EthStakingApi provides endpoints for managing and querying ETH Staking data. It includes methods for retrieving account information, checking staking quotas, and accessing various history logs (redemption, staking, WBETH rates, rewards, unwrapping, and wrapping).

    All URIs are relative to https://api.binance.com. The API supports different security types such as USER_DATA and TRADE.

  10. TradeApi Overview

    master

    The TradeApi provides endpoints for managing option trades, including retrieving account trade lists, placing and canceling orders, and querying position information. All URIs are relative to https://eapi.binance.com.

    Available Methods:

    MethodHTTP requestDescription
    accountTradeListGET /eapi/v1/userTradesAccount Trade List (USER_DATA)
    cancelAllOptionOrdersByUnderlyingDELETE /eapi/v1/allOpenOrdersByUnderlyingCancel All Option Orders By Underlying (TRADE)
    cancelAllOptionOrdersOnSpecificSymbolDELETE /eapi/v1/allOpenOrdersCancel all Option orders on specific symbol (TRADE)
    cancelMultipleOptionOrdersDELETE /eapi/v1/batchOrdersCancel Multiple Option Orders (TRADE)
    cancelOptionOrderDELETE /eapi/v1/orderCancel Option Order (TRADE)
    newOrderPOST /eapi/v1/orderNew Order (TRADE)
    optionPositionInformationGET /eapi/v1/positionOption Position Information (USER_DATA)
    placeMultipleOrdersPOST /eapi/v1/batchOrdersPlace Multiple Orders (TRADE)
    queryCurrentOpenOptionOrdersGET /eapi/v1/openOrdersQuery Current Open Option Orders (USER_DATA)
    queryOptionOrderHistoryGET /eapi/v1/historyOrdersQuery Option Order History (TRADE)
    querySingleOrderGET /eapi/v1/orderQuery Single Order (TRADE)
    tradfiOptionsContractPOST /eapi/v1/stock/contractTradFi Options Contract (USER_DATA)
    userCommissionGET /eapi/v1/commissionUser Commission (USER_DATA)
    userExerciseRecordGET /eapi/v1/exerciseRecordUser Exercise Record (USER_DATA)
  11. FlexibleLockedApi overview

    master
    The FlexibleLockedApi provides access to various Simple Earn endpoints, including both Flexible and Locked product functionalities. It allows users to retrieve collateral records, personal left quotas, product positions, redemption records, rewards history, and subscription details. The API supports both USER_DATA security type operations (requiring authorization) and some public-facing queries.