XRP Ledger Apex is back in Amsterdam

Register Now
Documentation
/
References
/
HTTP / WebSocket APIs
/
Public API Methods
/
Clio Server
/
nfts_by_issuer
Last updated
Edit

nfts_by_issuer

[Source]

nfts_by_issuer returns a list of NFTokens that are issued by the specified account. It can optionally filter by taxon. New in: Clio v2.1.0

Request Format

An example of the request format:

{
  "method": "nfts_by_issuer",
  "issuer": "rLaBCoaMQqXzHDmiGs2Qv2JA2bg3Yvzxyt"
}

Try it! >

The request contains the following parameters:

FieldTypeDescription
issuerStringA unique identifier for the account, most commonly the account's address.
markerMarker(Optional) Value from a previous paginated response. Resume retrieving data where that response left off. This value is NOT stable if there is a change in the server's range of available ledgers; meaning if you are querying the “validated” ledger it is possible that new NFTs are created during your paging.
nft_taxonInteger(Optional) Use to filter NFTs issued by this issuer that have this taxon.
ledger_hashString(Optional) Use to look for NFTs issued up to the provided ledger. If not provided, the server uses the current ledger.
ledger_indexString or Integer(Optional) Use to look for NFTs issued up to the provided ledger. If not provided, the server uses the current ledger.
limitInteger(Optional) Limit the number of NFTs to retrieve. The server is not required to honor this value.

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

Response Format

An example of a successful response:

{
   "result": {
      "issuer": "rfXeQv31yWMrhhPxMHZRzQqhw5mQrcuici",
      "limit": 50,
      "ledger_index": 1534,
      "nfts": [
         {
            "nft_id": "00080000479C76BC5174816A938ABF667E67D851140BFE03F068FA97000005FB",
            "ledger_index": 1533,
            "owner": "rfXeQv31yWMrhhPxMHZRzQqhw5mQrcuici",
            "is_burned": false,
            "uri": "",
            "flags": 8,
            "transfer_fee": 0,
            "issuer": "rfXeQv31yWMrhhPxMHZRzQqhw5mQrcuici",
            "nft_taxon": 1,
            "nft_serial": 1531
         }
      ],
      "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"
      }
   ]
}

The response follows the standard format, with a successful result containing the following fields:

FieldTypeDescription
issuerStringIssuer's account ID.
nftsArray<Object>A list of NFTs issued by the account. The order of the NFTs is not associated with the date the NFTs were minted.
markerMarker(Optional) Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. If this field is not returned, you know that you no longer need to make calls to this API.
limitIntegerThe limit, as specified in the request.
nft_taxonInteger(Optional) The nft_taxon as specified in the request.

The format of each NFT in the nfts array is the same as the response to an nft_info request.

For definitions of the fields returned in the tx object, see Transaction Metadata.

Note:You might get back a response where the nfts field is empty but a marker is defined. You need to repeatedly request with the new markers until you receive a response that no longer has a marker. This can happen if you specify a specific ledger and there are tokens that were minted by the account after the specified ledger.