Ordinals API

Introduction

In order to use the Ordiscan API you first need to create an account and obtain an API key.

Your API key is used to authenticate all your requests to the Ordiscan API. You need to pass it as a Bearer token in the "Authorization" header.

If you're using JavaScript/TypeScript, check out the Ordiscan SDK!

Example request:

GET

/v1/inscription/{inscription_id}

curl -G https://api.ordiscan.com/v1/inscription/b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0 \
  -H "Authorization: Bearer {your-api-key}"

Pricing Plans:

Free

/month

Get started for free. No strings attached.

3,000 requests /month

100 requests /minute

Standard

$59

/month

Billed monthly. Cancel anytime.

1M requests /month

100 requests /minute

Pro

$199

/month

Billed monthly. Cancel anytime.

5M requests /month

300 requests /minute

Need a bigger subscription? Get in touch!

🔑 Address balance

UTXOs

Get all UTXOs owned by a Bitcoin address and the inscriptions and runes tied to them (if they have any).

Parameters:

Name
address
Type
string
Description
A valid Bitcoin address

Response:

An array of objects with the following keys:

Name
outpoint
Type
string
Description
The unique outpoint, in the format {txid}:{vout}.
Name
value
Type
number
Description
The value in sats.
Name
runes
Type
RuneBalance[]
Description
A list of rune balances.
Name
inscriptions
Type
string[]
Description
A list of inscription IDs.

GET

/v1/address/{bitcoin-address}/utxos

curl -G https://api.ordiscan.com/v1/address/bc1pr8vjq0fk89f5sw3r4n9scrasvw7kaud9akhzw57c3ygycsjspvvseyjcma/utxos \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "outpoint": "04295c622b83ffc81036dbfdc9c5b160468fbb5c22e35b45126d6e876b556645:1686",
      "value": 546,
      "runes": [
        {
          "name": "DOGGOTOTHEMOON",
          "balance": "100000000000"
        }
      ],
      "inscriptions": [
        "56636ffca4c65b73b46003682d9f8ba10e8af0a8012adebf40f0c849c0b16084i0"
      ]
    },
    // ...
  ]
}

Owned inscriptions

Get all inscriptions owned by a Bitcoin address. Limited to 100 inscriptions per page.

Parameters:

Name
address
Type
string
Description
A valid Bitcoin address
Name
page
Type
number (optional)
Description
Used to retrieve the next page of inscriptions (e.g. ?page=2)

Response:

A list of inscription objects

GET

/v1/address/{bitcoin-address}/inscriptions

curl -G https://api.ordiscan.com/v1/address/bc1pr8vjq0fk89f5sw3r4n9scrasvw7kaud9akhzw57c3ygycsjspvvseyjcma/inscriptions \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "inscription_id": "0301e0480b374b32851a9462db29dc19fe830a7f7d7a88b81612b9d42099c0aei0",
      "inscription_number": 652,
      "content_type": "image/jpeg",
      "owner_address": "bc1pr8vjq0fk89f5sw3r4n9scrasvw7kaud9akhzw57c3ygycsjspvvseyjcma",
      "owner_output": "ca8a84d9c1e8a9e4ba607835295887979c1824a10bb89facb0dbe6c3b428a467:0",
      "genesis_address": "bc1p5uvtaxzkjwvey2tfy49k5vtqfpjmrgm09cvs88ezyy8h2zv7jhas9tu4yr",
      "genesis_output": "0301e0480b374b32851a9462db29dc19fe830a7f7d7a88b81612b9d42099c0ae:0",
      "timestamp": "2023-02-01T20:38:33.000Z",
      "sat": 1308063627208201,
      "content_url": "https://ordiscan.com/content/0301e0480b374b32851a9462db29dc19fe830a7f7d7a88b81612b9d42099c0aei0",
    }
  ]
}

Rune balance

Get the rune balance for a Bitcoin address. The returned balances use the rune's smallest denomination, and therefore never have decimals.

Parameters:

Name
address
Type
string
Description
A valid Bitcoin address

Response:

An array of objects with the following keys:

Name
name
Type
string
Description
The name of the rune (without spacers)
Name
balance
Type
string
Description
The amount of runes held by the address. Formatted as a string, because the amount can be very large.

GET

/v1/address/{bitcoin-address}/runes

curl -G https://api.ordiscan.com/v1/address/bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06/runes \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "name": "UNCOMMONGOODS",
      "balance": "10"
    },
    {
      "name": "RSICGENESISRUNE",
      "balance": "100000"
    },
    {
      "name": "DOGGOTOTHEMOON",
      "balance": "300000"
    },
  ]
}

BRC-20 balance

Get the BRC-20 balance for a Bitcoin address. BRC-20 tokens are address-based, not UTXO-based, so they cannot be spent accidentally.

Parameters:

Name
address
Type
string
Description
A valid Bitcoin address

Response:

An array of objects with the following keys:

Name
tick
Type
string
Description
The unique name of the BRC-20 token
Name
balance
Type
number
Description
The amount of tokens held by the address

GET

/v1/address/{bitcoin-address}/brc20

curl -G https://api.ordiscan.com/v1/address/bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06/brc20 \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "tick": "ORDI",
      "balance": 150
	},
    {
      "tick": "SATS",
      "balance": 100000000
	}
  ]
}

Rare sat balance

Retrieve all rare sats for a specific Bitcoin address. If the address has no rare sats, it will return an empty array.

Parameters:

Name
address
Type
string
Description
A valid Bitcoin address

Response:

An array of objects with the following keys:

Name
satributes
Type
string[]
Description
The categories (satributes) that the sat belongs to. See full list of satributes.
Name
ranges
Type
number[][]
Description
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)

GET

/v1/address/{bitcoin-address}/rare-sats

curl -G https://api.ordiscan.com/v1/address/bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06/rare-sats \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
	  "satributes": [
	    "UNCOMMON",
	    "ALPHA"
	  ],
	  "ranges": [
	    [
		  1964333750000000,
		  1964333750000001
		],
	  ]
	},
    {
	  "satributes": [
		"PIZZA"
	  ],
	  "ranges": [
		[
          120485000000000,
          120485000001000,
		]
	  ]
	},
  ]
}

📊 Address activity

Inscription activity

Retrieve all inscription transfers for a specific Bitcoin address. Limited to 100 events per page.

Parameters:

Name
address
Type
string
Description
A valid Bitcoin address
Name
type
Type
string (optional)
Description
Can be either:
- transfer (Default). To see sent and received inscriptions.
- inscribe. To see inscriptions inscribed directly to this address.
Name
page
Type
number (optional)
Description
Used to retrieve the next page of activity (e.g. ?page=2)

Response:

Name
txid
Type
string
Description
The TXID (Transaction ID) of the transaction
Name
type
Type
string
Description
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
Name
inscription_id
Type
string
Description
Unique identifier for the inscription.
Name
counterpart_address
Type
string
Description
The Bitcoin address of the counterpart (if the activity is a SEND or RECEIVE)
Name
spent_as_fee
Type
boolean
Description
Whether the inscription was spent as a fee (if the activity is a SEND)
Name
confirmed
Type
boolean
Description
Whether the event has been confirmed or not yet (i.e. included in a block)
Name
timestamp
Type
string
Description
A datetime string for when the event occured

GET

/v1/address/{bitcoin-address}/activity

curl -G https://api.ordiscan.com/v1/address/112AmK5SB2uT7miUTqjLrcRJB7myLBM7xu/activity \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "txid": "71c28a89a7898f3c667f6f68022d263eb96afa283d6ed4cb900bd204638d7883",
      "type": "RECEIVE",
      "inscription_id": "1eabfab072b44f520bbc919abd8aba51dbebf5758c759e4572b7e1ad356fe647i0",
      "counterpart_address": "bc1qmjru4ce5xuma66lsmw2pv38wv9nscq9nxmwkv9",
      "spent_as_fee": false,
      "confirmed": true,
      "timestamp": "2023-04-23T21:48:00.000Z"
    }
  ]
}

Runes activity

Retrieve all runic transactions for a specific Bitcoin address. Limited to 100 events per page.

Parameters:

Name
address
Type
string
Description
A valid Bitcoin address
Name
page
Type
number (optional)
Description
Used to retrieve the next page of activity (e.g. ?page=2)
Name
sort
Type
string (optional)
Description
Specify the sorting order. Can be either:
- newest (default)
- oldest

Response:

A list of runic transactions

GET

/v1/address/{bitcoin-address}/activity/runes

curl -G https://api.ordiscan.com/v1/address/bc1p5m3rj5pnx0n2d6rqlkkkfs2fgjgyj7wwwe9jhz7tuqz50e5ea3aqjmmjrg/activity/runes \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "txid": "6590112554c48497ad171c60153d31f54ec933f145e15900e7af7506a58a54e9",
      "runestone_messages": [
        {
          "rune": "DOGGOTOTHEMOON",
          "type": "TRANSFER"
        }
      ],
      "inputs": [
        {
          "address": "bc1p5m3rj5pnx0n2d6rqlkkkfs2fgjgyj7wwwe9jhz7tuqz50e5ea3aqjmmjrg",
          "output": "6a7a3b97991dc7042ee9ca3cb98c54fa127b0ba24025cba66c870be4108e0483:574",
          "rune": "DOGGOTOTHEMOON",
          "rune_amount": "88980600000"
        }
      ],
      "outputs": [
        {
          "address": "bc1p2klyz46wf9duj5utnmcv4fyjh5wx5mqp73lym3e9eshk2c2aqj7qh2h0v8",
          "vout": 0,
          "rune": "DOGGOTOTHEMOON",
          "rune_amount": "88980600000"
        }
      ],
      "timestamp": "2024-05-24T06:00:45.000Z"
    },
  ]
}

BRC-20 activity

Retrieve all BRC-20 transactions for a specific Bitcoin address. Limited to 100 events per page.

Parameters:

Name
address
Type
string
Description
A valid Bitcoin address
Name
page
Type
number (optional)
Description
Used to retrieve the next page of activity (e.g. ?page=2)
Name
sort
Type
string (optional)
Description
Specify the sorting order. Can be either:
- newest (default)
- oldest

Response:

Name
ticker
Type
string
Description
The BRC-20 ticker (4 or 5 characters)
Name
type
Type
string
Description
Can be TRANSFER, MINT or DEPLOY
Name
from_address
Type
string
Description
Address sending the token
Name
to_address
Type
string
Description
Address receiving the token
Name
amount
Type
number
Description
The amount of tokens sent
Name
inscription_id
Type
string
Description
The inscription ID associated with the BRC-20 transaction
Name
timestamp
Type
string
Description
A datetime string for when the BRC-20 inscription was created.

GET

/v1/address/{bitcoin-address}/activity/brc20

curl -G https://api.ordiscan.com/v1/address/bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06/activity/brc20 \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "ticker": "DOMO",
      "type": "TRANSFER",
      "from_address": "bc1pquadyenr7r40g4ud53lhuajxwz3pjye62pgpvdpkv449l5cs9ftq0qh3a7",
      "to_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06",
      "amount": 1000,
      "inscription_id": "dbc5e8525e7b6332b1af2e30d1f199f15dcca45dc6bae2d97182c0f33ea01a50i0",
      "timestamp": "2023-11-07T22:12:50.246Z"
    },
    {
      "ticker": "DOMO",
      "type": "MINT",
      "from_address": null,
      "to_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06",
      "amount": 1000,
      "inscription_id": "2a81948ab1d860d555bc87d418f5c55314b473cf76b24c8a2f64a8fed9a3b91ci0",
      "timestamp": "2023-10-05T12:12:50.246Z"
    }
  ]
}

➡️ Transaction

Transaction info

Retrieve info for a specific Bitcoin transaction.

Parameters:

Name
txid
Type
string
Description
The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

Response:

Name
txid
Type
string
Description
The transaction ID
Name
fee
Type
number
Description
The transaction's fee, in sats
Name
size
Type
number
Description
The size of the transaction, in bytes
Name
weight
Type
number
Description
The weight of the transaction, in weight units (1 vbyte = four weight units)
Name
confirmed
Type
boolean
Description
Whether the transaction is confirmed (i.e. included in a block or not)
Name
block_hash
Type
string | null
Description
If the transaction is included in a block, this field will give you the block's hash.
Name
indexed
Type
boolean
Description
Whether Ordiscan has fully indexed the transaction's inscriptions and runes. This can take up to a few minutes.
Name
has_inscriptions
Type
boolean
Description
Once indexed, this field returns true if the transaction has any new inscriptions associated with it.
Name
has_inscription_transfers
Type
boolean
Description
Once indexed, this field returns true if the transaction has any inscription transfers associated with it.
Name
has_runes
Type
boolean
Description
Once indexed, this field returns true if the transaction has any rune mints or transfers associated with it.

GET

/v1/tx/{txid}

curl -G https://api.ordiscan.com/v1/tx/7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1 \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": {
    "txid": "7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1",
    "fee": 2227050,
    "size": 58445,
    "weight": 59387,
    "confirmed": true,
    "block_hash": "00000000000000000002ded7429490197a38ca191cead0a7a6ef6b620dc1ec1c",
    "indexed": true,
    "has_inscriptions": true,
    "has_inscription_transfers": true,
    "has_runes": true
  }
}

New inscriptions in TX

Get all the new inscriptions created from the transaction.

Parameters:

Name
txid
Type
string
Description
The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

Response:

A list of inscription objects

GET

/v1/tx/{txid}/inscriptions

curl -G https://api.ordiscan.com/v1/tx/7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1/inscriptions \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "inscription_id": "7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1i0",
      "inscription_number": 70634325,
      "content_type": "text/html;charset=utf-8",
      "owner_address": "bc1p7kg5sqgzh3vvgzfzh8kgd5pd480q5pyr7nzluw7kmyfma7clycaq9lgaja",
      "owner_output": "0ed74d5c7e17ac5131d36c5d76aa084d2eda46358394c9b528d98e0e525b9842:0",
      "genesis_address": "bc1p5k6m3rsnr98mwd7qzsw9qyz0awxffms30axtlpeygkx3hchuusasz5ceuy",
      "genesis_output": "7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1:1",
      "timestamp": "2024-05-05T07:24:24.000Z",
      "sat": 1968750000000000,
      "content_url": "https://ordiscan.com/content/7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1i0",
      "parent_inscription_id": "f07c9f52c8337edbb60ae4345150a48e287f17006a651300ad18306a2e86868ci0",
    }
  ]
}

Transferred inscriptions in TX

Get a list of all inscriptions transferred in the transaction.

Parameters:

Name
txid
Type
string
Description
The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

Response:

An array of objects with the following keys:

Name
from_address
Type
string
Description
The address that sent the inscription
Name
to_address
Type
string
Description
The address that received the inscription
Name
inscription_id
Type
string
Description
The transferred inscription's ID (e.g.f07c9f52c8337edbb60ae4345150a48e287f17006a651300ad18306a2e86868ci0)
Name
spent_as_fee
Type
boolean
Description
Whether the inscription was spent as a fee or not (sometimes done by accidenta)
Name
txid
Type
string
Description
The transaction's ID
Name
confirmed
Type
boolean
Description
Whether the transaction has been confirmed (i.e. included in a block or not)
Name
timestamp
Type
string | null
Description
If confirmed, returns a datetime string of the block time.

GET

/v1/tx/{txid}/inscription-transfers

curl -G https://api.ordiscan.com/v1/tx/7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1/inscription-transfers \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "from_address": "bc1p3fm2w5c5e2kmkf5nuzfymj5dylhr3mt0pvv02td4q7k8609ek2dstdqevk",
      "to_address": "bc1plq4d70nk09hw9rnr0aqmr2lr03kn0v3dywu60m8g6256n0cxtm2q5wh2ah",
      "inscription_id": "f07c9f52c8337edbb60ae4345150a48e287f17006a651300ad18306a2e86868ci0",
      "spent_as_fee": false,
      "txid": "7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1",
      "confirmed": true,
      "timestamp": "2024-05-05T07:24:24.000Z"
    }
  ]
}

Runes in tx

Get a list of all minted and transferred runes in the transaction.

Parameters:

Name
txid
Type
string
Description
The transaction ID (txid) (e.g. 7d0a2dd897222913d58fc957b0429526117a0a61c964642fe93b077f328ccec1)

Response:

Name
txid
Type
string
Description
The transaction ID.
Name
runestone_messages
Type
RunestoneMessage[]
Description
A list of runestone messages. Each object contains:
- rune (the unique rune name, without spacers)
- type (can be ETCH, MINT, TRANSFER)
Name
inputs
Type
RunicInput[]
Description
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.
Name
outputs
Type
RunicOutput[]
Description
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.
Name
timestamp
Type
string
Description
A datetime string of the transaction's block's timestamp.

GET

/v1/tx/{txid}/runes

curl -G https://api.ordiscan.com/v1/tx/2dc8414b21accf4a54421cadaa00166bfa64bb1d5019c99b151897fa0bb71534/runes \
  -H "Authorization: Bearer {your-api-key}"

    {
      "data": {
        "txid": "2dc8414b21accf4a54421cadaa00166bfa64bb1d5019c99b151897fa0bb71534",
        "runestone_messages": [
          {
            "rune": "DOGGOTOTHEMOON",
            "type": "TRANSFER"
          }
        ],
        "inputs": [
          {
            "address": "bc1p2lrqw3cv9vqzsajf677ght7v38hk7rzfjwm2x9mgqqypnfjphywsg5l237",
            "output": "3691b43e7a679dc4550a2fb69cc90581a3b532847b3d04a45dc3ec78cefb57e9:1826",
            "rune": "DOGGOTOTHEMOON",
            "rune_amount": "88980600000"
          }
        ],
        "outputs": [
          {
            "address": "bc1p8r9p0hthz0jsw75m8s34egdnwft5gl5kdvqt6fp07mcfryxetavszefx50",
            "vout": 0,
            "rune": "DOGGOTOTHEMOON",
            "rune_amount": "88980600000"
          }
        ]
      }
    }

🖼️ Inscriptions

Inscription info

Retrieve the info for a specific inscription.

Parameters:

Name
id
Type
string
Description
The inscription ID (e.g. b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0)

Response:

Name
inscription_id
Type
string
Description
Unique identifier for the inscription.
Name
inscription_number
Type
number
Description
The inscription number.
Name
content_type
Type
string
Description
The inscription content type.
Name
owner_address
Type
string
Description
The current owner of the inscription (Bitcoin address).
Name
owner_output
Type
string
Description
The current tx output associated with the inscription.
Name
genesis_address
Type
string
Description
The initial owner of the inscription (Bitcoin address).
Name
genesis_output
Type
string
Description
The initial tx output associated with the inscription.
Name
timestamp
Type
string
Description
A datetime string for when the inscription was created.
Name
content_url
Type
string
Description
URL to the inscription content (can be a text file, image, video, etc).
Name
collection_slug
Type
string | null
Description
The unique collection identifier of the inscription (if it belongs to a collection that's been indexed)
Name
sat
Type
number
Description
The sat number that it's is inscribed on.
Name
satributes
Type
string array
Description
The satributes for the inscription (e.g. UNCOMMON, PIZZA, PALINDROME... etc).
Name
metadata
Type
object | null
Description
A JSON object with the inscription's metadata. The data can be nested.
Name
metaprotocol
Type
string | null
Description
The inscription's specified metaprotocol (e.g. cbrc-20:deploy).
Name
parent_inscription_id
Type
string | null
Description
The inscription's parent, inscribed through Provenance
Name
delegate_inscription_id
Type
string | null
Description
The inscription's nominated delegate
Name
submodules
Type
string[]
Description
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.
Name
sats_name
Type
string | null
Description
The sats name (e.g. john.sats) registered through this inscription (if the inscription is identified as a sats name).
Name
brc20_action
Type
object | null
Description
A BRC-20 Action object (if the inscription has been verified as a BRC-20 action).

GET

/v1/inscription/{inscription-id}

curl -G https://api.ordiscan.com/v1/inscription/b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0 \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": {
    "inscription_id": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0",
    "inscription_number": 348020,
    "content_type": "text/plain;charset=utf-8",
    "owner_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06",
    "owner_output": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735:0",
    "genesis_address": "bc1pxaneaf3w4d27hl2y93fuft2xk6m4u3wc4rafevc6slgd7f5tq2dqyfgy06",
    "genesis_output": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735:0",
    "timestamp": "2023-03-08T04:16:31.000Z",
    "metadata": null,
    "metaprotocol": null,
    "sat": 923155354107609,
    "content_url": "https://ordiscan.com/content/b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0",
    "parent_inscription_id": null,
    "delegate_inscription_id": null,
    "satributes": [],
    "submodules": [],
    "brc20_action": {
      "type": "DEPLOY",
      "tick": "ORDI"
    }
  }
}

Inscription traits

Retrieve the traits for an inscription (if they've been indexed for the collection).

Parameters:

Name
id
Type
string
Description
The inscription ID (e.g. b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0)

Response:

A list of objects containing:

Name
name
Type
string
Description
The unique name of the trait
Name
value
Type
string
Description
The value of the trait
Name
rarity
Type
number
Description
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).

GET

/v1/inscription/{inscription-id}/traits

curl -G https://api.ordiscan.com/v1/inscription/783513f2044d48fdf303e58b1d8878a2394a695e2a9cac320c4823f09524a296i0/traits \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "name": "Background",
      "value": "Orange",
      "rarity": 8
    },
    {
      "name": "Body",
      "value": "Green",
      "rarity": 20
    },
    // ...
  ]
}

List of inscriptions

Retrieve the full list of indexed inscriptions. Limited to 100 inscriptions per page.

Parameters:

Name
sort
Type
string (optional)
Description
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.
Name
after
Type
number (optional)
Description
Only return inscriptions above a certain inscription number. Useful for pagination.
Name
before
Type
number (optional)
Description
Only return inscriptions below a certain inscription number. Useful for pagination.

Response:

A list of inscription objects

GET

/v1/inscriptions

curl -G https://api.ordiscan.com/v1/inscriptions \
  -H "Authorization: Bearer {your-api-key}" \
  -d sort="inscription_number_desc"

{
  "data": [
    {
      "inscription_id": "1eabfab072b44f520bbc919abd8aba51dbebf5758c759e4572b7e1ad356fe647i0",
      "inscription_number": 1523361,
      "content_type": "text/plain;charset=utf-8",
      "owner_address": "112AmK5SB2uT7miUTqjLrcRJB7myLBM7xu",
      "owner_output": "71c28a89a7898f3c667f6f68022d263eb96afa283d6ed4cb900bd204638d7883:0",
      "timestamp": "2023-04-23T21:48:00.000Z",
      "content_url": "https://ordiscan.com/content/1eabfab072b44f520bbc919abd8aba51dbebf5758c759e4572b7e1ad356fe647i0"
    }
  ]
}

Transfer activity

Get the list of transfers for a specific inscription. Limited to 20 per page.

Parameters:

Name
id
Type
string
Description
The inscription ID (e.g. b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0)
Name
page
Type
number (optional)
Description
Used to retrieve the next page of activity (e.g. ?page=2)

Response:

A list of inscription transfers

GET

/v1/inscription/{inscription_id}/activity

curl -G https://api.ordiscan.com/v1/inscription/26482871f33f1051f450f2da9af275794c0b5f1c61ebf35e4467fb42c2813403i0/activity \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "from_address": "bc1p77u6q4lfq60qgkslyf7z3j0dwxnmuqkljzlvgl4sxyh40pa87njq2k4eul",
      "to_address": "bc1pdrm7tcyk4k6c3cdcjwkp49jmfrwmtvt0dvqyy7y4qp79tgks4lmqdpj6rw",
      "inscription_id": "26482871f33f1051f450f2da9af275794c0b5f1c61ebf35e4467fb42c2813403i0",
      "spent_as_fee": false,
      "txid": "5fddcbdc3eb21a93e8dd1dd3f9087c3677f422b82d5ba39a6b1ec37338154af6",
      "confirmed": true,
      "timestamp": "2023-03-03T23:19:50.000Z"
    }
  ]
}

🔲 Runes

List runes

Get a list of the latest runes. Limited to 100 per request.

Parameters:

Name
sort
Type
string (optional)
Description
Specify the sorting order for the runes. Can be either:
- newest (default)
- oldest
Name
after
Type
number (optional)
Description
Only return runes etched after a certain rune number. Useful for pagination when the sort order is oldest.
Name
before
Type
number (optional)
Description
Only return runes etched before a certain rune number. Useful for pagination when the sort order is newest.

Response:

Name
id
Type
string
Description
The unique ID for the Rune (example: 840000:1)
Name
name
Type
string
Description
The unique name of the rune, without spacers (example: UNCOMMONGOODS)
Name
formatted_name
Type
string
Description
The formatted name of the rune, with spacers (example: UNCOMMON•GOODS)
Name
number
Type
number
Description
The rune's unique sequential number.
Name
inscription_id
Type
string | null
Description
The parent inscription ID of the rune (if any). This usually acts as the rune's logo.
Name
decimals
Type
number
Description
The number of decimals supported.
Name
symbol
Type
string
Description
The rune's symbol.
Name
etching_txid
Type
string | null
Description
The ID of the bitcoin transaction that etched (created) the rune.
Name
timestamp_unix
Type
string | null
Description
The unix timestamp of the etching transaction. Returns null for the very first hard-coded rune (UNCOMMON•GOODS).
Name
premined_supply
Type
string
Description
The number of premined runes.
Name
amount_per_mint
Type
string | null
Description
The number of runes created by 1 mint transaction. returns null if the rune doesn't support minting.
Name
mint_count_cap
Type
string | null
Description
The maximum number of mint transactions for the rune.
Name
mint_start_block
Type
number | null
Description
If set, the rune cannot be minted before this block.
Name
mint_end_block
Type
number | null
Description
If set, the rune cannot be minted after this block.

GET

/v1/runes

curl -G https://api.ordiscan.com/v1/runes?sort=oldest \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "id": "1:0",
      "name": "UNCOMMONGOODS",
      "formatted_name": "UNCOMMON•GOODS",
      "spacers": 128,
      "number": 0,
      "inscription_id": null,
      "decimals": 0,
      "mint_count_cap": "340282366920938463463374607431768211455",
      "symbol": "⧉",
      "etching_txid": null,
      "amount_per_mint": "1",
      "timestamp_unix": null,
      "premined_supply": "0",
      "mint_start_block": 840000,
      "mint_end_block": 1050000
    },
    // ...
  ],
}

Rune info

Get the etched info for a rune.

Parameters:

Name
name
Type
string
Description
The unique name of the rune (without spacers)

Response:

The same data as when fetching the list of runes, but also has the additional properties current_supply and current_mint_count.

Name
id
Type
string
Description
The unique ID for the Rune (example: 840000:1)
Name
name
Type
string
Description
The unique name of the rune, without spacers (example: UNCOMMONGOODS)
Name
formatted_name
Type
string
Description
The formatted name of the rune, with spacers (example: UNCOMMON•GOODS)
Name
number
Type
number
Description
The rune's unique sequential number.
Name
inscription_id
Type
string | null
Description
The parent inscription ID of the rune (if any). This usually acts as the rune's logo.
Name
decimals
Type
number
Description
The number of decimals supported.
Name
symbol
Type
string
Description
The rune's symbol.
Name
etching_txid
Type
string | null
Description
The ID of the bitcoin transaction that etched (created) the rune.
Name
timestamp_unix
Type
string | null
Description
The unix timestamp of the etching transaction. Returns null for the very first hard-coded rune (UNCOMMON•GOODS).
Name
premined_supply
Type
string
Description
The number of premined runes.
Name
amount_per_mint
Type
string | null
Description
The number of runes created by 1 mint transaction. returns null if the rune doesn't support minting.
Name
mint_count_cap
Type
string | null
Description
The maximum number of mint transactions for the rune.
Name
mint_start_block
Type
number | null
Description
If set, the rune cannot be minted before this block.
Name
mint_end_block
Type
number | null
Description
If set, the rune cannot be minted after this block.
Name
current_supply
Type
string
Description
The current supply for this rune (includes the premine).
Name
current_mint_count
Type
number
Description
The current number of mint transactions for this rune.

GET

/v1/rune/{name}

curl -G https://api.ordiscan.com/v1/rune/UNCOMMONGOODS \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": {
    "id": "1:0",
    "name": "UNCOMMONGOODS",
    "formatted_name": "UNCOMMON•GOODS",
    "spacers": 128,
    "number": 0,
    "inscription_id": null,
    "decimals": 0,
    "mint_count_cap": "340282366920938463463374607431768211455",
    "symbol": "⧉",
    "etching_txid": null,
    "amount_per_mint": "1",
    "timestamp_unix": null,
    "premined_amount": "0",
    "mint_start_block": 840000,
    "mint_end_block": 1050000,
    "current_supply": "0",
    "current_mint_count": 0
  }
}

Rune market info

Get the latest price and market cap for a rune.

Parameters:

Name
name
Type
string
Description
The unique name of the rune (without spacers)

Response:

Name
price_in_sats
Type
number
Description
The price of one unit of the rune, denominated in sats (1 bitcoin = 100,000,000 sats)
Name
price_in_usd
Type
number
Description
The price of one unit of the rune, denominated in US dollars
Name
market_cap_in_btc
Type
number
Description
The market cap of the rune, in Bitcoin (BTC)
Name
market_cap_in_usd
Type
number
Description
The market cap of the rune, in US dollars

GET

/v1/rune/{name}/market

curl -G https://api.ordiscan.com/v1/rune/DOGGOTOTHEMOON/market \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": {
    "price_in_sats": 4.15,
    "price_in_usd": 0.002529,
    "market_cap_in_btc": 4150,
    "market_cap_in_usd": 252851200
  }
}

Rune name unlock

Check when a specific rune name becomes available to etch.

Parameters:

Name
name
Type
string
Description
The desired name of the rune (without spacers)

Response:

Name
name
Type
string
Description
The name of the rune (without spacers)
Name
status
Type
enum
Description
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)
Name
unlock_block_height
Type
number
Description
The block at which the name gets unlocked (can be in the past).
Name
unlock_block_timestamp
Type
number
Description
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.

GET

/v1/rune-name/{name}

curl -G https://api.ordiscan.com/v1/rune-name/HELLO \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": {
    "name": "HELLO",
    "status": "LOCKED",
    "unlock_block_height": 975173,
    "unlock_block_timestamp": "2026-11-14T23:15:07.000Z"
  }
}

📔 Collections

List collections

Get a list of indexed collections. Limited to 20 per page.

Parameters:

Name
page
Type
number (optional)
Description
Used to retrieve the next page of inscriptions (e.g. ?page=2)

Response:

A list of collection objects.

GET

/v1/collections

curl -G https://api.ordiscan.com/v1/collections \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "name": "Bitcoin Frogs",
      "slug": "bitcoin-frogs",
      "description": "10,000 generative frogs on Bitcoin minted by the Lightning Network",
      "twitter_link": "https://twitter.com/BitcoinFrogs/",
      "discord_link": "https://discord.gg/ymZmyBzaSR",
      "website_link": "https://bitcoinfrogs.com",
      "item_count": 10000
    },
    // ...
  ],
}

Collection info

Get info for a collection.

Parameters:

Name
slug
Type
string
Description
The unique identifier for a collection (e.g. taproot-wizards)

Response:

Name
name
Type
string
Description
The collection's name
Name
slug
Type
string
Description
The collection's unique identifier
Name
description
Type
string
Description
A description of the collection
Name
twitter_link
Type
string|null
Description
A link to the collection's Twitter/X account (if it exists)
Name
discord_link
Type
string|null
Description
A link to the collection's Discord server (if it exists)
Name
website_link
Type
string|null
Description
A link to the collection's website (if it exists)
Name
item_count
Type
number
Description
The number of inscriptions in the collections

GET

/v1/collection/{slug}

curl -G https://api.ordiscan.com/v1/collection/taproot-wizards \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": {
    "name": "Taproot Wizards",
    "slug": "taproot-wizards",
    "description": "magic internet jpegs",
    "twitter_link": "https://twitter.com/TaprootWizards",
    "discord_link": "https://discord.com/invite/taprootwizards",
    "website_link": "https://www.taprootwizards.com",
    "item_count": 2121
  },
}

Collection inscriptions

Get a list of the inscription IDs in a collection. Limited to 1000 per page.

Parameters:

Name
slug
Type
string
Description
The unique identifier for a collection (e.g. taproot-wizards)
Name
page
Type
number (optional)
Description
Used to retrieve the next page of inscription IDs (e.g. ?page=2)

Response:

A list of inscription IDs (as strings).

GET

/v1/collection/{slug}/inscriptions

curl -G https://api.ordiscan.com/v1/collection/taproot-wizards/inscriptions \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    "0301e0480b374b32851a9462db29dc19fe830a7f7d7a88b81612b9d42099c0aei0",
    "1008850869eb564cad900c316a02f65854f531b31a2ef96bacecd536be96b031i0",
    "7edb8802cb4f86a16c6cdfb27c07d6c6c98c83abf4edf14965af3317a1931e3di0",
    "a6d78e0790f122810ec6e6bdaca6bebe58497dad19d47ea349ad33451c6ea153i0",
    "681ec55c4a74f5fed4803e33a97b7f42c1c79ae4281efcffb8f9ede5017b4970i0",
    "7f2fde17c50f9b4333b0a74d433c3bf076d21403f8066c691ee5e5ebc8a38cb7i0",
    "6a45311f03523670cb6bdc7bb9c8f80d5cb30648dd5fc1cd807584e3c74ea0a1i0",
  ]
}

🔘 BRC-20

List BRC-20 tokens

Get a list of the latest BRC-20 tokens. Limited to 20 per page.

Parameters:

Name
sort
Type
string (optional)
Description
Specify the sorting order for the runes. Can be either:
- newest
- oldest (default)
Name
page
Type
number (optional)
Description
Used to retrieve the next page of tokens (e.g. ?page=2)

Response:

Name
tick
Type
string
Description
The unique 4-character tick of the BRC-20 token.
Name
max_supply
Type
number
Description
The max supply available to mint.
Name
minted
Type
number
Description
The number of tokens minted so far.
Name
price
Type
string | null
Description
The current market price for the token in USD. This will only be available for the most well-known tokens, otherwise it returns null.

GET

/v1/brc20

curl -G https://api.ordiscan.com/v1/brc20?sort=oldest \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
     "tick": "ORDI",
      "max_supply": 21000000,
      "minted": 21000000,
      "price": 33.62
    },
    // ...
  ],
}

BRC-20 token info

Parameters:

Name
tick
Type
string
Description
The unique tick of the token. Can be either uppercase or lowercase.

Response:

Name
tick
Type
string
Description
The unique 4-character tick of the BRC-20 token.
Name
max_supply
Type
number
Description
The max supply available to mint.
Name
minted
Type
number
Description
The number of tokens minted so far.
Name
price
Type
string | null
Description
The current market price for the token in USD. This will only be available for the most well-known tokens, otherwise it returns null.

GET

/v1/brc20/{tick}

curl -G https://api.ordiscan.com/v1/brc20/ordi \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": {
    "tick": "ORDI",
    "minted": 21000000,
    "max_supply": 21000000,
    "price": 76.44
  }
}

🟣 Rare sats

Ordiscan indexes a wide range of rare sat categories. You can read more about each satribute on the Rare sats page.

Available satributes:

UNCOMMON
RARE
EPIC
LEGENDARY
MYTHIC
BLACK_UNCOMMON
BLACK_RARE
BLACK_EPIC
BLACK_LEGENDARY
BLACK_MYTHIC
BLOCK_9
BLOCK_78
NAKAMOTO
FIRST_TX
VINTAGE
PIZZA
HITMAN
PALINDROME
ALPHA
OMEGA

Sat info

Get information about any individual sat.

Parameters:

Name
sat_number
Type
number
Description
A valid sat number (i.e. any number between 0 and 2099999997689999)

Response:

Name
sat_number
Type
number
Description
The unique sat number
Name
satributes
Type
string[]
Description
The list of satributes that the sat has (if any)
Name
creation_date
Type
string
Description
A timestamp of when the sat was created
Name
block_height
Type
number
Description
The Bitcoin block that the sat was created in
Name
epoch
Type
number
Description
The epoch (i.e. halving period) that the sat was created in
Name
inscription_ids
Type
string[]
Description
A list of inscriptions that have been inscribed on this particular sat

GET

/v1/sat/{sat_number}

curl -G https://api.ordiscan.com/v1/sat/392052419460 \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": {
    "sat_number": 392052419460,
    "satributes": [
      "BLOCK_78",
      "VINTAGE"
    ],
    "creation_date": "2009-01-04T07:00:05.000Z",
    "block_height": 78,
    "epoch": 0,
    "inscription_ids": [
      "e484c48e4571ddd915ce22dfc037a76c1f42ffcef2fad7c8ee816ed87873fd0ci0"
    ]
  }
}

Rare sats for UTXO

Get all the rare sats for a specific UTXO.

Parameters:

Name
utxo
Type
string
Description
A valid Bitcoin UTXO (e.g. 3d57f76284e17370f1ce45e75f68b5960906c4117951607f20ddd19f85c15706:0)

Response:

An array of objects with the following keys:

Name
satributes
Type
string[]
Description
The categories (satributes) that the sat belongs to. See full list of satributes.
Name
ranges
Type
number[][]
Description
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)

GET

/v1/utxo/{utxo}/rare-sats

curl -G https://api.ordiscan.com/v1/utxo/56b52f2b88db4062833049cadfccd53c372955810f3a4077d0058327540a7f7f:1/rare-sats \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    {
      "satributes": [
        "RARE",
        "ALPHA"
      ],
      "ranges": [
        [
          1940190000000000,
          1940190000000001
        ]
      ]
    },
    // ...
  ]
}

Sat ranges for UTXO

Get all the sat ranges for a specific UTXO, regardless of whether they contain any rare sats or not.

Parameters:

Name
utxo
Type
string
Description
A valid Bitcoin UTXO (e.g. 3d57f76284e17370f1ce45e75f68b5960906c4117951607f20ddd19f85c15706:0)

Response:

An array of ranges. The first number in a range is inclusive, and the second is exclusive.

GET

/v1/utxo/{utxo}/sat-ranges

curl -G https://api.ordiscan.com/v1/utxo/3d57f76284e17370f1ce45e75f68b5960906c4117951607f20ddd19f85c15706:0/sat-ranges \
  -H "Authorization: Bearer {your-api-key}"

{
  "data": [
    [
      740078609838558,
      740078609848558
    ]
  ]
}