Public Api Documentation

This page is to share endpoints that are publicly accssible for others to use for their own projects. Please reach out if you would like a API Key to explore other data we make available in our SDK.

Base URL

<https://bitflow-sdk-api-gateway-7owjsmt8.uc.gateway.dev>

Available Endpoints

Get Ticker

Retrieve details of all available tokens on the DEX.

GET /ticker

Sample Response

  {
    "ask": 0.0563427827802654,
    "base_currency": "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token",
    "base_volume": 0.00005497,
    "bid": 0.0563427827802654,
    "high": 5586592.17877095,
    "last_price": 5555555.55555556,
    "liquidity_in_usd": 33098.7565339403,
    "low": 5536332.1799308,
    "target_currency": "SP14NS8MVBRHXMM96BQY0727AJ59SWPV7RMHC0NCG.pontis-bridge-BDC",
    "target_volume": 306,
    "ticker_id": "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token_SP14NS8MVBRHXMM96BQY0727AJ59SWPV7RMHC0NCG.pontis-bridge-BDC"
  }

  • ticker_id: Identifier of a ticker with delimiter to separate base/target

  • base_volume: the total trading volume measured in the base currency of the pair over the last 24 hours.

    • Ex: if your trading pair is BTC/USDT, the base volume would be the sum of all BTC amounts traded in that period.

  • base_currency: Contract Address of the base asset

  • target_volume: the total trading volume measured in the target currency of the pair over the last 24 hours.

    • Ex: if your trading pair is BTC/USDT, the base volume would be the sum of all USDT amounts traded.

  • target_currency: Contract Address of the target asset

  • liquidity_in_usd: Pool liquidity in USD

  • high: the highest price at which any trade (or transaction) occurred over the past 24 hours.

  • low: the lowest price at which any trade (or transaction) occurred over the past 24 hours.

  • last_price: Last transacted price of base currency based on given target currency

    • last_price = targetTokenAmountTransacted / baseTokenAmountTransacted

  • ask: most recent quote price directly going through the ticker

  • bid: most recent quote price directly going through the ticker

SDK API Requests

If you would like to work with BitFlow trough our SDK or get access to our private APIs please reach out to the team. We always have oppotunities to share, collaborate, and build together!

PreviousStacksNextRoadmap

Last updated