Data Queries

Get Mining Points

This endpoint allows querying user liquidity pool shares (lp), mining points (integral), and other data.

Manage Liquidity Pools

post

/brc20swap/manage_liquid_info

Header parameters

Authorizationstring

token

User-Idstring

Body

addressstringrequired

tickstring

page_sizeintegerrequired

pageintegerrequired

sortstring

descboolean

crypto_typestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/brc20swap/manage_liquid_info' \
  --header 'Content-Type: application/json' \
  --data '{
    "page": 1,
    "page_size": 10,
    "address": "tb1qge80xavle7c7k0tk7vceaavwcgpsr3jchl0w3e",
    "crypto_type": "btc"
  }'

200

x-200:Success

200

{
  "code": 0,
  "msg": "",
  "req_id": "1887718963524575232",
  "data": {
    "total": 1,
    "items": [
      {
        "protocol": "RUNES",
        "tick1": "BTC",
        "tick2": "SHE•SHE•SHE•SHE•SHE",
        "coin_type_1": "btc",
        "coin_type_2": "runes",
        "icon1": "https://images.tiertop.io/icon/bitcoin.png",
        "icon2": "",
        "lp_share": "100.0000%",
        "coin_pair_tick1_total_amt": "0.00010000 BTC",
        "coin_pair_tick2_total_amt": "10000.0000 SHE•SHE•SHE•SHE•SHE",
        "svc_fee_income_tick1_amt": "0.00000000 BTC",
        "svc_fee_income_tick2_amt": "0.0000 SHE•SHE•SHE•SHE•SHE",
        "svc_fee_income_tick1_amt_v1": "0.00000000 BTC",
        "svc_fee_income_tick2_amt_v1": "0.0000 SHE•SHE•SHE•SHE•SHE",
        "updated_time": "2025-02-05 07:07:53",
        "integral": 1024,
        "start_remove_time": 0,
        "non_removable": false,
        "has_balance_rewards": false
      }
    ]
  }
}

Success

1. The response includes a protocol field to indicate the type of pool (brc20, arc20).

Get Liquidity Change History

This endpoint allows querying the history of user operations related to creating, adding, and removing liquidity pools. The txid can be used to query the on-chain transaction status in the mempool.

Get liquidity change history

post

/brc20swap/liquid_history

Header parameters

Authorizationstring

token

User-Idstring

Body

addressstring

Leave blank to query all

pageintegerrequired

page_sizeintegerrequired

tick1string

tick2string

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/brc20swap/liquid_history' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "text",
    "page": 1,
    "page_size": 1,
    "tick1": "text",
    "tick2": "text"
  }'

200

x-200:Success

200

{
  "code": 1,
  "msg": "text",
  "req_id": "text",
  "data": {
    "total": 1,
    "items": [
      {
        "protocol": "text",
        "op": "text",
        "tick1": "text",
        "tick1_amount": "text",
        "tick2": "text",
        "tick2_amount": "text",
        "time_sec": 1,
        "status": "text",
        "address": "text",
        "refundable": true,
        "txs": [
          {
            "tx_id": "text",
            "status": "text",
            "is_refund": "text"
          }
        ]
      }
    ]
  }
}

Success

1. The response includes an array txs, where the txid field represents the transaction hash for querying transaction status. A status other than confirmed indicates the transaction is unconfirmed.

Liquidity Pool Information List

This endpoint allows querying the Total Value Locked (TVL) of pools.

Get liquidity pool info

post

/brc20swap/stat/trade_info_list

Header parameters

Authorizationstring

token

User-Idstring

Body

pageintegerrequired

page_sizeintegerrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/brc20swap/stat/trade_info_list' \
  --header 'Content-Type: application/json' \
  --data '{
    "page": 1,
    "page_size": 1
  }'

200

x-200:Success

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "total": 1,
    "items": [
      {
        "pool_locked_amount": "text",
        "pool_locked_amount_btc": "text",
        "trade_flow": "text",
        "trade_flow_btc": "text",
        "trade_flow_24h_btc": "text",
        "trade_flow_24h_usd": "text",
        "coin_type_1": "text",
        "tick1": "text",
        "icon1": "text",
        "coin_type_2": "text",
        "tick2": "text",
        "icon2": "text"
      }
    ]
  }
}

Success

1. Values returned with _btc are in BTC units; otherwise, values are in USD.

2. The TVL field includes pool_locked_amount_btc and pool_locked_amount.

Obtain liquidity pool address by trading pair

post

/brc20swap/get_liquid_address

Header parameters

Authorizationstring

token

User-Idstring

Body

tick1stringrequired

tick2string

coin_type_1stringrequired

coin_type_2stringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/brc20swap/get_liquid_address' \
  --header 'Content-Type: application/json' \
  --data '{
    "tick1": "text",
    "tick2": "text",
    "coin_type_1": "text",
    "coin_type_2": "text"
  }'

200

x-200:Success

200

{
  "code": 1,
  "msg": "text",
  "data": [
    "text"
  ]
}

Success

Get pool APR

post

/brc20swap/external/pool/apr

Header parameters

Pragmastringrequired

Example: no-cache

Authorizationstringrequired

User-Idstringrequired

User-Agentstringrequired

Example: Apifox/1.0.0 (https://apifox.com)

Content-Typestringrequired

Example: application/json

Acceptstringrequired

Example: */*

Connectionstringrequired

Example: keep-alive

Body

coin_type_1stringrequired

coin_type_2stringrequired

tick1stringrequired

tick2stringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/brc20swap/external/pool/apr' \
  --header 'Pragma: text' \
  --header 'Authorization: text' \
  --header 'User-Id: text' \
  --header 'User-Agent: text' \
  --header 'Content-Type: application/json' \
  --header 'Accept: text' \
  --header 'Connection: text' \
  --data '{
    "coin_type_1": "btc",
    "coin_type_2": "runes",
    "tick1": "btc",
    "tick2": "FGFGFGFGFGFGF"
  }'

200

200

{}

Success