Swap

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

quote swap

GEThttps://open-api.unisat.io/v1/brc20-swap/quote_swap

Query parameters

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v1/brc20-swap/quote_swap?address=text&tickIn=text&tickOut=text&amount=text&exactType=exactIn', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

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

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

GEThttps://open-api.unisat.io/v1/brc20-swap/pre_swap

Query parameters

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('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=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

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

The swap operation.

POSThttps://open-api.unisat.io/v1/brc20-swap/swap

Body

application/json

address*string

tickIn*string

Input tick

tickOut*string

Output tick

amountIn*string

The amount of input tick

amountOut*string

The amount of output tick

slippage*string

exactType*enum

exactInexactOut

ts*number

Timestamp (seconds)

sig*string

User signature

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://open-api.unisat.io/v1/brc20-swap/swap', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "text",
      "tickIn": "text",
      "tickOut": "text",
      "amountIn": "text",
      "amountOut": "text",
      "slippage": "text",
      "exactType": "exactIn",
      "ts": 0,
      "sig": "text"
    }),
});
const data = await response.json();

Response

200

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