Query inscriptions on Bitcoin by user address

Description

  • Method: HTTPS GET

  • ncoding: UTF-8

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

  • Description: Query inscriptions on Bitcoin by user address

Request Header

Parameter
Required
Type
Description

Content-Type

Y

String

application/json

AccessKey

Y

String

1bdb01c947c54919b64d1fc6794atest

Request Parameters

Parameter
Required
Type
Description

address

Y

String

User's address

inscription_collection

N

Array

Collection's symbol

page

Y

Integer

Page number

page_size

Y

Integer

Page size(minimum:1 ,maximum:100)

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

Response Content

Parameter
Required
Type
Description

list

Y

List

Detail info list

pagination

Y

Integer

Page info

Pagination Content

Parameter
Required
Type
Description

current

Y

Integer

Current page number

page_size

Y

Integer

Current page size

total

Y

Integer

Total number

count_page

Y

Integer

Total page number

HolderItem Content

Parameter
Required
Type
Description

inscription_id

Y

String

NFT's id

inscription_number

Y

Long

NFT's number

holder_address

Y

String

The wallet address of the holder of the NFT

block_height

Y

Long

The block number when the amount or owner changed

amount

Y

Long

NFT's amount

inscription_collection

Y

String

Collection's symbol

collection_name

Y

String

Collection's name

item_metadata

Y

ItemMetadata

NFT's metadata

ItemMetadata 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

inscription_name

N

String

NFT's name

collection_name

N

String

Collection'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

NFT'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/user/nft/btc/wallet_item_list?address=bc1pdkdhdftp9slhxx20pcpzp537pmaky2dl6ar6mxyx3t5qm6wpeu3qm2q4pz&page=1&page_size=100"

Successful Response Sample

 {
    "success": true,
    "data": {
        "list": [
             {
                "inscription_id": "f66d8c1145a9faf6c7a672d60ce0043aeee432ff7e938d60e48316a9fa3f57b1i0",
                "inscription_number": 123497,
                "holder_address": "bc1pdkdhdftp9slhxx20pcpzp537pmaky2dl6ar6mxyx3t5qm6wpeu3qm2q4pz",
                "block_height": 782961,
                "amount": 1,
                "item_metadata": {
                    "creation_transaction": "f66d8c1145a9faf6c7a672d60ce0043aeee432ff7e938d60e48316a9fa3f57b1",
                    "creation_block_height": 776873,
                    "creation_block_time": 1676566840,
                    "creation_fee": 1397,
                    "location": "d7c1b94ae930cefb552b7e987525e069701eebabbcaaf2397c12b5038e47b14f:0:0",
                    "location_block_height": 782961,
                    "location_block_time": 1680053315,
                    "location_block_hash": "00000000000000000000888da44184be2b3cdceb0e33f8aaa01f241a2798b47e",
                    "output": "d7c1b94ae930cefb552b7e987525e069701eebabbcaaf2397c12b5038e47b14f:0",
                    "inscription_collection": "0n1y_0ne_pixe1_ri0t",
                    "collection_name": "0n1y 0ne pi×e1 ri0t",
                    "inscription_name": "b1ue pixe1 ri0t",
                    "inscription_type": "image/gif",
                    "blockin_image": "https://www.blockin.ai/image/btc/nft/f66d8c1145a9faf6c7a672d60ce0043aeee432ff7e938d60e48316a9fa3f57b1i0.gif",
                    "image": "https://ord-mirror.magiceden.dev/preview/f66d8c1145a9faf6c7a672d60ce0043aeee432ff7e938d60e48316a9fa3f57b1i0",
                    "sat_number": 1357377866639386,
                    "sat_name": "eftdcbymurv",
                    "sat_rarity": "common",
                    "sat_block_height": 332951,
                    "sat_block_time": 1417763199,
                    "file_type": "IMAGE",
                    "file_size": 194,
                    "attributes": [
                        {
                            "value": "b1ue",
                            "trait_type": "C010r"
                        }
                    ],
                    "last_metadata_sync": 1689653480
                },
                "inscription_collection": "0n1y_0ne_pixe1_ri0t",
                "collection_name": "0n1y 0ne pi×e1 ri0t"
            }
        ],
        "pagination": {
            "current": 1,
            "page_size": 30,
            "total": 6,
            "count_page": 1
        }
    },
    "error_code": null,
    "error_msg": null
}

Failed Response Sample

{
    "success": false,
    "data": null,
    "error_code": "INVALID_PARAM",
    "error_msg": "page_size minimum:1 ,maximum:100"
}

Last updated