Remove Liquidity

Decrease Liquidity PSBT

Generates a PSBT for decreasing liquidity from a position. This PSBT is optional and it will be used to pay for the decrease transaction fees if the funds to withdraw are not enough to cover the fees.

post

/v0/pool/decrease-liquidity/psbt

Authorizations

Body

feeRateThe fee rate for the transaction (in sats per byte)required

The fee rate for the transaction (in sats per byte).

runePubkeyThe public key of the rune address of the user initiating the requestrequired

The public key of the rune address of the user initiating the request.

Pattern: ^[0-9a-fA-F]+$

paymentPubkeyThe public key of the bitcoin address of the user initiating the request

The public key of the bitcoin address of the user initiating the request. If the user doesn't have a bitcoin address, the runePubkey will be used

Pattern: ^[0-9a-fA-F]+$

runeAddressThe rune address of the user. It must be a taproot address. (P2TR)required

The rune address of the user. It must be a taproot address. (P2TR). If no bitcoin address is provided, the rune address will be used for bitcoin too.

paymentAddressThe bitcoin address of the user

The bitcoin address of the user.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/psbt' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"feeRate":1,"runePubkey":"text","runeAddress":"text"}'

201

400

401

403

500

201

{
  "psbt": "text",
  "fee": 1,
  "utxosToSign": [
    {
      "address": "text",
      "sigHash": 1,
      "utxo": "text",
      "signingIndexes": [
        1
      ]
    }
  ]
}

An object containing the PSBT (in base64 format), the fee, and the list of UTXOs to sign.

Decrease Liquidity Message

Generates a message hash for decreasing liquidity from a position, which the user should sign.

post

/v0/pool/decrease-liquidity/message

Authorizations

Body

poolIdThe pubkey of the poolrequired

The pubkey of the pool.

Pattern: ^[0-9a-fA-F]+$

positionPubKeyThe pubkey of the positionrequired

The pubkey of the position.

Pattern: ^[0-9a-fA-F]+$

liquidityAmountThe amount of liquidity to withdrawrequired

The amount of liquidity to withdraw.

feeRateThe fee rate for the transaction (in sats per byte)required

The fee rate for the transaction (in sats per byte).

minToken0The minimum amount of the first token to withdrawrequired

The minimum amount of the first token to withdraw.

Pattern: ^[1-9][0-9]*$

minToken1The minimum amount of the second token to withdrawrequired

The minimum amount of the second token to withdraw.

Pattern: ^[1-9][0-9]*$

withdrawAddressToken0The address to withdraw the first token torequired

The address to withdraw the first token to.

withdrawAddressToken1The address to withdraw the second token torequired

The address to withdraw the second token to.

signedPsbtThe signed PSBT in base64 format

The signed PSBT in base64 format.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$

runePubkeyThe public key of the rune address of the user initiating the requestrequired

The public key of the rune address of the user initiating the request.

Pattern: ^[0-9a-fA-F]+$

paymentPubkeyThe public key of the bitcoin address of the user initiating the request

The public key of the bitcoin address of the user initiating the request. If the user doesn't have a bitcoin address, the runePubkey will be used

Pattern: ^[0-9a-fA-F]+$

runeAddressThe rune address of the user. It must be a taproot address. (P2TR)required

The rune address of the user. It must be a taproot address. (P2TR). If no bitcoin address is provided, the rune address will be used for bitcoin too.

paymentAddressThe bitcoin address of the user

The bitcoin address of the user.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity/message' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"poolId":"text","positionPubKey":"text","liquidityAmount":"text","feeRate":1,"minToken0":"text","minToken1":"text","withdrawAddressToken0":"text","withdrawAddressToken1":"text","runePubkey":"text","runeAddress":"text"}'

201

400

401

403

500

201

text

A hexadecimal string representing the hash of the message to be signed by the user.

Decrease Liquidity

Finalizes the decrease of liquidity from a position by submitting the signed message and executing the transaction on the network.

post

/v0/pool/decrease-liquidity

Authorizations

Body

signatureThe user's signature of the decrease liquidity messagerequired

The user's signature of the decrease liquidity message.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$

poolIdThe pubkey of the poolrequired

The pubkey of the pool.

Pattern: ^[0-9a-fA-F]+$

positionPubKeyThe pubkey of the positionrequired

The pubkey of the position.

Pattern: ^[0-9a-fA-F]+$

liquidityAmountThe amount of liquidity to withdrawrequired

The amount of liquidity to withdraw.

feeRateThe fee rate for the transaction (in sats per byte)required

The fee rate for the transaction (in sats per byte).

minToken0The minimum amount of the first token to withdrawrequired

The minimum amount of the first token to withdraw.

Pattern: ^[1-9][0-9]*$

minToken1The minimum amount of the second token to withdrawrequired

The minimum amount of the second token to withdraw.

Pattern: ^[1-9][0-9]*$

withdrawAddressToken0The address to withdraw the first token torequired

The address to withdraw the first token to.

withdrawAddressToken1The address to withdraw the second token torequired

The address to withdraw the second token to.

signedPsbtThe signed PSBT in base64 format

The signed PSBT in base64 format.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$

runePubkeyThe public key of the rune address of the user initiating the requestrequired

The public key of the rune address of the user initiating the request.

Pattern: ^[0-9a-fA-F]+$

paymentPubkeyThe public key of the bitcoin address of the user initiating the request

The public key of the bitcoin address of the user initiating the request. If the user doesn't have a bitcoin address, the runePubkey will be used

Pattern: ^[0-9a-fA-F]+$

runeAddressThe rune address of the user. It must be a taproot address. (P2TR)required

The rune address of the user. It must be a taproot address. (P2TR). If no bitcoin address is provided, the rune address will be used for bitcoin too.

paymentAddressThe bitcoin address of the user

The bitcoin address of the user.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-dev.saturnbtc.io/v0/pool/decrease-liquidity' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"signature":"text","poolId":"text","positionPubKey":"text","liquidityAmount":"text","feeRate":1,"minToken0":"text","minToken1":"text","withdrawAddressToken0":"text","withdrawAddressToken1":"text","runePubkey":"text","runeAddress":"text"}'

201

400

401

403

500

201

{
  "archTxId": "text",
  "bitcoinTxIds": [
    "text"
  ]
}

The Arch Network transaction ID of the liquidity decrease.