@nextrope/xrpl/src/models/methods/accountNFTs.ts

A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser

import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'

/**
 * The `account_nfts` method retrieves all of the NFTs currently owned by the
 * specified account.
 *
 * @category Requests
 */
export interface AccountNFTsRequest extends BaseRequest, LookupByLedgerRequest {
  command: 'account_nfts'
  /**
   * The unique identifier of an account, typically the account's address. The
   * request returns NFTs owned by this account.
   */
  account: string
  /**
   * Limit the number of NFTokens to retrieve.
   */
  limit?: number
  /**
   * Value from a previous paginated response. Resume retrieving data where
   * that response left off.
   */
  marker?: unknown
}

/**
 * One NFToken that might be returned from an {@link AccountNFTsRequest}.
 *
 * @category Responses
 */
export interface AccountNFToken {
  Flags: number
  Issuer: string
  NFTokenID: string
  NFTokenTaxon: number
  URI?: string
  nft_serial: number
}

/**
 * Response expected from an {@link AccountNFTsRequest}.
 *
 * @category Responses
 */
export interface AccountNFTsResponse extends BaseResponse {
  result: {
    /**
     * The account requested.
     */
    account: string
    /**
     * A list of NFTs owned by the specified account.
     */
    account_nfts: AccountNFToken[]
    /**
     * The ledger index of the current open ledger, which was used when
     * retrieving this information.
     */
    ledger_current_index: number
    /** If true, this data comes from a validated ledger. */
    validated: boolean
    /**
     * Server-defined value indicating the response is paginated. Pass this to
     * the next call to resume where this call left off. Omitted when there are
     * No additional pages after this one.
     */
    marker?: unknown
    /** The limit that was used to fulfill this request. */
    limit?: number
  }
}