BSwap (io.github.binance:binance-connector-java 3.2.0 API)

java.lang.Object
- com.binance.connector.client.impl.spot.BSwap

```
public class BSwap
extends Object
```
BSwap Endpoints
All endpoints under the BSwap Endpoint section of the API documentation will be implemented in this class.
Response will be returned in String format.

Constructor Summary

Constructors
Constructor and Description
`BSwap(String baseUrl, String apiKey, com.binance.connector.client.utils.signaturegenerator.SignatureGenerator signatureGenerator, boolean showLimitUsage, com.binance.connector.client.utils.ProxyAuth proxy)`
`BSwap(String baseUrl, String apiKey, String secretKey, boolean showLimitUsage, com.binance.connector.client.utils.ProxyAuth proxy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addLiquidityPreview(Map<String,Object> parameters)` Calculate expected share amount for adding liquidity in single or dual token.
`String`	`claimedHistory(Map<String,Object> parameters)` Claim swap rewards or liquidity rewards GET /sapi/v1/bswap/claimedHistory
`String`	`claimRewards(Map<String,Object> parameters)` Claim swap rewards or liquidity rewards POST /sapi/v1/bswap/claimRewards
`String`	`liquidity(Map<String,Object> parameters)` Get liquidity information and user share of a pool.
`String`	`liquidityAdd(Map<String,Object> parameters)` Add liquidity to a pool.
`String`	`liquidityOps(Map<String,Object> parameters)` Get liquidity operation (add/remove) records.
`String`	`liquidityRemove(Map<String,Object> parameters)` Remove liquidity from a pool, type include SINGLE and COMBINATION, asset is mandatory for single asset removal.
`String`	`poolConfigure(Map<String,Object> parameters)` GET /sapi/v1/bswap/poolConfigure
`String`	`quote(Map<String,Object> parameters)` Request a quote for swap quote asset (selling asset) for base asset (buying asset), essentially price/exchange rates. quoteQty is quantity of quote asset (to sell). Please be noted the quote is for reference only, the actual price will change as the liquidity changes, it's recommended to swap immediate after request a quote for slippage prevention.
`String`	`removeLiquidityPreview(Map<String,Object> parameters)` Calculate the expected asset amount of single token redemption or dual token redemption.
`String`	`swap(Map<String,Object> parameters)` Swap quoteAsset for baseAsset.
`String`	`swapHistory(Map<String,Object> parameters)` Get swap history.
`String`	`swapPools()` Get metadata about all swap pools.
`String`	`unclaimedRewards(Map<String,Object> parameters)` Get unclaimed rewards record.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BSwap
```
public BSwap(String baseUrl,
             String apiKey,
             String secretKey,
             boolean showLimitUsage,
             com.binance.connector.client.utils.ProxyAuth proxy)
```
  - BSwap
```
public BSwap(String baseUrl,
             String apiKey,
             com.binance.connector.client.utils.signaturegenerator.SignatureGenerator signatureGenerator,
             boolean showLimitUsage,
             com.binance.connector.client.utils.ProxyAuth proxy)
```
- Method Detail
  - swapPools
```
public String swapPools()
```
    Get metadata about all swap pools.
    
    GET /sapi/v1/bswap/pools
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#list-all-swap-pools-market_data
  - liquidity
```
public String liquidity(Map<String,Object> parameters)
```
    Get liquidity information and user share of a pool.
    
    GET /sapi/v1/bswap/liquidity
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    poolId -- optional/long
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#subscribe-blvt-user_data
  - liquidityAdd
```
public String liquidityAdd(Map<String,Object> parameters)
```
    Add liquidity to a pool.
    
    POST /sapi/v1/bswap/liquidityAdd
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    poolId -- mandatory/long
    type -- optional/string -- "Single" to add a single token; "Combination" to add dual tokens. Default "Single"
    asset -- mandatory/string
    quantity -- mandatory/decimal
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#add-liquidity-trade
  - liquidityRemove
```
public String liquidityRemove(Map<String,Object> parameters)
```
    Remove liquidity from a pool, type include SINGLE and COMBINATION, asset is mandatory for single asset removal.
    
    POST /sapi/v1/bswap/liquidityRemove
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    poolId -- mandatory/long
    type -- mandatory/string -- SINGLE for single asset removal, COMBINATION for combination of all coins removal
    asset -- optional/string
    shareAmount -- mandatory/decimal
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#remove-liquidity-trade
  - liquidityOps
```
public String liquidityOps(Map<String,Object> parameters)
```
    Get liquidity operation (add/remove) records.
    
    GET /sapi/v1/bswap/liquidityOps
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    operationId -- optional/long
    poolId -- optional/long
    operation -- optional/enum -- ADD or REMOVE
    startTime -- optional/long
    endTime -- optional/long
    limit -- optional/long -- default 3, max 100
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#get-liquidity-operation-record-user_data
  - quote
```
public String quote(Map<String,Object> parameters)
```
    Request a quote for swap quote asset (selling asset) for base asset (buying asset), essentially price/exchange rates.
    quoteQty is quantity of quote asset (to sell).
    Please be noted the quote is for reference only, the actual price will change as the liquidity changes, it's recommended to swap immediate after request a quote for slippage prevention.
    
    GET /sapi/v1/bswap/quote
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    quoteAsset -- mandatory/string
    baseAsset -- mandatory/string
    quoteQty -- mandatory/decimal
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#get-liquidity-operation-record-user_data
  - swap
```
public String swap(Map<String,Object> parameters)
```
    Swap quoteAsset for baseAsset.
    
    POST /sapi/v1/bswap/swap
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    quoteAsset -- mandatory/string
    baseAsset -- mandatory/string
    quoteQty -- mandatory/decimal
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#swap-trade
  - swapHistory
```
public String swapHistory(Map<String,Object> parameters)
```
    Get swap history.
    
    GET /sapi/v1/bswap/swap
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    swapId -- optional/long
    startTime -- optional/long
    endTime -- optional/long
    status -- optional/int -- 0: pending for swap, 1: success, 2: failed
    quoteAsset -- optional/string
    baseAsset -- optional/string
    limit -- optional/long -- default 3, max 100
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#get-swap-history-user_data
  - poolConfigure
```
public String poolConfigure(Map<String,Object> parameters)
```
    GET /sapi/v1/bswap/poolConfigure
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    poolId -- optional/long
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#get-pool-configure-user_data
  - addLiquidityPreview
```
public String addLiquidityPreview(Map<String,Object> parameters)
```
    Calculate expected share amount for adding liquidity in single or dual token.
    
    GET /sapi/v1/bswap/addLiquidityPreview
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    poolId -- mandatory/long
    type -- mandatory/string -- "SINGLE" for adding a single token;"COMBINATION" for adding dual tokens
    quoteAsset -- mandatory/string
    quoteQty -- mandatory/decimal
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#add-liquidity-preview-user_data
  - removeLiquidityPreview
```
public String removeLiquidityPreview(Map<String,Object> parameters)
```
    Calculate the expected asset amount of single token redemption or dual token redemption.
    
    GET /sapi/v1/bswap/removeLiquidityPreview
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    poolId -- mandatory/long
    type -- mandatory/string -- "SINGLE" for adding a single token;"COMBINATION" for adding dual tokens
    quoteAsset -- mandatory/string
    shareAmount -- mandatory/decimal
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#remove-liquidity-preview-user_data
  - unclaimedRewards
```
public String unclaimedRewards(Map<String,Object> parameters)
```
    Get unclaimed rewards record.
    
    GET /sapi/v1/bswap/unclaimedRewards
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    type -- optional/int -- 0: Swap rewards,1:Liquidity rewards, default to 0
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#get-unclaimed-rewards-record-user_data
  - claimRewards
```
public String claimRewards(Map<String,Object> parameters)
```
    Claim swap rewards or liquidity rewards
    
    POST /sapi/v1/bswap/claimRewards
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    type -- optional/int -- 0: Swap rewards,1:Liquidity rewards, default to 0
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#claim-rewards-trade
  - claimedHistory
```
public String claimedHistory(Map<String,Object> parameters)
```
    Claim swap rewards or liquidity rewards
    
    GET /sapi/v1/bswap/claimedHistory
    
    Parameters:
    
    parameters - Map of String,Object pair where String is the name of the parameter and Object is the value of the parameter
    
    poolId -- optional/long
    assetRewards -- optional/string
    type -- optional/int -- 0: Swap rewards,1:Liquidity rewards, default to 0
    startTime -- optional/long
    endTime -- optional/long
    limit -- optional/long -- Default 3, max 100
    recvWindow -- optional/long
    
    Returns:
    
    String
    
    See Also:
    
    https://binance-docs.github.io/apidocs/spot/en/#get-claimed-history-user_data

Class BSwap

BSwap Endpoints

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BSwap

BSwap

Method Detail

swapPools

liquidity

liquidityAdd

liquidityRemove

liquidityOps

quote

swap

swapHistory

poolConfigure

addLiquidityPreview

removeLiquidityPreview

unclaimedRewards

claimRewards

claimedHistory