Swap

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 · 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

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

get

/v1/brc20-swap/pre_swap

Authorizations

Query parameters

addressstringrequired

tickInstringrequired

Input tick

tickOutstringrequired

Output tick

amountInstringrequired

The amount of input tick

amountOutstringrequired

The amount of output tick

slippagestringrequired

exactTypestring · enumrequired

Example: exactIn

Options: exactIn, exactOut

tsnumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://open-api.unisat.io/v1/brc20-swap/pre_swap?address=text&tickIn=text&tickOut=text&amountIn=text&amountOut=text&slippage=text&exactType=exactIn&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

The swap operation.

post

/v1/brc20-swap/swap

Authorizations

Body

addressstringrequired

tickInstringrequired

Input tick

tickOutstringrequired

Output tick

amountInstringrequired

The amount of input tick

amountOutstringrequired

The amount of output tick

slippagestringrequired

tsnumberrequired

Timestamp (seconds)

sigstringrequired

User signature

exactTypestring · enumrequired

Options: exactIn, exactOut

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v1/brc20-swap/swap' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"address":"text","tickIn":"text","tickOut":"text","amountIn":"text","amountOut":"text","slippage":"text","ts":1,"sig":"text","exactType":"exactIn"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "id": "text",
    "rollupInscriptionId": "text",
    "address": "text",
    "tickIn": "text",
    "tickOut": "text",
    "amountIn": "text",
    "amountOut": "text",
    "exactType": "text",
    "ts": 1
  }
}

Default Response