Interface AccountNFTsRequest

The account_nfts method retrieves all of the NFTs currently owned by the specified account.

interface AccountNFTsRequest {
    account: string;
    api_version?: number;
    command: "account_nfts";
    id?: string | number;
    ledger_hash?: string;
    ledger_index?: LedgerIndex;
    limit?: number;
    marker?: unknown;
    [x: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [x: string]: unknown

Properties

account api_version? command id? ledger_hash? ledger_index? limit? marker?

Properties

account

account: string

The unique identifier of an account, typically the account's address. The request returns NFTs owned by this account.

Optionalapi_version

api_version?: number

The API version to use. If omitted, use version 1.

command

command: "account_nfts"

The name of the API method.

Optionalid

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Optionalledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

Optionalledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string.

Optionallimit

limit?: number

Limit the number of NFTokens to retrieve.

Optionalmarker

marker?: unknown

Value from a previous paginated response. Resume retrieving data where that response left off.

Settings

Member Visibility

On This Page

Properties