Ordinals API

A valid Bitcoin address

The unique outpoint, in the format {txid}:{vout}.

The value in sats.

A list of rune balances.

A list of inscription IDs.

A valid Bitcoin address

A valid Bitcoin address

Used to retrieve the next page of inscriptions (e.g. ?page=2). Max page: 1000.

A valid Bitcoin address

The name of the rune (without spacers)

The amount of runes held by the address. Formatted as a string, because the amount can be very large.

A valid Bitcoin address

The unique name of the BRC-20 token

The overall amount of tokens held by the address

The amount of "idle" tokens held by the address

The amount of tokens ready to be sent to another address

A valid Bitcoin address

The categories (satributes) that the sat belongs to. See full list of satributes.

The range of sat numbers owned by the address that belong to the category. The first number is inclusive, and the second is exclusive (i.e. the range [1964333750000000, 1964333750000001] only includes the sat number 1964333750000000)

A valid Bitcoin address

Can be either:

• transfer (Default). To see sent and received inscriptions.
• inscribe. To see inscriptions inscribed directly to this address.

Used to retrieve the next page of activity (e.g. ?page=2). Max page: 250.

Specify the sorting order. Can be either:

• newest (default)
• oldest

The TXID (Transaction ID) of the transaction

The type of activity. Can be one of the following:

• SEND: the address sent an inscription to another address
• RECEIVE: the address received an inscription from another address

Unique identifier for the inscription.

The Bitcoin address of the counterpart (if the activity is a SEND or RECEIVE)

Whether the inscription was spent as a fee (if the activity is a SEND)

Whether the event has been confirmed or not yet (i.e. included in a block)

A datetime string for when the event occured

A valid Bitcoin address

Used to retrieve the next page of activity (e.g. ?page=2). Max page: 1000.

Specify the sorting order. Can be either:

• newest (default)
• oldest

A valid Bitcoin address

Used to retrieve the next page of activity (e.g. ?page=2). Max page: 1000.

Specify the sorting order. Can be either:

• newest (default)
• oldest

The BRC-20 ticker (4 or 5 characters)

Can be TRANSFER, MINT or DEPLOY

Address sending the token

Address receiving the token

The amount of tokens sent

The inscription ID associated with the BRC-20 transaction

A datetime string for when the BRC-20 inscription was created.

A valid Bitcoin address

Whether the address has any inscription transfer or inscribe activity

Whether the address has any rune activity

Whether the address has any BRC-20 activity

The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

The transaction ID

The transaction's fee, in sats

The size of the transaction, in bytes

The weight of the transaction, in weight units (1 vbyte = four weight units)

Whether the transaction is confirmed (i.e. included in a block or not)

If the transaction is included in a block, this field will give you the block's hash.

Whether Ordiscan has fully indexed the transaction's inscriptions and runes. This can take up to a few minutes.

Once indexed, this field returns true if the transaction has any new inscriptions associated with it.

Once indexed, this field returns true if the transaction has any inscription transfers associated with it.

Once indexed, this field returns true if the transaction has any rune mints or transfers associated with it.

The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

The address that sent the inscription

The address that received the inscription

The transferred inscription's ID (e.g.f07c9f52c8337edbb60ae4345150a48e287f17006a651300ad18306a2e86868ci0)

Whether the inscription was spent as a fee or not (sometimes done by accidenta)

The transaction's ID

Whether the transaction has been confirmed (i.e. included in a block or not)

If confirmed, returns a datetime string of the block time.

The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

The transaction ID.

A list of runestone messages. Each object contains:

• rune (the unique rune name, without spacers)
• type (can be ETCH, MINT, TRANSFER)

A list of inputs with runes. Each object contains:

• address: the address that the runes got transferred from.
• output: the transaction output that was spent (formatted as txid:vout).
• rune: the unique rune name, without spacers.
• rune_amount: the amount of runes, as a string.

A list of outputs with runes. Each object contains:

• address: the address that the runes got transferred to.
• vout: the index of the transaction output that the runes got transferred to.
• rune: the unique rune name, without spacers.
• rune_amount: the amount of runes, as a string.

A datetime string of the transaction's block's timestamp.

The inscription ID (e.g. b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0)

Unique identifier for the inscription.

The inscription number.

The inscription content type.

The current owner of the inscription (Bitcoin address).

The current tx output associated with the inscription.

The initial owner of the inscription (Bitcoin address).

The initial tx output associated with the inscription.

A datetime string for when the inscription was created.

URL to the inscription content (can be a text file, image, video, etc).

The unique collection identifier of the inscription (if it belongs to a collection that's been indexed)

The sat number that it's is inscribed on.

The satributes for the inscription (e.g. UNCOMMON, PIZZA, PALINDROME... etc).

A JSON object with the inscription's metadata. The data can be nested.

The inscription's specified metaprotocol (e.g. cbrc-20:deploy).

The inscription's parent, inscribed through Provenance

The inscription's nominated delegate

If it's a recursive inscription, this will return a list of inscription IDs that are being used as modules to generate the recursive inscription.

The sats name (e.g. john.sats) registered through this inscription (if the inscription is identified as a sats name).

A BRC-20 Action object (if the inscription has been verified as a BRC-20 action).

The inscription ID (e.g. b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0)

The unique name of the trait

The value of the trait

The rarity of the trait. The number is the percentage of items in the collection that share this specific trait (i.e. smaller = more rare).

Specify the sorting order for the returned inscriptions. Can be either:

• inscription_number_desc (default). Sorts by descending inscription number.
• inscription_number_asc. Sorts by ascending inscription number.

Only return inscriptions above a certain inscription number. Useful for pagination.

Only return inscriptions below a certain inscription number. Useful for pagination.

Filter inscriptions by satribute. Valid values: uncommon, rare, epic, legendary, mythic, black_uncommon, black_rare, black_epic, black_legendary, black_mythic, nakamoto, first_tx, vintage, pizza, hitman, palindrome, block_9, block_78, alpha, omega.

The inscription ID (e.g. b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0)

Used to retrieve the next page of activity (e.g. ?page=2). Max page: 1000.

Specify the sorting order. Can be either:

• newest (default)
• oldest

Specify the sorting order for the runes. Can be either:

• newest (default)
• oldest

Only return runes etched after a certain rune number. Useful for pagination when the sort order is oldest.

Only return runes etched before a certain rune number. Useful for pagination when the sort order is newest.

The unique ID for the Rune (example: 840000:1)

The unique name of the rune, without spacers (example: UNCOMMONGOODS)

The formatted name of the rune, with spacers (example: UNCOMMON•GOODS)

The rune's unique sequential number.

The parent inscription ID of the rune (if any). This usually acts as the rune's logo.

The number of decimals supported.

The rune's symbol.

The ID of the bitcoin transaction that etched (created) the rune.

The unix timestamp of the etching transaction. Returns null for the very first hard-coded rune (UNCOMMON•GOODS).

The number of premined runes.

The number of runes created by 1 mint transaction. returns null if the rune doesn't support minting.

The maximum number of mint transactions for the rune.

If set, the rune cannot be minted before this block.

If set, the rune cannot be minted after this block.

The unique name of the rune (without spacers)

The unique ID for the Rune (example: 840000:1)

The unique name of the rune, without spacers (example: UNCOMMONGOODS)

The formatted name of the rune, with spacers (example: UNCOMMON•GOODS)

The rune's unique sequential number.

The parent inscription ID of the rune (if any). This usually acts as the rune's logo.

The number of decimals supported.

The rune's symbol.

The ID of the bitcoin transaction that etched (created) the rune.

The unix timestamp of the etching transaction. Returns null for the very first hard-coded rune (UNCOMMON•GOODS).

The number of premined runes.

The number of runes created by 1 mint transaction. returns null if the rune doesn't support minting.

The maximum number of mint transactions for the rune.

If set, the rune cannot be minted before this block.

If set, the rune cannot be minted after this block.

The current supply for this rune (includes the premine).

The current number of mint transactions for this rune.

The unique name of the rune (without spacers)

The price of one unit of the rune, denominated in sats (1 bitcoin = 100,000,000 sats)

The price of one unit of the rune, denominated in US dollars

The market cap of the rune, in Bitcoin (BTC)

The market cap of the rune, in US dollars

The desired name of the rune (without spacers)

The name of the rune (without spacers)

Status can be:

• ETCHED (name already taken)
• AVAILABLE (name can be etched)
• LOCKED (name hasn't been unlocked yet)
• RESERVED (name is too long and can only be assigned randomly)

The block at which the name gets unlocked (can be in the past).

The time and date when the name got or will get unlocked. If it's in the future, this will be a rough estimate based on the expected time between blocks.

Used to retrieve the next page of inscriptions (e.g. ?page=2)

The unique identifier for a collection (e.g. taproot-wizards)

The collection's name

The collection's unique identifier

A description of the collection

A link to the collection's Twitter/X account (if it exists)

A link to the collection's Discord server (if it exists)

A link to the collection's website (if it exists)

The number of inscriptions in the collections

The unique identifier for a collection (e.g. taproot-wizards)

Used to retrieve the next page of inscription IDs (e.g. ?page=2)

The unique identifier for a collection (e.g. taproot-wizards)

The latest price for an inscription in the collection, denominated in sats (1 bitcoin = 100,000,000 sats)

The latest price for an inscription in the collection, denominated in US dollars

The market cap of the collection, in Bitcoin (BTC)

The market cap of the collection, in US dollars

Specify the sorting order for the alkanes. Can be either:

• newest (default)
• oldest

Filter by alkane type. Can be one of:

• TOKEN
• CONTRACT
• NFT_COLLECTION
• NFT_ITEM

Page number for pagination (defaults to 1)

The unique identifier of the alkane

The name of the alkane (if available)

The symbol of the alkane (if available)

The type of alkane (TOKEN, CONTRACT, NFT_COLLECTION, or NFT_ITEM)

The CDN URL for the alkane's icon image (if available)

The premined supply amount

The amount minted per mint operation (if applicable)

The maximum number of mints allowed (if applicable)

The transaction ID where the alkane was deployed

The ISO timestamp when the alkane was deployed

The unique alkane identifier (e.g., "2:42")

The current total supply

The current number of mints that have occurred

The unique alkane identifier (e.g., "2:42")

The contract name of the alkane

The available methods and their definitions for the alkane contract. Each method contains:

• name: The method name (string)
• opcode: The unique opcode identifier for the method (number)
• params: Array of parameter objects, each with type and name properties
• returns: The return type of the method (string)

A valid Bitcoin address

The unique identifier of the alkane

The name of the alkane (if available)

The symbol of the alkane (if available)

The amount of alkanes held by the address. Note that all tokens use 8 decimals by default.

A valid Bitcoin address

The unique outpoint, in the format {txid}:{vout}.

The value in sats.

A list of alkanes balances

The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

The transaction ID.

A list of protostone messages. Each object contains:

• type: the protostone message type (TRANSFER, CONTRACT_CALL, CONTRACT_DEPLOY, FACTORY_DEPLOY or FACTORY_CLONE)
• alkaneId: the unique alkane ID that was called (if available)
• opcode: the contract opcode that was called (if available)

Execution trace of alkane operations in the transaction. Contains an array of events of with the types invoke, return or create.

Specify the sorting order. Can be either:

• newest
• oldest (default)

Used to retrieve the next page of tokens (e.g. ?page=2)

The unique 4-character tick of the BRC-20 token.

The inscription ID of the deploy inscription for this token.

The max supply available to mint.

The number of tokens minted so far.

The current market price for the token in USD. This will only be available for the most well-known tokens, otherwise it returns null.

The unique tick of the token. Can be either uppercase or lowercase.

The unique 4-character tick of the BRC-20 token.

The inscription ID of the deploy inscription for this token.

The max supply available to mint.

The number of tokens minted so far.

The current market price for the token in USD. This will only be available for the most well-known tokens, otherwise it returns null.

A valid sat number (i.e. any number between 0 and 2099999997689999)

The unique sat number

The list of satributes that the sat has (if any)

A timestamp of when the sat was created

The Bitcoin block that the sat was created in

The epoch (i.e. halving period) that the sat was created in

A list of inscriptions that have been inscribed on this particular sat

A valid Bitcoin UTXO (e.g. 3d57f76284e17370f1ce45e75f68b5960906c4117951607f20ddd19f85c15706:0)

The categories (satributes) that the sat belongs to. See full list of satributes.

The range of sat numbers owned by the address that belong to the category. The first number is inclusive, and the second is exclusive (i.e. the range [1964333750000000, 1964333750000001] only includes the sat number 1964333750000000)

A valid Bitcoin UTXO (e.g. 3d57f76284e17370f1ce45e75f68b5960906c4117951607f20ddd19f85c15706:0)

A valid block hash or block height

The unique hash of the block

The block height

A timestamp of when the block was created

The size of the block

The weight of the block

Can be used to check if the inscriptions and runes in the block have been indexed yet. Contains the following keys with boolean values:

• runes_indexed
• inscriptions_indexed

A valid block hash or block height