Zysen / bscswap-api

🔮 BSCswap market data

BSCswap API

The BSCswap API is a set of endpoints used by market aggregators (e.g. coinmarketcap.com) to surface BSCswap liquidity and volume information. All information is fetched from the underlying subgraphs.

The API is designed around the CoinMarketCap requirements document.

Prefer the BSCswap subgraph for any BSCswap queries whenever possible.

BSCswap Subgraph: https://github.com/bscswap/bscswap-subgraph

BSCswap Endpoints

All BSCswap pairs consist of two different tokens. BNB is not a native currency in BSCswap, and is represented only by WBNB in the pairs.

The canonical WBNB address used by the BSCswap interface is 0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c.

/summary

Returns data for the top ~1000 BSCswap pairs, sorted by reserves. Results are edge cached for 15 minutes.

Request

GET https://api.bscswap.com/summary

Response

{
  "0x..._0x...": {                  // the asset ids of the BEP20 tokens (i.e. token addresses), joined by an underscore
    "last_price": "1.234",          // denominated in token0/token1
    "base_volume": "123.456",       // last 24h volume denominated in token0
    "quote_volume": "1234.56"       // last 24h volume denominated in token1
    "pair_liquidity": "1234.56"     // Pair liquidity in USD
  },
  // ...
}

/totalliquidity

Returns the total liquidity in USD value on BSCswap. Results are edge cached for 24 hours.

Request

GET https://api.bscswap.com/totalliquidity

Response

{
  "result": {
    "totalLiquidityUSD": "...", // Total liquidity in USD
  }
}

/assets

Returns the tokens in the top ~1000 pairs on BSCswap, sorted by reserves. Results are edge cached for 24 hours.

Request

GET https://api.bscswap.com/assets

Response

{
  // ...,
  "0x...": {              // the address of the BEP20 token
    "name": "...",        // not necesssarily included for BEP20 tokens
    "symbol": "...",      // not necesssarily included for BEP20 tokens
    "id": "0x...",        // the address of the BEP20 token
    "maker_fee": "0",     // always 0
    "taker_fee": "0.003", // always 0.003 i.e. .3%
  },
  // ...
}

/tickers

Returns data for the top ~1000 BSCswap pairs, sorted by reserves. Results are edge cached for 1 minute.

Request

GET https://api.bscswap.com/tickers

Response

{
  "0x..._0x...": {                    // the asset ids of BNB and BEP20 tokens, joined by an underscore
    "base_name": "...",             // token0 name
    "base_symbol": "...",           // token0 symbol
    "base_id": "0x...",             // token0 address
    "quote_name": "...",            // token1 name
    "quote_symbol": "...",          // token1 symbol
    "quote_id": "0x...",            // token1 address
    "last_price": "1.234",          // the mid price as token1/token0
    "base_volume": "123.456",       // denominated in token0
    "quote_volume": "1234.56"       // denominated in token1
  },
  // ...
}

/orderbook/:pair

Returns simulated orderbook data for the given BSCswap pair. Since BSCswap has a continuous orderbook, fixed amounts in an interval are chosen for bids and asks, and prices are derived from the BSCswap formula (accounting for both slippage and fees paid to LPs). Results are edge cached for 15 minutes.

Request

GET https://api.bscswap.com/orderbook/:pair

URL Parameters

• pair: The asset ids of two BEP20 tokens, joined by an underscore, e.g. 0x..._0x.... The first token address is considered the base in the response.

Response

{
  "timestamp": 1234567, // UNIX timestamp of the response
  "bids": [
    ["12", "1.2"],      // denominated in base token, quote token/base token
    ["12", "1.1"],      // denominated in base token, quote token/base token
    // ...
  ],
  "asks": [
    ["12", "1.3"],      // denominated in base token, quote token/base token
    ["12", "1.4"],      // denominated in base token, quote token/base token
    // ...
  ]
}

/trades/:pair

Returns all swaps in the last 24 hours for the given BSCswap pair. Results are edge cached for 15 minutes.

The pair address is the address of the two tokens in either order. The first address is considered the base in the response.

Note because BSCswap supports flash swaps and borrowing of both tokens in a pair, you may wish to exclude these trade types (types "???" and "borrow-both").

URL Parameters

• pair: The asset ids of two BEP20 tokens, joined by an underscore, e.g. 0x..._0x.... The first token address is considered the base in the response.

Request

GET https://api.bscswap.com/trades/:pair

Response

[
  {
    "trade_id": "...",
    "price": "1.234",           // denominated in quote token/base token
    "base_volume": "123.456",   // denominated in base token
    "quote_volume": "1234.56",  // denominated in quote token
    "trade_timestamp": 1234567, // UNIX timestamp
    "type": "buy"               // "buy"/"sell"/"borrow-both"/"???"
  },
  // ...
]