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. Indexer API

Transactions

PreviousPositionsNextCharts

Last updated 27 days ago

get

Get a paginated list of all transactions in the specified pool that match the provided filter

Path parameters
pool_idstringRequired

Pool ID in hex format

Query parameters
startDatestring | nullOptional
endDatestring | nullOptional
typesarray | nullOptional
offsetinteger | nullOptional
limitinteger | nullOptional
sortCreatedAtone ofOptional
nullOptional
or
string · enumOptionalPossible values:
Responses
200
List of transactions
application/json
400
Invalid pubkey format
get
GET /transaction/pool/{pool_id} HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*
{
  "response": [
    {
      "id": "text",
      "status": {
        "type": "queued"
      },
      "rollbackStatus": {
        "message": "text",
        "type": "rolledback"
      },
      "bitcoinTxId": null,
      "bitcoinBlockHeight": null,
      "bitcoinTxStatus": null,
      "blockHeight": "text",
      "poolPubkey": "text",
      "userPubkey": "text",
      "transactionType": "open_position",
      "createdAt": "2025-05-20T13:11:02.911Z",
      "details": {
        "positionId": "text",
        "token0Amount": "text",
        "token1Amount": "text",
        "liquidityAmount": "text",
        "diffLiquidityAmount": "text",
        "type": "open_position"
      }
    }
  ],
  "offset": 1
}
get

Fetches a paginated list of user's transactions that match the provided filter

Path parameters
pubkeystringRequired

User public key in hex format

Query parameters
startDatestring | nullOptional
endDatestring | nullOptional
typesarray | nullOptional
offsetinteger | nullOptional
limitinteger | nullOptional
sortCreatedAtone ofOptional
nullOptional
or
string · enumOptionalPossible values:
Responses
200
Paginated list of transactions
application/json
400
Invalid pubkey format
get
GET /transaction/user/{pubkey} HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*
{
  "response": [
    {
      "transaction": {
        "id": "text",
        "status": {
          "type": "queued"
        },
        "rollbackStatus": {
          "message": "text",
          "type": "rolledback"
        },
        "bitcoinTxId": null,
        "bitcoinBlockHeight": null,
        "bitcoinTxStatus": null,
        "blockHeight": "text",
        "poolPubkey": "text",
        "userPubkey": "text",
        "transactionType": "open_position",
        "createdAt": "2025-05-20T13:11:02.911Z",
        "details": {
          "positionId": "text",
          "token0Amount": "text",
          "token1Amount": "text",
          "liquidityAmount": "text",
          "diffLiquidityAmount": "text",
          "type": "open_position"
        }
      },
      "token0": {
        "id": "1234:5678",
        "name": "text",
        "displayName": "text",
        "symbol": null,
        "divisibility": 1,
        "batchSize": 1,
        "supply": "text",
        "createdAt": "2025-05-20T13:11:02.911Z",
        "updatedAt": "2025-05-20T13:11:02.911Z",
        "type": "btc"
      },
      "token1": {
        "id": "1234:5678",
        "name": "text",
        "displayName": "text",
        "symbol": null,
        "divisibility": 1,
        "batchSize": 1,
        "supply": "text",
        "createdAt": "2025-05-20T13:11:02.911Z",
        "updatedAt": "2025-05-20T13:11:02.911Z",
        "type": "btc"
      }
    }
  ],
  "offset": 1
}
get

Paginated list of all transactions that match the provided filter

Query parameters
startDatestring | nullOptional
endDatestring | nullOptional
typesarray | nullOptional
offsetinteger | nullOptional
limitinteger | nullOptional
sortCreatedAtone ofOptional
nullOptional
or
string · enumOptionalPossible values:
Responses
200
Paginated list of transactions
application/json
get
GET /transaction/all HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*
200

Paginated list of transactions

{
  "response": [
    {
      "id": "text",
      "status": {
        "type": "queued"
      },
      "rollbackStatus": {
        "message": "text",
        "type": "rolledback"
      },
      "bitcoinTxId": null,
      "bitcoinBlockHeight": null,
      "bitcoinTxStatus": null,
      "blockHeight": "text",
      "poolPubkey": "text",
      "userPubkey": "text",
      "transactionType": "open_position",
      "createdAt": "2025-05-20T13:11:02.911Z",
      "details": {
        "positionId": "text",
        "token0Amount": "text",
        "token1Amount": "text",
        "liquidityAmount": "text",
        "diffLiquidityAmount": "text",
        "type": "open_position"
      }
    }
  ],
  "offset": 1
}
get

List of swap transactions for specific collections

Query parameters
token0string · tokenRequired

Token identifier in format block:tx

Example: 1234:5678
token1string · tokenRequired

Token identifier in format block:tx

Example: 1234:5678
offsetinteger | nullOptional
limitinteger | nullOptional
Responses
200
Paginated list of transactions
application/json
get
GET /transaction/swaps HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*
200

Paginated list of transactions

{
  "response": [
    {
      "transaction": {
        "id": "text",
        "status": {
          "type": "queued"
        },
        "rollbackStatus": {
          "message": "text",
          "type": "rolledback"
        },
        "bitcoinTxId": null,
        "bitcoinBlockHeight": null,
        "bitcoinTxStatus": null,
        "blockHeight": "text",
        "poolPubkey": "text",
        "userPubkey": "text",
        "transactionType": "open_position",
        "createdAt": "2025-05-20T13:11:02.911Z",
        "details": {
          "positionId": "text",
          "token0Amount": "text",
          "token1Amount": "text",
          "liquidityAmount": "text",
          "diffLiquidityAmount": "text",
          "type": "open_position"
        }
      },
      "token0": {
        "id": "1234:5678",
        "name": "text",
        "displayName": "text",
        "symbol": null,
        "divisibility": 1,
        "batchSize": 1,
        "supply": "text",
        "createdAt": "2025-05-20T13:11:02.911Z",
        "updatedAt": "2025-05-20T13:11:02.911Z",
        "type": "btc"
      },
      "token1": {
        "id": "1234:5678",
        "name": "text",
        "displayName": "text",
        "symbol": null,
        "divisibility": 1,
        "batchSize": 1,
        "supply": "text",
        "createdAt": "2025-05-20T13:11:02.911Z",
        "updatedAt": "2025-05-20T13:11:02.911Z",
        "type": "btc"
      }
    }
  ],
  "offset": 1
}
  • GET/transaction/pool/{pool_id}
  • GET/transaction/user/{pubkey}
  • GET/transaction/all
  • GET/transaction/swaps