Sats Connect - Wallet API for Bitcoin & Stacks
  • Introduction
  • Wallet Providers
    • getInfo
    • getProviders & getProviderById
  • Connecting to the wallet
    • Connect to Xverse Wallet
    • Disconnect from Xverse Wallet
    • Connect to other wallets
      • Manage a user's default wallet
    • [Legacy ⚠️] getAccounts
  • Wallet Methods
    • request methods
    • wallet_getAccount
    • wallet_getNetwork
    • wallet_changeNetwork
    • Xverse Custom Methods
  • Xverse Wallet Permissions
  • Xverse Wallet events
  • BITCOIN METHODS
    • 🟠getAddresses
    • 🟠signMessage
    • 🟠signPsbt
    • 🟠sendTransfer
    • 🟠signMultipleTransactions
    • 🟠getBalance
    • 🎨createInscription
    • 🎨createRepeatInscriptions
    • 🎨ord_getInscriptions
    • 🎨ord_sendInscriptions
    • 🔲runes_getBalance
    • 🔲runes_transfer
    • 🔲Mint Runes
      • runes_estimateMint
      • runes_mint
    • 🔲Etch Runes
      • runes_estimateEtch
      • runes_etch
    • 🔲runes_getOrder
    • 🔲Speed up a Rune Mint or Etch order
      • 🔲runes_estimateRbfOrder
      • 🔲runes_rbfOrder
  • STACKS METHODS
    • 🔴stx_getAccounts
    • 🔴stx_signMessage
    • 🔴stx_signStructuredMessage
    • 🔴stx_transferStx
    • 🔴stx_signTransaction
    • 🔴stx_callContract
    • 🔴stx_deployContract
  • GUIDES
    • Verify Bitcoin message signatures
    • Creating Bitcoin PSBTs
    • 📱Mobile Integration
    • Next.js support
  • RESOURCES
    • App Template
    • Demo App
    • Changelog
    • Github Issues
    • Developer forum
    • BIP322
Powered by GitBook
On this page
  1. BITCOIN METHODS

ord_getInscriptions

PreviouscreateRepeatInscriptionsNextord_sendInscriptions

Last updated 5 months ago

You can use the ord_getInscriptions method to retrieve all your user's , i.e. the list of inscribed sats that their owns, and their key attributes.

Your app must have first and obtained

The response will be paginated when the inscriptions dataset is large. You can set your preferred pagination parameters in the request:

Request parameters
Description

limit ( optional)

An integer defining the number of inscriptions returned per page. Defaults to 60, capped at 100.

offset ( optional)

The number of results to skip over before returning new results. Defaults to 0.

import { request } from 'sats-connect';

const response = await request('ord_getInscriptions', undefined);

if (response.status === 'success') {
  console.log(response.result);
} else {
  console.error(response.error);
}

The ord_getInscriptions method will not trigger any operation or prompt your user to sign any transaction. It will return an inscriptions objects, detailing the connected ordinal address's inscriptions holdings:

inscriptions
Description

total

an integer representing the total count of inscriptions held by the connected ordinal address

[inscription]

an array of objects representing each inscription held by the connected ordinal address, with the below properties:

  • inscriptionId - string: the of the inscription.

  • inscriptionNumber - string: the of the inscription.

  • parentInscriptionId - string: the of the inscription. ( optional, defaults to null)

  • collectionName - string: the name of the ( optional, defaults to null)

  • contentType - number: the type of the content inscribed on the sat

  • genesisTransaction - string: the txid of the inscription's

  • timestamp - number: the timestamp of the block the inscription was created on

  • satNumber - string: the number of the inscribed sat

  • output - string: the output containing the inscribed sat as txid:vout

  • postage - string : the size of the inscription’s containing output in sats

  • contentType - number : the content type of inscription.

page_info

an object helping you identify the page queried and its location in a paginated response

  • page_number - integer: the number of the page queried

  • total_pages - integer: the total number of pages required for the response dataset, for the page_size specified in the request

🎨
Inscriptions
connected wallet's ordinal address
connected to the wallet
account read permissions.
ℹ️
ℹ️
ℹ️
ℹ️
id
number
id
parent
parent collection
content
genesis transaction