Add Liq

Please note that access to this API requires the API key to have brc20-swap permissions enabled.

quote swap

get

Authorizations

Query parameters

addressstringrequired

tickInstringrequired

Input tick

tickOutstringrequired

Output tick

amountstringrequired

The amount of input tick

exactTypestring · enumrequired

Example: exactIn

Options: exactIn, exactOut

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://open-api.unisat.io/v1/brc20-swap/quote_swap?address=text&tickIn=text&tickOut=text&amount=text&exactType=exactIn' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "amountUSD": "text",
    "expectUSD": "text",
    "expect": "text"
  }
}

Default Response

Example in https://open-api.unisat.io/swagger.html

/add_liq interface pre-load, get the signature content, gas and byte information.

get

Authorizations

Query parameters

addressstringrequired

tick0stringrequired

tick1stringrequired

amount0stringrequired

Input amount of tick0

amount1stringrequired

Input amount of tick1

lpstringrequired

Expect amount of lp

slippagestringrequired

tsnumberrequired

Timestamp (seconds)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://open-api.unisat.io/v1/brc20-swap/pre_add_liq?address=text&tick0=text&tick1=text&amount0=text&amount1=text&lp=text&slippage=text&ts=1' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "signMsg": "text",
    "bytesL1": 1,
    "bytesL2": 1,
    "feeRate": "text",
    "gasPrice": "text",
    "serviceFeeL1": "text",
    "serviceFeeL2": "text",
    "unitUsdPriceL1": "text",
    "unitUsdPriceL2": "text",
    "serviceTickBalance": "text"
  }
}

Default Response

Example in https://open-api.unisat.io/swagger.html

Add the liquidity operation.

post

Authorizations

Body

addressstringrequired

tick0stringrequired

tick1stringrequired

amount0stringrequired

Input amount of tick0

amount1stringrequired

Input amount of tick1

lpstringrequired

slippagestringrequired

tsnumberrequired

Timestamp (seconds)

sigstringrequired

User signature

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v1/brc20-swap/add_liq' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "text",
    "tick0": "text",
    "tick1": "text",
    "amount0": "text",
    "amount1": "text",
    "lp": "text",
    "slippage": "text",
    "ts": 1,
    "sig": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "id": "text",
    "rollupInscriptionId": "text",
    "address": "text",
    "type": "text",
    "tick0": "text",
    "tick1": "text",
    "amount0": "text",
    "amount1": "text",
    "lp": "text",
    "ts": 1
  }
}

Default Response