Saturn Documentation
Launch App
  • Saturn
  • Traders
    • Trading in Saturn
    • How to Swap
    • How Saturn Protects Your Trades from MEV Risks
  • Liquidity Providers
    • Open a position in a Liquidity Pool
    • Managing your Portfolio on Saturn
  • Token Creators
    • How to Create a Pool on Saturn
  • Builders
    • Saturn API
      • Pool API
        • Initialize pool
        • Add Shards
        • Open position
        • Increase Liquidity
        • Remove Liquidity
        • Swap
        • Swap Quotes
        • Boost Transaction
        • Wallet
      • Indexer API
        • Collections
        • Pools
        • Prices
        • Positions
        • Transactions
        • Charts
        • Stats
    • Liquidity Pool SDK
  • Saturn V1
    • Overview
    • How-To-Links
      • Setting up Trading Account
        • Withdrawing from Trading account
      • Swap
      • Orderbook
        • Your Profile
          • Trade History
        • How to place a sell order
        • How to place a buy order
        • Positions
      • Collect
      • Charts
      • Tutorial videos
        • Setting up a Trading Account (v3) and preparing for Rings Airdrops
        • Trading on Saturn
    • FAQs
      • What are Satoshi's, Rare SATs, and Rings?
        • More on Rare SATs
      • What is a UTXO
      • What is a PSBT
      • Why are there batch sizes?
      • Compatible Wallets
      • Why is my Available balance different than my Total balance?
Powered by GitBook
On this page
  1. Builders
  2. Saturn API
  3. Pool API

Boost Transaction

PreviousSwap QuotesNextWallet

Last updated 1 month ago

Overview

  • Functionality: Boost and broadcast transactions

  • API Key authentication: Access to all endpoints requires the x-api-key header provided by Saturn

  • Address parameter: All requests must have the Content-Type header of application/json and provide the address in the body of the wallet that is requesting the broadcast.

Endpoints

  • POSTBoost an array of transaction ids. User must own some of the outputs of those transactions
  • POSTBroadcast a signed transaction

Boost an array of transaction ids. User must own some of the outputs of those transactions

post

Boost an array of transaction ids. User must own some of the outputs of those transactions. The response will contain a PSBT that can be signed by the user. You can then broadcast the PSBT using the /broadcast endpoint.

Authorizations
Body
runeAddressstringRequired

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.

paymentAddressstringOptional

The bitcoin address of the user.

runePublicKeystring · min: 64 · max: 66Required

The rune public key of the user.

Pattern: ^[0-9a-fA-F]+$
paymentPublicKeystring · min: 64 · max: 66Optional

The payment public key of the user.

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

The transaction ids to boost.

Responses
201Success
application/json
400
Transaction speedup error
application/json
401
Unauthorized
application/json
403
User not found
application/json
post
POST /v0/transaction/boost HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "runeAddress": "text",
  "paymentAddress": "text",
  "runePublicKey": "text",
  "paymentPublicKey": "text",
  "transactionIds": [
    "text"
  ]
}
{
  "psbt": "text",
  "fee": "text",
  "newFeeRate": 1,
  "feeRate": 1,
  "utxosToSign": [
    {
      "address": "text",
      "signingIndexes": [
        1
      ],
      "sigHash": 1,
      "utxo": "text"
    }
  ]
}

Broadcast a signed transaction

post

Broadcast a signed transaction.

Authorizations
Body
runeAddressstringRequired

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.

paymentAddressstringOptional

The bitcoin address of the user.

signedPsbtstringRequired

The signed PSBT of the transaction.

txTypeone ofRequired

The type of the transaction.

anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
Responses
201Success
application/json
Responsestring
400
Transaction speedup error
application/json
401
Unauthorized
application/json
403
User not found
application/json
post
POST /v0/transaction/broadcast HTTP/1.1
Host: api-dev.saturnbtc.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "runeAddress": "text",
  "paymentAddress": "text",
  "signedPsbt": "text",
  "txType": null
}
text