nft_info

[Source]

The nft_info command asks the Clio server for information about the NFT being queried. New in: Clio v1.1.0

Request Format

An example of the request format:

{
  "id": 1,
  "command": "nft_info",
  "nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}

{
    "method": "nft_info",
    "params": [
      {
          "nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
      }
    ]
}

The request contains the following parameters:

Field Type Description
nft_id String A unique identifier for the non-fungible token (NFT).
ledger_hash String (Optional) A 20-byte hex string for the ledger version to use. (See Specifying Ledgers)
ledger_index String or Unsigned Integer (Optional) The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically. Do not specify the ledger_index as closed or current; doing so forwards the request to the P2P rippled server and the nft_info API is not available on rippled. (See Specifying Ledgers)

If you do not specify a ledger version, Clio uses the latest validated ledger.

Response Format

An example of a successful response:

{
  "id": 1,
  "result": {
    "nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000",
    "ledger_index": 270,
    "owner": "rG9gdNygQ6npA9JvDFWBoeXbiUcTYJnEnk",
    "is_burned": true,
    "flags": 8,
    "transfer_fee": 0,
    "issuer": "rHVokeuSnjPjz718qdb47bGXBBHNMP3KDQ",
    "nft_taxon": 0,
    "nft_sequence": 0,
    "validated": true
  },
  "status": "success",
  "type": "response",
  "warnings": [
    {
      "id": 2001,
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
    },
    {
      "id": 2002,
      "message": "This server may be out of date"
    }
  ]
}

{
  "result": {
    "nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000",
    "ledger_index": 269,
    "owner": "rG9gdNygQ6npA9JvDFWBoeXbiUcTYJnEnk",
    "is_burned": false,
    "flags": 8,
    "transfer_fee": 0,
    "issuer": "rHVokeuSnjPjz718qdb47bGXBBHNMP3KDQ",
    "nft_taxon": 0,
    "nft_sequence": 0,
    "uri": "https://xrpl.org",
    "validated": true,
    "status": "success"
  },
  "warnings": [
    {
      "id": 2001,
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
    },
    {
      "id": 2002,
      "message": "This server may be out of date"
    }
  ]
}

The response follows the standard format, with a successful result containing an nft_info response object with some arrangement of the following fields:

Field Type Description
nft_id String A unique identifier for the non-fungible token (NFT).
ledger_index Integer The ledger index of the most recent ledger version where the state of this NFT was modified, as in the NFT was minted (created), changed ownership (traded), or burned (destroyed). The information returned contains whatever happened most recently compared to the requested ledger.
owner String The account ID of this NFT's owner at this ledger index.
is_burned Boolean Returns true if the NFT is burned at this ledger, or false otherwise.
flags Integer The flag set of this NFT.
transfer_fee Integer The transfer fee of this NFT. See NFTokenMint Fields for more information on transfer fees.
issuer String The account ID which denotes the issuer of this NFT.
nft_taxon Integer The NFT’s taxon.
nft_sequence Integer The NFT’s sequence number.
uri String or null (Omitted if the NFT is burned at this ledger.). This field is null if the NFT is not burned at this ledger but does not have a URI. If the NFT is not burned at this ledger and it does have a URI, this field is a string containing the decoded URI of the NFT. NOTE: If you need to retrieve the URI of a burnt token, re-request nft_info for this token, specifying the ledger_index as the one previous to the index where this token was burned ({ledger-index-where-token-was-burned} - 1).

Possible Errors