getTokenBalance

Function: getTokenBalance()

function getTokenBalance<ThrowOnError>(options: OmitKeys<RequestOptions<ThrowOnError>, "body" | "url"> & GetTokenBalanceData & Pick<RequestOptions<ThrowOnError>, "headers">): RequestResult<BalanceResponse, ErrorResponse, ThrowOnError>

Defined in: packages/api/src/client/sdk.gen.ts:72

Retrieve the balance of a specific token for an address.
The balance endpoint retrieves the balance of a specific fungible token for a given Mina address.

Type Parameters

ThrowOnError extends boolean = false

Parameters

options

OmitKeys<RequestOptions<ThrowOnError>, "body" | "url"> & GetTokenBalanceData & Pick<RequestOptions<ThrowOnError>, "headers">

Returns

RequestResult<BalanceResponse, ErrorResponse, ThrowOnError>