Skip to Content
APITokensGet TRC1155 Inventory

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”.
  • contract is a required parameter; omitting it returns a missing-parameter error.
  • limit max is 50; start + limit ≤ 10000.

2. Endpoint & Authentication

GET /api/trc1155/inventory

For Base URL and authentication, see Common Network & Authentication.

3. Request

ParameterTypeRequiredDefaultDescription
contractstringYes—TRC1155 contract address
tokenIdstringNo—Token ID within the TRC1155 contract
startintegerNo0Start offset; start + limit ≤ 10000
limitintegerNo20Page size, max 50
sortstringNo—Sort: -tokenId (descending), tokenId (ascending)

4. Response

Top-level

FieldTypeRequiredDescriptionUnit/Precision
totalintegerRequiredTotal record count—
rangeTotalintegerRequiredTotal count within the filter range—
page_sizeintegerRequiredNumber of records returned on the current page—
codeintegerRequiredResponse status code; 200 = success—
dataarrayRequiredInventory record array; see below—

data[] elements

FieldTypeRequiredDescriptionUnit/Precision
token_idstringRequiredToken ID—
holders_countintegerRequiredNumber of holders—
token_namestringRequiredToken name—
token_descriptionstringOptionalToken description—
token_imagestringOptionalToken image URL (external link)—
token_imageInnerUrlstringOptionalToken image URL (site-cached)—
token_urlstringOptionalToken metadata URL—
latest_transfer_timestampintegerRequiredMost recent transfer timeMillisecond timestamp ms

5. Errors

For HTTP status codes, see Common Errors. Notes for this endpoint:

  • contract is 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: