Account Information

GET /v2/accounts/{address}?format={format}&exclude={exclude}

Get account information.

Given a specific account public key, this call returns the accounts status, balance and spendable amounts

Properties

Name	Type	Description
address*	`string`	An account public key
exclude	`"all" \| "none"`	When set to `all` will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to `none`.
format	`"json" \| "msgpack"`	Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

* indicates required property

Packages

Node.js

Install

npm install algosdk --save

Usage

import { Algodv2 } from "algosdk";

const data = {address: "BMG2OPCDNEVFG5LW4S6GT33PPEWXVJD7XEDLTED4BFWN5M4HXLZNCK3EWY"}
const client = new Algodv2( "", "https://testnet-api.algonode.cloud", 443 );
const result = await client.accountInformation(data.address).do();

Algosdk Documentation Learn more at the official documentation for algosdk

import { AlgodClient } from '@awesome-algorand/algod-fetch';

const data = {address: "BMG2OPCDNEVFG5LW4S6GT33PPEWXVJD7XEDLTED4BFWN5M4HXLZNCK3EWY"}
const client = new AlgodClient();
const result = await client.public.accountInformation(data);

Algo-fetch Documentation Learn more at the experimental documentation for algo-fetch

Install

npm install @awesome-algorand/react-query @txnlab/use-wallet-react @tanstack/react-query algosdk --save

Usage

import { useAccountAssetInformation } from '@awesome-algorand/react-query';

export function AccountInformationViewer() {
    const data = {address: "BMG2OPCDNEVFG5LW4S6GT33PPEWXVJD7XEDLTED4BFWN5M4HXLZNCK3EWY"}
    const query = useAccountInformation(data);
}

Tutorial Learn how to use the useAccountInformation hook in a React application.

Install

npm install @awesome-algorand/query-core @txnlab/use-wallet-react @tanstack/react-query algosdk --save

Usage

import { useQuery } from 'react-query';
import { accountInformation } from '@awesome-algorand/query-core';
import { useWallet } from "@txnlab/use-wallet-react";

export function AccountInformationViewer() {
    const walletManager = useWallet();
    const data = {address: "BMG2OPCDNEVFG5LW4S6GT33PPEWXVJD7XEDLTED4BFWN5M4HXLZNCK3EWY"}
    const query = useQuery(accountInformation(data));
}

Svelte [WIP]

@awesome-algorand/svelte-query

Coming Soon!

Solid [WIP]

@awesome-algorand/solid-query

Coming Soon!

Vue [WIP]

@awesome-algorand/vue-query

Coming Soon!

Angular [WIP]

@awesome-algorand/angular-query

Coming Soon!