NFTs

Endpoints related to Spores Protocol

Get Clusters

Included in: Basic, Pro

GET {INDEXER_API}/spore/clusters

Returns ordered list of Spore's Clusters with detailed information about them.

Sample query:

$ curl --location '{INDEXER_API}/spore/clusters?limit=10&offset=0&name=test' \
--header 'x-api-key: {YOUR X-API-KEY}'

Query Parameters

Name	Type	Description
limit	uint	limit >= 0
offset	uint	offset >= 0
name	string	search text

200: OK

{
    "data": [
        {
            "cluster_id": "154c0c6e742a289c15f62d12cc59cc7ab3671706facfc88c56048ea6496f0457",
            "name": "___test____bbb",
            "description": "{\"description\":\"Nervape, multi-chain composable digital objects built on Bitcoin.\",\"dob\":{\"ver\":0,\"decoder\":{\"type\":\"code_hash\",\"hash\":\"0xb82abd59ade361a014f0abb692f71b0feb880693c3ccb95b9137b73551d872ce\"},\"pattern\":\"830900004400000087000000370500004206000085060000c2060000050700004807000089070000c6070000060800004408000081080000c00800000209000043090000430000000c0000001900000009000000707265762e747970652a00000008000000220000000c0000000d0000000100000000110000000800000005000000696d616765b00400000c0000001700000007000000707265762e62679904000008000000910400000c0000000d0000000100000000800400003c0000008a000000d80000002601000074010000c2010000100200005e020000ac020000fa0200004803000096030000e4030000320400004a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569304a00000062746366733a2f2f6264303863363664636166366165316461656664646166393032386132353539653365396363353866383836336561303761393930613533313037383861653569300b0100000c0000001c0000000c000000707265762e6267636f6c6f72ef00000008000000e70000000c0000000d0000000100000000d60000003c00000047000000520000005d00000068000000730000007e00000089000000940000009f000000aa000000b5000000c0000000cb00000007000000234646453345420700000023464642444643070000002344344330464607000000234146453746390700000023414246344430070000002345384541424507000000234643463841430700000023454142433842070000002346464438383007000000234646453243370700000023464642353744070000002346464144414207000000234530453145320700000023413341374141430000000c0000001a0000000a0000004261636b67726f756e642900000008000000210000000c0000000d00000001030000000000000000000000ff000000000000003d0000000c0000001400000004000000537569742900000008000000210000000c0000000d00000001030000000000000000000000ff00000000000000430000000c0000001a0000000a000000557070657220626f64792900000008000000210000000c0000000d00000001030000000000000000000000ff00000000000000430000000c0000001a0000000a0000004c6f77657220626f64792900000008000000210000000c0000000d00000001030000000000000000000000ff00000000000000410000000c000000180000000800000048656164776561722900000008000000210000000c0000000d00000001030000000000000000000000ff000000000000003d0000000c00000014000000040000004d61736b2900000008000000210000000c0000000d00000001030000000000000000000000ff00000000000000400000000c0000001700000007000000457965776561722900000008000000210000000c0000000d00000001030000000000000000000000ff000000000000003e0000000c00000015000000050000004d6f7574682900000008000000210000000c0000000d00000001030000000000000000000000ff000000000000003d0000000c0000001400000004000000456172732900000008000000210000000c0000000d00000001030000000000000000000000ff000000000000003f0000000c0000001600000006000000546174746f6f2900000008000000210000000c0000000d00000001030000000000000000000000ff00000000000000420000000c00000019000000090000004163636573736f72792900000008000000210000000c0000000d00000001030000000000000000000000ff00000000000000410000000c000000180000000800000048616e6468656c642900000008000000210000000c0000000d00000001030000000000000000000000ff00000000000000400000000c00000017000000070000005370656369616c2900000008000000210000000c0000000d00000001030000000000000000000000ff00000000000000\",\"dna_bytes\":16}}"
        },
        ...
    ],
    "error": null
}

429: Too Many Requests

"Rate limit exceeded. Try again later"

401: Authorization Required

"Missing or invalid x-api-key"

401: Invalid API Key

"Invalid x-api-key"

Get NFTs

Included in: Basic, Pro

GET {INDEXER_API}/spore/list

Returns ordered list of NFTs with detailed information about them.

Sample query:

$ curl --location '{INDEXER_API}/spore/list?cluster_id=&limit=10&offset=0' \
--header 'x-api-key: {YOUR X-API-KEY}'

Query Parameters

Name	Type	Description
limit	uint	limit >= 0
offset	uint	offset >= 0
cluster_id	string	id of cluster

200: OK

[
    {
        "spore_id": "7d7c27558054f140260392bddae15e9bc73ccdb6cb6e0e72d16f7831c10e092e",
        "content_type": "text/plain",
        "content": "content",
        "cluster_id": null,
        "mint_tx_hash": "86e722258c098a01fb68a443e0059f592948063c104c5e3ca59b68ba7a278cb5"
    },
    ...
]

429: Too Many Requests

"Rate limit exceeded. Try again later"

401: Authorization Required

"Missing or invalid x-api-key"

401: Invalid API Key

"Invalid x-api-key"

Get Live Cells

Included in: Basic, Pro

GET {INDEXER_API}/spore/outputs

Returns ordered live cells.

Sample query:

$ curl --location '{INDEXER_API}/spore/outputs?limit=10&offset=0&address=ckt1qzda0cr08m85hc8jlnfp3zer7xulejywt49kt2rr0vthywaa50xwsq27yr8phfpt7npd9zns248746vm6utwjjg9smmmu' \
--header 'x-api-key: {YOUR X-API-KEY}'

Query Parameters

Name	Type	Description
limit	uint	limit >= 0
offset	uint	offset >= 0
address	string	CKB wallet address

200: OK

[
  {
        "spore_id": "d432a4350481087b86552750f617c16735712846e4e5e19d1ba0cc9b8be0f123",
        "output_index": 0,
        "tx_hash": "704882be85fb024dad22699d0aaf6ff9444fc1e4706c47c240b35a0b05a47d50",
        "capacity": 18299999133,
        "data": "38000000100000002c0000003800000018000000746578742f706c61696e3b696d6d6f7274616c3d7472756508000000696d6d6f7274616c",
        "lock_script": {
            "code_hash": "9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8",
            "args": "88249f1791b9b3f1248c36abc422a7d5b35537e7",
            "hash_type": "type",
            "address": "ckb1qzda0cr08m85hc8jlnfp3zer7xulejywt49kt2rr0vthywaa50xwsqvgyj030ydek0cjfrpk40zz9f74kd2n0ecmfq2nx",
            "script_hash": "a3a999800628a0eb74c9cb76e2d29cc8902fb86fc63bd3d53327026a718f4ac4"
        },
        "type_script": {
            "code_hash": "4a4dce1df3dffff7f8b2cd7dff7303df3b6150c9788cb75dcf6747247132b9f5",
            "args": "d432a4350481087b86552750f617c16735712846e4e5e19d1ba0cc9b8be0f123",
            "hash_type": "data1",
            "script_hash": "204e404bcf8c12a27bb7e59aba34a31a165006349ac7552c310c99a9f4cc21f0"
        }
    },
    ...
]

429: Too Many Requests

"Rate limit exceeded. Try again later"

401: Authorization Required

"Missing or invalid x-api-key"

401: Invalid API Key

"Invalid x-api-key"