Basics - Item fetching

Using the item fetching feature, you can check digital items in the user’s DOSI account.

Connection info

Development environment	DOSI SDK base URI
Production	https://sdk-api.dosi.world

Get digital item list

Get the list of digital items with the given contract ID. You can still get digital items that aren't in the user’s DOSI account if you have the contract ID.

GET {DOSI SDK base URI}/v1/wallets/{walletAddress}/item-contracts/{contractId}/item-types/{itemType}/items

As GET {DOSI SDK base URI}/v1/wallets/{walletAddress}/contracts/{contractId}/items supported in versions prior to v1.0.0 will be deprecated, use this endpoint instead.

Request

Response

Path

Name	Type	Description
walletAddress	string	Address of the user's wallet
contractId	string	Contract ID of the digital items. Enter the contract ID received after applying for DOSI SDK or any contract ID existing on Finschia.
itemType	string	Digital item type for retrieval. Provide an 8-digit hexadecimal digital item type or type *. When you specify an item type, it gets digital items with the given item type only. When you type in *, it gets digital items with all item types under the given contract ID.

Query

Name	Type	Description	Required
pageSize	number	Number of digital items per page Default: 10 Minimum: 1 Maximum: 100
pageToken	string	Token for the start of the page (that is, nextPageToken in the response for the previous page). Starts from the first page if not provided.

Body

None

Headers

• Authorization: Basic <Base64-encoded 'DOSI channel ID:secret'>
• Content-Type: application/json

Request examples

Get digital items with a specific item type

Get all digital items

curl --location --request GET 'https://sdk-api.dosi.world/v1/wallets/link1....xvb/item-contracts/abcdabcd/item-types/aaaaaaaa/items' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: application/json'

Name	Type	Description	Included
nextPageToken	string	Token for the start of the next page. Null if there is no next page.
items	array	List of digital items

Response status code

200 OK

Response headers

None

Related errors

None

Response examples

{
  "nextPageToken": "xxxxxxxx",
  "items":[
    {
      "tokenType":"abcdabcd",
      "tokenIndex":"00001010",
      "name":"token A",
      "meta":"{\"PropertyA\":\"ValueA\", \"PropertyB\":\"ValueB\"}"
    },
    {
      "tokenType":"abcdabcd",
      "tokenIndex":"00001011",
      "name":"token B",
      "meta":"{\"PropertyA\":\"ValueA\", \"PropertyB\":\"ValueB\"}"
    },
    ...
  ]
}

Get digital item list

As this endpoint will be deprecated, use GET {DOSI SDK base URI}/v1/wallets/{walletAddress}/contracts/{contractId}/item-types/{itemType}/items instead.

Gets the list of digital items in the user's DOSI account.

GET {DOSI SDK base URI}/v1/wallets/{walletAddress}/contracts/{contractId}/items

Request

Response

Path

Name	Type	Description
walletAddress	string	Wallet address of the user's DOSI account
contractId	string	Contract ID received after applying for DOSI SDK.

Query

Name	Type	Description	Required
itemType	string	Item type of the digital item. Represented by an 8-digit hexadecimal code. When specified, it searches for digital items belonging to the given item type.
limit	number	Number of digital items per page Default: 10 Minimum: 1 Maximum: 100
pageToken	string	Token for the start of the page (that is, nextPageToken in the response for the previous page). Starts from the first page if not provided.

Body

None

Headers

• Authorization: Basic <Base64-encoded 'DOSI channel ID:secret'>
• Content-Type: application/json

Request examples

curl

curl --location --request GET 'https://sdk-api.dosi.world/v1/wallets/link1....xvb/contracts/abcdabcd/items' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: application/json'

Name	Type	Description	Included
nextPageToken	string	Token for the start of the next page. Null if there is no next page.
items	array	List of digital items

Response status code

200 OK

Response headers

None

Related errors

None

Response examples

{
  "nextPageToken": "xxxxxxxx",
  "items":[
    {
      "tokenType":"abcdabcd",
      "tokenIndex":"0000100e",
      "name":"token A",
      "meta":"{\"PropertyA\":\"ValueA\", \"PropertyB\":\"ValueB\"}"
    },
    {
      "tokenType":"abcdabcd",
      "tokenIndex":"0000100f",
      "name":"token B",
      "meta":"{\"PropertyA\":\"ValueA\", \"PropertyB\":\"ValueB\"}"
    },
    ...
  ]
}