数据查询

查询挖矿积分

可通过这个接口查询用户流动池份额（lp），挖矿积分（integral）等数据。

管理流动池

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:成功

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
      }
    ]
  }
}

成功

1、返回值新增 protocol 字段，可用于标识当前是哪种池子（brc20、arc20）

查询流动性操作记录

可通过这个接口查询用户增加创建，增加，移除流动池的历史记录。其中 txid 可用于 mempool 中查询链上交易状态。

流动性操作记录

post

/brc20swap/liquid_history

Header parameters

Authorizationstring

token

User-Idstring

Body

addressstring

为空查询所有

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:成功

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"
          }
        ]
      }
    ]
  }
}

成功

1、列表中会返回数组 txs，其中包括的 txid 字段为交易哈希，可用于查询交易状态。status 除了 confirmed，其他都是未确认

流动池信息列表

可通过这个接口查询池子的 TVL

统计交易信息列表

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:成功

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"
      }
    ]
  }
}

成功

1、列表中会返回的字段中，带_btc 的值计算单位是 btc，否则返回的值单位是美元

2、TVL 字段 pool_locked_amount_btc 和 pool_locked_amount

根据币对获取流动池地址

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:成功

200

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

成功

获取池子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

{}

成功

1、可查询某时刻用户在某个流动池中的持有数量

2、参数 height 与 timestamp 可二选一，如果同时存在，则 timestamp 优先