Pre Liquidity

Creating/Adding Liquidity Pools

Pre-add/Create Request (BRC20)

When selecting the token pair and clicking to add liquidity, if it is a BRC20 token, you need to first request the pre-add/create interface.

Pre-add liquidity

post

Header parameters

Authorizationstringoptional

token

User-Idstringoptional

Body

tick1stringrequired

tick2stringrequired

amount_1stringrequired

amount_2stringrequired

tick_1_inscription_idsstring[]required

Only use for BRC20 deposits

tick_2_inscription_idsstring[]required

payer_ord_addrstringrequired

payer_btc_addrstringrequired

payer_pub_keystringrequired

fee_ratestringrequired

slipperstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/brc20swap/v2/pre_add_liquid' \
  --header 'Content-Type: application/json' \
  --data '{
    "tick1": "sint amet aliquip reprehenderit",
    "tick2": "sint et",
    "coin_type_1": "nostrud",
    "coin_type_2": "nisi",
    "amount_1": "86",
    "amount_2": "44",
    "tick_1_inscription_ids": [
      "32",
      "44",
      "21",
      "11",
      "55"
    ],
    "tick_2_inscription_ids": [
      "17",
      "55",
      "23",
      "74",
      "41"
    ],
    "payer_ord_addr": "dolor in id",
    "fee_rate": "cillum aute",
    "payer_btc_addr": "irure sit culpa ea sed",
    "payer_pub_key": "minim"
  }'

200

x-200:Success

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "tx_size": 1,
    "ins_contain_sats": 1,
    "vins": [
      "text"
    ],
    "usr_cnt": 1,
    "net_fee": 1,
    "check_sum": "text"
  },
  "req_id": "text"
}

Success

Important Notes

1. The result returned from this interface should be passed as is to the create_add_liquid_psbt interface.

2. Since liquidity is added based on a ratio and BRC20 needs to be inscribed first, creating BRC20-BRC20 token pair pools is not supported.

3. For the tick_1_inscription_ids and tick_2_inscription_ids parameters:

   • If coin_type_1 is BRC20, put the BRC20 inscription ID in the tick_1_inscription_ids array and leave tick_2_inscription_ids empty.

   • If coin_type_2 is BRC20, put the BRC20 inscription ID in the tick_2_inscription_ids array and leave tick_1_inscription_ids empty.

   For the same token pair, BRC20-BTC and BTC-BRC20, the same pool is created or added to (e.g., ordi-BTC, BTC-ordi), just using different fields for the parameters.