기본 기능 - 보유 아이템 조회

보유 아이템 조회 기능을 이용하면 사용자 DOSI 계정에 있는 디지털 아이템을 확인할 수 있습니다.

연결 정보

개발 환경	DOSI SDK base URI
운영 환경	https://sdk-api.dosi.world

디지털 아이템 목록 조회

지정한 contract ID에 속한 디지털 아이템 목록을 조회합니다. 디지털 아이템이 사용자 DOSI 계정에 없어도 contract ID를 알면 조회할 수 있습니다.

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

v1.0.0 미만에서 제공하던 GET {DOSI SDK base URI}/v1/wallets/{walletAddress}/contracts/{contractId}/items는 지원 중단할 예정이므로, 대신 이 엔드포인트를 사용하세요.

Request

Response

Path

Name	Type	Description
walletAddress	string	사용자 DOSI 계정의 월렛 주소
contractId	string	조회할 디지털 아이템의 contract ID. DOSI SDK 사용 신청 후 받은 contract ID 또는 그 외 핀시아(Finschia)에 있는 contract ID를 입력할 수 있습니다.
itemType	string	조회할 디지털 아이템 타입. 16진수 8자리 디지털 아이템 타입 또는 *를 입력하세요. 특정 아이템 타입을 입력하면 지정한 아이템 타입에 속한 디지털 아이템만 조회합니다. *를 입력하면 지정한 contract ID 하위 모든 아이템 타입에 속한 디지털 아이템을 조회합니다.

Query

Name	Type	Description	Required
pageSize	number	한 페이지에 포함할 디지털 아이템 수 기본값: 10 최솟값 : 1 최댓값: 100
pageToken	string	페이지 시작 지점 토큰(이전 페이지 조회 응답의 nextPageToken). 입력하지 않으면 첫 번째 페이지를 가져옵니다.

Body

None

Headers

• Authorization: Basic <'DOSI 채널 ID:시크릿'을 Base64로 인코딩한 값>
• Content-Type: application/json

Request examples

특정 아이템 타입으로 조회

전체 디지털 아이템 조회

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	다음 페이지 시작 지점 토큰. 다음 페이지가 없으면 null입니다.
items	array	조회한 디지털 아이템 목록

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 {DOSI SDK base URI}/v1/wallets/{walletAddress}/contracts/{contractId}/item-types/{itemType}/items를 사용하세요.

지정한 contract ID에 속한 디지털 아이템 목록을 조회합니다. 디지털 아이템이 사용자 DOSI 계정에 없어도 contract ID를 알면 조회할 수 있습니다.

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

Request

Response

Path

Name	Type	Description
walletAddress	string	사용자 DOSI 계정의 월렛 주소
contractId	string	조회할 디지털 아이템의 contract ID. DOSI SDK 사용 신청 후 받은 contract ID 또는 그 외 핀시아(Finschia)에 있는 contract ID를 입력할 수 있습니다.

Query

Name	Type	Description	Required
itemType	string	디지털 아이템의 아이템 타입(16진수 8자리 코드). 지정하면 이 아이템 타입에 속한 디지털 아이템만 조회합니다.
limit	number	한 페이지에 포함할 디지털 아이템 수 기본값: 10 최솟값: 1 최댓값: 100
pageToken	string	페이지 시작 지점 토큰(이전 페이지 조회 응답의 nextPageToken). 입력하지 않으면 첫 번째 페이지를 가져옵니다.

Body

None

Headers

• Authorization: Basic <'DOSI 채널 ID:시크릿'을 Base64로 인코딩한 값>
• 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	다음 페이지 시작 지점 토큰. 다음 페이지가 없으면 null입니다.
items	array	조회한 디지털 아이템 목록

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\"}"
    },
    ...
  ]
}