Add Liq

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

quote swap

get
/v1/brc20-swap/quote_swap
Authorizations
Query parameters
addressstringRequired
tickInstringRequired

Input tick

tickOutstringRequired

Output tick

amountstringRequired

The amount of input tick

exactTypestring · enumRequiredExample: exactInPossible values:
Responses
200

Default Response

application/json
get
/v1/brc20-swap/quote_swap
GET /v1/brc20-swap/quote_swap?address=text&tickIn=text&tickOut=text&amount=text&exactType=exactIn HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "amountUSD": "text",
    "expectUSD": "text",
    "expect": "text"
  }
}
Example in https://open-api.unisat.io/swagger.html

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

get
/v1/brc20-swap/pre_add_liq
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
200

Default Response

application/json
get
/v1/brc20-swap/pre_add_liq
GET /v1/brc20-swap/pre_add_liq?address=text&tick0=text&tick1=text&amount0=text&amount1=text&lp=text&slippage=text&ts=1 HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Default Response

{
  "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"
  }
}
Example in https://open-api.unisat.io/swagger.html

Add the liquidity operation.

post
/v1/brc20-swap/add_liq
Authorizations
Body
addressstringRequired
tick0stringRequired
tick1stringRequired
amount0stringRequired

Input amount of tick0

amount1stringRequired

Input amount of tick1

lpstringRequired
slippagestringRequired
tsnumberRequired

Timestamp (seconds)

sigstringRequired

User signature

Responses
200

Default Response

application/json
post
/v1/brc20-swap/add_liq
POST /v1/brc20-swap/add_liq HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "address": "text",
  "tick0": "text",
  "tick1": "text",
  "amount0": "text",
  "amount1": "text",
  "lp": "text",
  "slippage": "text",
  "ts": 1,
  "sig": "text"
}
200

Default Response

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

Last updated