Last updated
Edit

account_nfts

[ソース]

account_nftsメソッドは、指定したアカウントのNFTokenオブジェクトの一覧を返します。

(NonFungibleTokensV1_1 amendmentにより追加されました。)

リクエストのフォーマット

リクエストのフォーマットの例

注記

このメソッドにはコマンドライン構文がありません。代わりにjsonメソッドを使って、コマンドラインからこのメソッドにアクセスすることができます。

  1. WebSocket
  2. JSON-RPC
{
  "command": "account_nfts",
  "account": "rsuHaTvJh1bDmDoxX9QcKP7HEBSBt4XsHx",
  "ledger_index": "validated"
}

試してみる >

リクエストには以下のパラメーターが含まれます。

フィールド説明
account文字列アカウントの一意の識別子で、通常はアカウントのアドレスです。このリクエストは、このアカウントが所有するNFTのリストを返します。
ledger_hash文字列(省略可) 使用するレジャーのバージョンを示す20バイトの16進数の文字列。(レジャーの指定を参照)。
ledger_index文字列 または 数値(省略可) 使用するレジャーのレジャーインデックス、またはレジャーを自動的に選択するためのショートカット文字列。(レジャーの指定を参照)。
limit整数(省略可) 取得するトークンのページの数を制限します。各ページには最大32個のNFTを含めることができます。limitの値は20以上・400以下で指定します。この範囲外の正の値は、最も近い有効な値に置き換えられます。デフォルトは100です。
markerマーカー(省略可) 以前のページ分割されたレスポンスの値。そのレスポンスが終了したところからデータの取得を再開します。

レスポンスのフォーマット

処理が成功したレスポンスの例:

  1. WebSocket
  2. JSON-RPC
{
  "result": {
    "account": "rsuHaTvJh1bDmDoxX9QcKP7HEBSBt4XsHx",
    "account_nfts": [
      {
        "Flags": 1,
        "Issuer": "rGJUF4PvVkMNxG6Bg6AKg3avhrtQyAffcm",
        "NFTokenID": "00010000A7CAD27B688D14BA1A9FA5366554D6ADCF9CE0875B974D9F00000004",
        "NFTokenTaxon": 0,
        "URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469",
        "nft_serial": 4
      },
      {
        "Flags": 1,
        "Issuer": "rGJUF4PvVkMNxG6Bg6AKg3avhrtQyAffcm",
        "NFTokenID": "00010000A7CAD27B688D14BA1A9FA5366554D6ADCF9CE087727D1EA000000005",
        "NFTokenTaxon": 0,
        "URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469",
        "nft_serial": 5
      }
    ],
    "ledger_hash": "7971093E67341E325251268A5B7CD665EF450B126F67DF8384D964DF834961E8",
    "ledger_index": 2380540,
    "validated": true
  },
  "status": "success",
  "type": "response"
}

このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。

Field説明
account文字列NFTの一覧を所有するアカウント
account_nfts配列アカウントが所有するNFTのリストで、NFTオブジェクト(下記参照)としてフォーマットされます。
ledger_hash文字列(省略可能) このレスポンスの生成に使用されたレジャーの識別ハッシュ。
ledger_index数値 - レジャーインデックス(省略可能) このレスポンスの生成に使用されたレジャーのインデックス。
ledger_current_index数値 - レジャーインデックス(省略可能) このレスポンスの生成に使用された、現在進行中のレジャーバージョンのレジャーインデックス。
validatedブール値このレスポンスに含まれ、trueに設定されている場合、このレスポンスの情報は検証済みのレジャーバージョンから取得したものです。そうでない場合、情報は変更される可能性があります。

NFTオブジェクト

account_nfts配列の各オブジェクトは1つのNFTokenを表し、以下のフィールドを保持しています

Field説明
Flags数値このNFTokenで有効なブール値フラグのビットマップ。指定できる値については、NFTokenフラグをご覧ください。
Issuer文字列 - アドレスこのNFTokenを発行したアカウント。
NFTokenID文字列このNFTokenの一意の識別子(16進数)。
NFTokenTaxon数値このトークンのtaxonの非乱数化した値。同じtaxonを持つ複数のトークンは、一つの限定されたシリーズのインスタンスを表すかもしれません。
URIStringこのNFTokenに関連付けられた16進数のURI データ。
nft_serial文字列このNFTokenのトークンシーケンス番号。

考えられるエラー

  • いずれかの汎用エラータイプ
  • invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
  • actNotFound - リクエストのaccountフィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
  • lgrNotFound - ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。