Get TRC1155 Inventory
1. Overview & Typical Use
Returns the token inventory list for a specified TRC1155 contract, including holder count, name, description, and image for each tokenId.
- Typical use: TRC1155 NFT collection browsing, inventory display.
- When not to use: to query a specific tokenId’s holder details use “Get TRC1155 tokenId Holdings”; for TRC721 inventory use “Get TRC721 Inventory”.
contractis a required parameter; omitting it returns a missing-parameter error.limitmax is 50;start + limit ≤ 10000.
2. Endpoint & Authentication
GET /api/trc1155/inventory
For Base URL and authentication, see Common Network & Authentication.
3. Request
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contract | string | Yes | — | TRC1155 contract address |
tokenId | string | No | — | Token ID within the TRC1155 contract |
start | integer | No | 0 | Start offset; start + limit ≤ 10000 |
limit | integer | No | 20 | Page size, max 50 |
sort | string | No | — | Sort: -tokenId (descending), tokenId (ascending) |
4. Response
Fields
Top-level
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
total | integer | Required | Total record count | — |
rangeTotal | integer | Required | Total count within the filter range | — |
page_size | integer | Required | Number of records returned on the current page | — |
code | integer | Required | Response status code; 200 = success | — |
data | array | Required | Inventory record array; see below | — |
data[] elements
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
token_id | string | Required | Token ID | — |
holders_count | integer | Required | Number of holders | — |
token_name | string | Required | Token name | — |
token_description | string | Optional | Token description | — |
token_image | string | Optional | Token image URL (external link) | — |
token_imageInnerUrl | string | Optional | Token image URL (site-cached) | — |
token_url | string | Optional | Token metadata URL | — |
latest_transfer_timestamp | integer | Required | Most recent transfer time | Millisecond timestamp ms |
5. Errors
For HTTP status codes, see Common Errors. Notes for this endpoint:
contractis required: omitting it returns{"message":"some parameters are missing"}.- Empty result is not an error: no matches returns
200+data: [], which is a normal response.
Last updated on: