useAccountTokens

Hook for fetching token balances (NFTs) for a specific account, with support for pagination. If no address is provided, it defaults to the connected account.

Usage


import { useAccountTokens } from "@aptos-labs/react";
import { AccountAddress } from "@aptos-labs/ts-sdk";
 
export default function App() {
  const { data, isLoading } = useAccountTokens({
    address: AccountAddress.from(
      "0x926ff619e85bdb5b02680f27bea5ea3302c71f86be4b16fa0d63df213add927a",
    ),
  });
 
  if (isLoading) return <div>Loading...</div>;
 
  return (
    <div>
      <h1>Account Tokens</h1>
      <ul>
        {data?.pages[0]?.tokens?.map((token) => (
          <li key={`${token.tokenId}-v${token.tokenStandard}`}>
            {token.name} ({token.collectionData?.name}): {token.amount} -{" "}
            <a
              href={token.metadataUri}
              target="_blank"
              rel="noopener noreferrer"
            >
              View URI
            </a>
          </li>
        ))}
      </ul>
    </div>
  );
}

Parameters

Name	Type	Default
`address`	`AccountAddressInput` The address of the account to fetch the tokens (NFTs) for.
`collectionId`	`string` The ID of the collection to fetch the tokens for.
`orderBy`	`Current_Token_Ownerships_V2_Order_By \| Current_Token_Ownerships_V2_Order_By[]` Conditions for ordering the token ownership results.
`where`	`Current_Token_Ownerships_V2_Bool_Exp \| Current_Token_Ownerships_V2_Bool_Exp[]` Filters for the token ownership results.
`network`	`NetworkInfo` The network to use for the request. If not set, the network of the `AptosJSProClient` instance will be used.
`limit`	`number` The number of results to return per page. This value is capped at 100 results.	`100`
`offset`	`number` The offset to start the query from.	`0`
`enabled`	`Enabled<FetchAccountTokensResult, Error, InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, readonly unknown[]>` Set this to `false` or a function that returns `false` to disable automatic refetching when the query mounts or changes query keys. To refetch the query, use the `refetch` method returned from the `useQuery` instance. Accepts a boolean or function that returns a boolean. Defaults to `true`.
`staleTime`	`StaleTimeFunction<FetchAccountTokensResult, Error, InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, readonly unknown[]>` The time in milliseconds after data is considered stale. If set to `Infinity`, the data will never be considered stale. If set to a function, the function will be executed with the query to compute a `staleTime`. Defaults to `0`.
`refetchInterval`	`number \| false \| ((query: Query<FetchAccountTokensResult, Error, InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, readonly unknown[]>) => number \| ... 1 more ... \| undefined)` If set to a number, the query will continuously refetch at this frequency in milliseconds. If set to a function, the function will be executed with the latest data and query to compute a frequency Defaults to `false`.
`refetchIntervalInBackground`	`boolean` If set to `true`, the query will continue to refetch while their tab/window is in the background. Defaults to `false`.
`refetchOnWindowFocus`	`boolean \| "always" \| ((query: Query<FetchAccountTokensResult, Error, InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, readonly unknown[]>) => boolean \| "always")` If set to `true`, the query will refetch on window focus if the data is stale. If set to `false`, the query will not refetch on window focus. If set to `'always'`, the query will always refetch on window focus. If set to a function, the function will be executed with the latest data and query to compute the value. Defaults to `true`.
`refetchOnReconnect`	`boolean \| "always" \| ((query: Query<FetchAccountTokensResult, Error, InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, readonly unknown[]>) => boolean \| "always")` If set to `true`, the query will refetch on reconnect if the data is stale. If set to `false`, the query will not refetch on reconnect. If set to `'always'`, the query will always refetch on reconnect. If set to a function, the function will be executed with the latest data and query to compute the value. Defaults to the value of `networkOnline` (`true`)
`refetchOnMount`	`boolean \| "always" \| ((query: Query<FetchAccountTokensResult, Error, InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, readonly unknown[]>) => boolean \| "always")` If set to `true`, the query will refetch on mount if the data is stale. If set to `false`, will disable additional instances of a query to trigger background refetch. If set to `'always'`, the query will always refetch on mount. If set to a function, the function will be executed with the latest data and query to compute the value Defaults to `true`.
`retryOnMount`	`boolean` If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.
`notifyOnChangeProps`	`NotifyOnChangeProps` If set, the component will only re-render if any of the listed properties change. When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change. When set to `'all'`, the component will re-render whenever a query is updated. When set to a function, the function will be executed to compute the list of properties. By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.
`throwOnError`	`ThrowOnError<FetchAccountTokensResult, Error, InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, readonly unknown[]>` Whether errors should be thrown instead of setting the `error` property. If set to `true` or `suspense` is `true`, all errors will be thrown to the error boundary. If set to `false` and `suspense` is `false`, errors are returned as state. If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`). Defaults to `false`.
`select`	`(data: InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>) => InfiniteData<FetchAccountTokensResult, unknown>` This option can be used to transform or select a part of the data returned by the query function.
`placeholderData`	`InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam> \| PlaceholderDataFunction<InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, Error, InfiniteData<...>, readonly unknown[]>` If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided.
`_optimisticResults`	`"optimistic" \| "isRestoring"`
`experimental_prefetchInRender`	`boolean` Enable prefetching during rendering
`retry`	`RetryValue<Error>` If `false`, failed queries will not retry by default. If `true`, failed queries will retry infinitely., failureCount: num If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. If set to a function `(failureCount, error) => boolean` failed queries will retry until the function returns false.
`retryDelay`	`RetryDelayValue<Error>`
`networkMode`	`NetworkMode`
`gcTime`	`number` The time in milliseconds that unused/inactive cache data remains in memory. When a query’s cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used. Setting it to `Infinity` will disable garbage collection.
`persister`	`(queryFn: QueryFunction<FetchAccountTokensResult, readonly unknown[], UseOffsetLimitPageParam>, context: { client: QueryClient; ... 4 more ...; direction?: unknown; }, query: Query<...>) => FetchAccountTokensResult \| Promise<...>`
`queryHash`	`string`
`queryKeyHashFn`	`QueryKeyHashFunction<readonly unknown[]>`
`initialData`	`InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam> \| InitialDataFunction<InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>>`
`initialDataUpdatedAt`	`number \| (() => number \| undefined)`
`behavior`	`QueryBehavior<FetchAccountTokensResult, Error, InfiniteData<FetchAccountTokensResult, UseOffsetLimitPageParam>, readonly unknown[]>`
`structuralSharing`	`boolean \| ((oldData: unknown, newData: unknown) => unknown)` Set this to `false` to disable structural sharing between query results. Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic. Defaults to `true`.
`_defaulted`	`boolean`
`meta`	`Record<string, unknown>` Additional payload to be stored on each query. Use this property to pass information that can be used in other places.
`maxPages`	`number` Maximum number of pages to store in the data of an infinite query.
`subscribed`	`boolean` Set this to `false` to unsubscribe this observer from updates to the query cache. Defaults to `true`.

Return Type

Name	Type	Default
`data`	`InfiniteData<FetchAccountTokensResult, unknown> \| undefined` The last successfully resolved data for the query. The last successfully resolved data for the query. The last successfully resolved data for the query. The last successfully resolved data for the query. The last successfully resolved data for the query. The last successfully resolved data for the query.
`error`	`Error \| null` The error object for the query, if an error was thrown. Defaults to `null`. The error object for the query, if an error was thrown. Defaults to `null`. The error object for the query, if an error was thrown. Defaults to `null`. The error object for the query, if an error was thrown. Defaults to `null`. The error object for the query, if an error was thrown. Defaults to `null`. The error object for the query, if an error was thrown. Defaults to `null`.
`isError`	`boolean` A derived boolean from the `status` variable, provided for convenience. `true` if the query attempt resulted in an error. A derived boolean from the `status` variable, provided for convenience. `true` if the query attempt resulted in an error. A derived boolean from the `status` variable, provided for convenience. `true` if the query attempt resulted in an error. A derived boolean from the `status` variable, provided for convenience. `true` if the query attempt resulted in an error. A derived boolean from the `status` variable, provided for convenience. `true` if the query attempt resulted in an error. A derived boolean from the `status` variable, provided for convenience. `true` if the query attempt resulted in an error.
`isPending`	`boolean` Will be `pending` if there’s no cached data and no query attempt was finished yet. Will be `pending` if there’s no cached data and no query attempt was finished yet. Will be `pending` if there’s no cached data and no query attempt was finished yet. Will be `pending` if there’s no cached data and no query attempt was finished yet. Will be `pending` if there’s no cached data and no query attempt was finished yet. Will be `pending` if there’s no cached data and no query attempt was finished yet.
`isLoading`	`boolean` Is `true` whenever the first fetch for a query is in-flight. Is the same as `isFetching && isPending`.
`isLoadingError`	`boolean` Will be `true` if the query failed while fetching for the first time. Will be `true` if the query failed while fetching for the first time. Will be `true` if the query failed while fetching for the first time. Will be `true` if the query failed while fetching for the first time. Will be `true` if the query failed while fetching for the first time. Will be `true` if the query failed while fetching for the first time.
`isRefetchError`	`boolean` Will be `true` if the query failed while refetching. Will be `true` if the query failed while refetching. Will be `true` if the query failed while refetching. Will be `true` if the query failed while refetching. Will be `true` if the query failed while refetching. Will be `true` if the query failed while refetching.
`isSuccess`	`boolean` A derived boolean from the `status` variable, provided for convenience. `true` if the query has received a response with no errors and is ready to display its data. A derived boolean from the `status` variable, provided for convenience. `true` if the query has received a response with no errors and is ready to display its data. A derived boolean from the `status` variable, provided for convenience. `true` if the query has received a response with no errors and is ready to display its data. A derived boolean from the `status` variable, provided for convenience. `true` if the query has received a response with no errors and is ready to display its data. A derived boolean from the `status` variable, provided for convenience. `true` if the query has received a response with no errors and is ready to display its data. A derived boolean from the `status` variable, provided for convenience. `true` if the query has received a response with no errors and is ready to display its data.
`isPlaceholderData`	`boolean` Will be `true` if the data shown is the placeholder data. Will be `true` if the data shown is the placeholder data. Will be `true` if the data shown is the placeholder data. Will be `true` if the data shown is the placeholder data. Will be `true` if the data shown is the placeholder data. Will be `true` if the data shown is the placeholder data.
`status`	`"error" \| "success" \| "pending"` The status of the query. Will be: `pending` if there’s no cached data and no query attempt was finished yet. `error` if the query attempt resulted in an error. `success` if the query has received a response with no errors and is ready to display its data. The status of the query. Will be: `pending` if there’s no cached data and no query attempt was finished yet. `error` if the query attempt resulted in an error. `success` if the query has received a response with no errors and is ready to display its data. The status of the query. Will be: `pending` if there’s no cached data and no query attempt was finished yet. `error` if the query attempt resulted in an error. `success` if the query has received a response with no errors and is ready to display its data. The status of the query. Will be: `pending` if there’s no cached data and no query attempt was finished yet. `error` if the query attempt resulted in an error. `success` if the query has received a response with no errors and is ready to display its data. The status of the query. Will be: `pending` if there’s no cached data and no query attempt was finished yet. `error` if the query attempt resulted in an error. `success` if the query has received a response with no errors and is ready to display its data. The status of the query. Will be: `pending` if there’s no cached data and no query attempt was finished yet. `error` if the query attempt resulted in an error. `success` if the query has received a response with no errors and is ready to display its data.
`fetchNextPage`	`(options?: FetchNextPageOptions \| undefined) => Promise<InfiniteQueryObserverResult<InfiniteData<FetchAccountTokensResult, unknown>, Error>>` This function allows you to fetch the next “page” of results.
`fetchPreviousPage`	`(options?: FetchPreviousPageOptions \| undefined) => Promise<InfiniteQueryObserverResult<InfiniteData<FetchAccountTokensResult, unknown>, Error>>` This function allows you to fetch the previous “page” of results.
`hasNextPage`	`boolean` Will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).
`hasPreviousPage`	`boolean` Will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).
`isFetchNextPageError`	`boolean` Will be `true` if the query failed while fetching the next page.
`isFetchingNextPage`	`boolean` Will be `true` while fetching the next page with `fetchNextPage`.
`isFetchPreviousPageError`	`boolean` Will be `true` if the query failed while fetching the previous page.
`isFetchingPreviousPage`	`boolean` Will be `true` while fetching the previous page with `fetchPreviousPage`.
`dataUpdatedAt`	`number` The timestamp for when the query most recently returned the `status` as `"success"`.
`errorUpdatedAt`	`number` The timestamp for when the query most recently returned the `status` as `"error"`.
`failureCount`	`number` The failure count for the query. Incremented every time the query fails. Reset to `0` when the query succeeds.
`failureReason`	`Error \| null` The failure reason for the query retry. Reset to `null` when the query succeeds.
`errorUpdateCount`	`number` The sum of all errors.
`isFetched`	`boolean` Will be `true` if the query has been fetched.
`isFetchedAfterMount`	`boolean` Will be `true` if the query has been fetched after the component mounted. This property can be used to not show any previously cached data.
`isFetching`	`boolean` A derived boolean from the `fetchStatus` variable, provided for convenience. `true` whenever the `queryFn` is executing, which includes initial `pending` as well as background refetch.
`isInitialLoading`	`boolean`
`isPaused`	`boolean` A derived boolean from the `fetchStatus` variable, provided for convenience. The query wanted to fetch, but has been `paused`.
`isRefetching`	`boolean` Is `true` whenever a background refetch is in-flight, which does not include initial `pending`. Is the same as `isFetching && !isPending`.
`isStale`	`boolean` Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
`refetch`	`(options?: RefetchOptions \| undefined) => Promise<QueryObserverResult<InfiniteData<FetchAccountTokensResult, unknown>, Error>>` A function to manually refetch the query.
`fetchStatus`	`FetchStatus` The fetch status of the query. `fetching`: Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetch. `paused`: The query wanted to fetch, but has been `paused`. `idle`: The query is not fetching. See Network Mode for more information.
`promise`	`Promise<InfiniteData<FetchAccountTokensResult, unknown>>` A stable promise that will be resolved with the data of the query. Requires the `experimental_prefetchInRender` feature flag to be enabled.