Runes API (v0.3.0-beta.5)

Download OpenAPI specification:Download

REST API to get information about Runes

Etchings

Rune etchings

Retrieves a paginated list of rune etchings

query Parameters

offset	integer (Offset) >= 0 Result offset
limit	integer (Limit) [ 1 .. 60 ] Results per page

Responses

Response samples

200

Content type

application/json

{"limit": 20,
"offset": 0,
"total": 1,
"results": [{"id": "840000:1",
"name": "ZZZZZFEHUZZZZZ",
"spaced_name": "Z•Z•Z•Z•Z•FEHU•Z•Z•Z•Z•Z",
"number": 1,
"divisibility": 2,
"symbol": "ᚠ",
"turbo": false,
"mint_terms": {"amount": "100",
"cap": "1111111",
"height_start": 840000,
"height_end": 1050000,
"offset_start": 0,
"offset_end": 200
},
"supply": {"current": "11274916350",
"minted": "274916100",
"total_mints": "250",
"mint_percentage": "59.4567",
"mintable": true,
"burned": "5100",
"total_burns": "17",
"premine": "11000000000"
},
"location": {"block_hash": "00000000000000000000c9787573a1f1775a2b56b403a2d0c7957e9a5bc754bb",
"block_height": 840000,
"tx_id": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e",
"tx_index": 1,
"vout": 100,
"output": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e:100",
"timestamp": 1713571767
}
}
]
}

Rune etching

Retrieves information for a Rune etching

path Parameters

required

Rune ID (string) or Rune number (string) or Rune name (string) or Rune name with spacers (string)

Responses

Response samples

200
404

Content type

application/json

{"id": "840000:1",
"name": "ZZZZZFEHUZZZZZ",
"spaced_name": "Z•Z•Z•Z•Z•FEHU•Z•Z•Z•Z•Z",
"number": 1,
"divisibility": 2,
"symbol": "ᚠ",
"turbo": false,
"mint_terms": {"amount": "100",
"cap": "1111111",
"height_start": 840000,
"height_end": 1050000,
"offset_start": 0,
"offset_end": 200
},
"supply": {"current": "11274916350",
"minted": "274916100",
"total_mints": "250",
"mint_percentage": "59.4567",
"mintable": true,
"burned": "5100",
"total_burns": "17",
"premine": "11000000000"
},
"location": {"block_hash": "00000000000000000000c9787573a1f1775a2b56b403a2d0c7957e9a5bc754bb",
"block_height": 840000,
"tx_id": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e",
"tx_index": 1,
"vout": 100,
"output": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e:100",
"timestamp": 1713571767
}
}

Activity

Rune activity

Retrieves all activity for a Rune

path Parameters

required

Rune ID (string) or Rune number (string) or Rune name (string) or Rune name with spacers (string)

query Parameters

offset	integer (Offset) >= 0 Result offset
limit	integer (Limit) [ 1 .. 60 ] Results per page

Responses

Response samples

200

Content type

application/json

{"limit": 20,
"offset": 0,
"total": 1,
"results": [{"address": "bc1q7jd477wc5s88hsvenr0ddtatsw282hfjzg59wz",
"receiver_address": "bc1pgdrveee2v4ez95szaakw5gkd8eennv2dddf9rjdrlt6ch56lzrrsxgvazt",
"amount": "11000000000",
"operation": "etching",
"location": {"block_hash": "00000000000000000000c9787573a1f1775a2b56b403a2d0c7957e9a5bc754bb",
"block_height": 840000,
"tx_id": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e",
"tx_index": 1,
"vout": 100,
"output": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e:100",
"timestamp": 1713571767
}
}
]
}

Rune activity for address

Retrieves all activity for a Rune address

path Parameters

required	Rune ID (string) or Rune number (string) or Rune name (string) or Rune name with spacers (string)
address required	string (Address) Example: bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5 Bitcoin address

query Parameters

offset	integer (Offset) >= 0 Result offset
limit	integer (Limit) [ 1 .. 60 ] Results per page

Responses

Response samples

200

Content type

application/json

{"limit": 20,
"offset": 0,
"total": 1,
"results": [{"address": "bc1q7jd477wc5s88hsvenr0ddtatsw282hfjzg59wz",
"receiver_address": "bc1pgdrveee2v4ez95szaakw5gkd8eennv2dddf9rjdrlt6ch56lzrrsxgvazt",
"amount": "11000000000",
"operation": "etching",
"location": {"block_hash": "00000000000000000000c9787573a1f1775a2b56b403a2d0c7957e9a5bc754bb",
"block_height": 840000,
"tx_id": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e",
"tx_index": 1,
"vout": 100,
"output": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e:100",
"timestamp": 1713571767
}
}
]
}

Address activity

Retrieves a paginated list of rune activity for an address

path Parameters

address

required

string (Address)

Example: bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5

Bitcoin address

query Parameters

offset	integer (Offset) >= 0 Result offset
limit	integer (Limit) [ 1 .. 60 ] Results per page

Responses

Response samples

200

Content type

application/json

{"limit": 20,
"offset": 0,
"total": 1,
"results": [{"rune": {"id": "840000:1",
"number": 1,
"name": "ZZZZZFEHUZZZZZ",
"spaced_name": "Z•Z•Z•Z•Z•FEHU•Z•Z•Z•Z•Z"
},
"address": "bc1q7jd477wc5s88hsvenr0ddtatsw282hfjzg59wz",
"receiver_address": "bc1pgdrveee2v4ez95szaakw5gkd8eennv2dddf9rjdrlt6ch56lzrrsxgvazt",
"amount": "11000000000",
"operation": "etching",
"location": {"block_hash": "00000000000000000000c9787573a1f1775a2b56b403a2d0c7957e9a5bc754bb",
"block_height": 840000,
"tx_id": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e",
"tx_index": 1,
"vout": 100,
"output": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e:100",
"timestamp": 1713571767
}
}
]
}

Transaction activity

Retrieves a paginated list of rune activity for a transaction

path Parameters

tx_id

required

string (Transaction ID) ^[a-fA-F0-9]{64}$

Example: 8f46f0d4ef685e650727e6faf7e30f23b851a7709714ec774f7909b3fb5e604c

A transaction ID

query Parameters

offset	integer (Offset) >= 0 Result offset
limit	integer (Limit) [ 1 .. 60 ] Results per page

Responses

Response samples

200

Content type

application/json

{"limit": 20,
"offset": 0,
"total": 1,
"results": [{"rune": {"id": "840000:1",
"number": 1,
"name": "ZZZZZFEHUZZZZZ",
"spaced_name": "Z•Z•Z•Z•Z•FEHU•Z•Z•Z•Z•Z"
},
"address": "bc1q7jd477wc5s88hsvenr0ddtatsw282hfjzg59wz",
"receiver_address": "bc1pgdrveee2v4ez95szaakw5gkd8eennv2dddf9rjdrlt6ch56lzrrsxgvazt",
"amount": "11000000000",
"operation": "etching",
"location": {"block_hash": "00000000000000000000c9787573a1f1775a2b56b403a2d0c7957e9a5bc754bb",
"block_height": 840000,
"tx_id": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e",
"tx_index": 1,
"vout": 100,
"output": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e:100",
"timestamp": 1713571767
}
}
]
}

Block activity

Retrieves a paginated list of rune activity for a block

path Parameters

required

Block Height (string) or Block Hash (string)

query Parameters

offset	integer (Offset) >= 0 Result offset
limit	integer (Limit) [ 1 .. 60 ] Results per page

Responses

Response samples

200

Content type

application/json

{"limit": 20,
"offset": 0,
"total": 1,
"results": [{"rune": {"id": "840000:1",
"number": 1,
"name": "ZZZZZFEHUZZZZZ",
"spaced_name": "Z•Z•Z•Z•Z•FEHU•Z•Z•Z•Z•Z"
},
"address": "bc1q7jd477wc5s88hsvenr0ddtatsw282hfjzg59wz",
"receiver_address": "bc1pgdrveee2v4ez95szaakw5gkd8eennv2dddf9rjdrlt6ch56lzrrsxgvazt",
"amount": "11000000000",
"operation": "etching",
"location": {"block_hash": "00000000000000000000c9787573a1f1775a2b56b403a2d0c7957e9a5bc754bb",
"block_height": 840000,
"tx_id": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e",
"tx_index": 1,
"vout": 100,
"output": "2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e:100",
"timestamp": 1713571767
}
}
]
}

Balances

Rune balances

Rune holders

Retrieves a paginated list of holders for a Rune

path Parameters

required

Rune ID (string) or Rune number (string) or Rune name (string) or Rune name with spacers (string)

query Parameters

offset	integer (Offset) >= 0 Result offset
limit	integer (Limit) [ 1 .. 60 ] Results per page

Responses

Response samples

200

Content type

application/json

{"limit": 20,
"offset": 0,
"total": 1,
"results": [{"address": "bc1q7jd477wc5s88hsvenr0ddtatsw282hfjzg59wz",
"balance": "11000000000"
}
]
}

Rune holder balance

Retrieves holder balance for a specific Rune

path Parameters

required	Rune ID (string) or Rune number (string) or Rune name (string) or Rune name with spacers (string)
address required	string (Address) Example: bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5 Bitcoin address

Responses

Response samples

200
404

Content type

application/json

{"address": "bc1q7jd477wc5s88hsvenr0ddtatsw282hfjzg59wz",
"balance": "11000000000"
}

Address balances

Retrieves a paginated list of address balances

path Parameters

address

required

string (Address)

Example: bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5

Bitcoin address

query Parameters

offset	integer (Offset) >= 0 Result offset
limit	integer (Limit) [ 1 .. 60 ] Results per page

Responses

Response samples

200

Content type

application/json

{"limit": 20,
"offset": 0,
"total": 1,
"results": [{"rune": {"id": "840000:1",
"number": 1,
"name": "ZZZZZFEHUZZZZZ",
"spaced_name": "Z•Z•Z•Z•Z•FEHU•Z•Z•Z•Z•Z"
},
"address": "bc1q7jd477wc5s88hsvenr0ddtatsw282hfjzg59wz",
"balance": "11000000000"
}
]
}

Status

API status

API Status

Displays the status of the API

Responses

Response samples

200

Content type

application/json

{"server_version": "",
"status": "string",
"block_height": 0
}