Query inscriptions metadata on Bitcoin by inscriptions id

Description

  • Method: HTTPS GET

  • Encoding: UTF-8

  • Path: https://api.blockin.ai/v2/nft/btc/get_nft_metadata

  • Description: Get metadata for an NFT on the Bitcoin

Request Header

Parameter
Required
Type
Description

Content-Type

Y

String

application/json

AccessKey

Y

String

1bdb01c947c54919b64d1fc6794atest

Request Parameter

Parameter
Required
Type
Description

inscription_id

Y

String

Inscription id

Response

Public Response

Parameter
Required
Type
Description

success

Y

Boolean

Success Boolean

data

N

Object

Response object

error_code

N

String

Error code

error_msg

N

String

Error message

Metadata Content

Parameter
Required
Type
Description

creation_transaction

N

String

Inscription hash

creation_block_height

N

Long

Inscription block height

creation_block_time

N

Long

Inscription block time

creation_fee

N

Long

Inscription fee

location

N

String

Location

location_block_height

N

Long

Location block height

location_block_time

N

Long

Location block time

location_block_hash

N

String

Location hash

output

N

String

Output

inscription_collection

N

String

Collection's symbol

collection_name

N

String

Collection's name

inscription_name

N

String

NFT's name

inscription_type

N

String

Inscription type

blockin_image

N

String

NFT's image url(Blockin.ai)

image

N

String

NFT's image url

sat_number

N

Long

Sat number

sat_name

N

String

Sat name

sat_rarity

N

String

Sat rarity

sat_block_height

N

Long

Sat block height

sat_block_time

N

Long

Sat block time

file_type

N

String

TXT,HTML,IMAGE,AUDIO,VIDEO,OTHER

file_size

N

Long

File size

attributes

N

list

NFT's arrtributes

Attribute Content

Parameter
Required
Type
Description

trait_type

Y

String

Item's trait type

value

Y

String

Trait value

Request Sample

curl -H "Content-Type:application/json" -H "AccessKey:1bdb01c947c54919b64d1fc6794atest" -X GET "https://api.blockin.ai/v2/nft/btc/get_nft_metadata?inscription_id=f66d8c1145a9faf6c7a672d60ce0043aeee432ff7e938d60e48316a9fa3f57b1"

Successful Response Sample

{
    "success": true,
    "data": {
        "creation_transaction": "b8ca7aab23f9289178c6f47e40b102d066280ee44af19e3420ec1157ea30d7f7",
        "creation_block_height": 784175,
        "creation_block_time": 1680768167,
        "creation_fee": 331,
        "location": "c13b1ecf02189fbef6ee627c706d2b77cbaf8816ce5d53063a73805ef9b3a693:2:0",
        "location_block_height": 791788,
        "location_block_time": 1685277024,
        "location_block_hash": "0000000000000000000061594976dbff18a89e5c9351e931538b7e434c565375",
        "output": "c13b1ecf02189fbef6ee627c706d2b77cbaf8816ce5d53063a73805ef9b3a693:2",
        "inscription_collection": "btc-artifacts",
        "collection_name": "BTC Artifacts",
        "inscription_name": "BTC TNT #8750",
        "inscription_type": "image/png",
        "blockin_image": "https://www.blockin.ai/image/btc/nft/b8ca7aab23f9289178c6f47e40b102d066280ee44af19e3420ec1157ea30d7f7i0.png",
        "image": "https://ord-mirror.magiceden.dev/preview/b8ca7aab23f9289178c6f47e40b102d066280ee44af19e3420ec1157ea30d7f7i0",
        "sat_number": 1789219271417665,
        "sat_name": "befesbdhazg",
        "sat_rarity": "common",
        "sat_block_height": 591375,
        "sat_block_time": 1566562123,
        "file_type": "IMAGE",
        "file_size": 194,
        "attributes": [
            {
                "value": "TNT",
                "trait_type": "type"
            }
        ],
        "last_metadata_sync": 1689665745
    },
    "error_code": null,
    "error_msg": null
}

Failed Response Sample

{
    "success": false,
    "data": null,
    "error_code": "INVALID_PARAM",
    "error_msg": "inscription id can't be empty"
}

Last updated