Skip to Content
DocumentationTokensCheck If Token Account Is Closed

Check If Token Account Is Closed

The checkTokenAccountIsClosed function checks if a token account is closed or doesn’t exist. A token account can be specified directly or derived from a wallet and mint address.

Usage

const isClosed = await connection.checkTokenAccountIsClosed(params);

Parameters

  • params: Object - Parameters for checking token account
    • tokenAccount: Address (optional) - Direct token account address to check
    • wallet: Address (optional) - Wallet address (required if tokenAccount not provided)
    • mint: Address (optional) - Token mint address (required if tokenAccount not provided)
    • useTokenExtensions: boolean (optional) - Use Token-2022 program instead of Token program (default: false)

Returns

Returns a Promise<boolean> that resolves to:

  • true if the token account is closed or doesn’t exist
  • false if the token account is open

Examples

Check if a token account is closed using direct token account address:

const tokenAccount = "4MD31b2GFAWVDYQT8KG7E5GcZiFyy4MpDUt4BcyEdJRP"; const isClosed = await connection.checkTokenAccountIsClosed({ tokenAccount }); console.log(`Token account is ${isClosed ? "closed" : "open"}`);

Check if a token account is closed using wallet and mint addresses:

const isClosed = await connection.checkTokenAccountIsClosed({ wallet: "GkFTrgp8FcCgkCZeKreKKVHLyzGV6eqBpDHxRzg1brRn", mint: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", useTokenExtensions: true, }); console.log(`Token account is ${isClosed ? "closed" : "open"}`);
Last updated on