Items
An Item defines a template for minted tokens representing individual physical assets.
Get One Item
Retrieve one item by its unique identifier.
Request
GET /items/:itemIdHeaders
| Header | Description | Required |
|---|---|---|
x-iyk-api-key | API key for user | Yes |
Response
The response is an object representing the item.
Item Properties
| Field | Type | Description |
|---|---|---|
id | string | The unique identifier of the item. |
name | string | The name of the item. |
description | string | The description of the item. |
imageUrl | string | The URL of the item's image. |
contract | Contract | The item's contract. |
media | Media[] | The list of the item's media |
featuredMedia | Media | The item's featured media. This field is equivalent to the first element of the media array. |
attributes | Attribute[] | The list of all possible attributes. |
variants | Variant[] | The item's variants. |
Contract Object
| Field | Type | Description |
|---|---|---|
name | string | The name of the contract |
symbol | string | The symbol of the contract |
address | string | The contract address |
chainId | number | The chain ID of the contract |
Media Object
| Field | Type | Description |
|---|---|---|
mimeType | string | The media's MIME type |
url | string | The URL of the media |
Attribute Object
| Field | Type | Description |
|---|---|---|
name | string | The name of the attribute |
values | string[] | The list of possible values for the attribute |
Variant Object
| Field | Type | Description |
|---|---|---|
id | string | The unique identifier of the variant |
attributes | VariantAttribute[] | The list of attributes for the variant |
Variant Attribute Object
| Field | Type | Description |
|---|---|---|
name | string | The name of the attribute |
value | string | The value of the attribute |
Get Items
Retrieve the list of items associated with your team.
Request
GET /itemsHeaders
| Header | Description | Required |
|---|---|---|
x-iyk-api-key | API key for user | Yes |
Query Parameters
| Parameter | Description | Required |
|---|---|---|
contractAddress | Contract address of the token | No |
chainId | Chain ID of the network where the token resides | Only if contractAddress is present |
Response
The response is an array of objects, each representing an item.
Go to the Get One Item section to see the properties of an item.
Get Item's Chips
Retrieve the list of chips associated with an item.
Request
GET /items/:itemId/chipsHeaders
| Header | Description | Required |
|---|---|---|
x-iyk-api-key | API key for user | Yes |
Response
The response is an array of objects, each representing a chip.
Response Object Properties
| Field | Type | Description |
|---|---|---|
uid | string | A unique identifier for the chip. |
linkedToken | TokenRef | Details of the linked token |
TokenRef Properties
| Field | Type | Description |
|---|---|---|
tokenId | string | The token ID |
chainId | number | The chain ID of the contract |
contractAddress | string | The token contract address |