> For the complete documentation index, see [llms.txt](https://docs.stacks.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stacks.co/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchaccountstatus.md).

# fetchAccountStatus

Reads the node's `/v2/accounts/<address>` endpoint and returns the account's micro-STX balance, locked micro-STX, nonce and unlock height. It reads no pox-5 function, map or data-var.

***

### Usage

```ts
import { fetchAccountStatus } from '@stacks/bitcoin-staking';

const account = await fetchAccountStatus({
  address: 'SP2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKNRV9EJ7',
  network: 'mainnet',
});

account.locked; // micro-STX locked by staking, as a bigint
account.unlockHeight; // 0 when no lock is active
```

#### Notes

* `balance`, `locked` and `nonce` are `bigint`. `unlockHeight` is a Bitcoin block height as a `number`, and is `0` when no lock is active.
* Requests `?proof=0`, so the node returns no Merkle proof.
* A non-2xx response throws an `Error` whose message starts with `Error fetching account status.` and includes the status code and URL.

[**Reference Link**](https://github.com/stx-labs/stacks.js/blob/6101c99efe5a9616ce7e16cef68e28fd10676e7e/packages/bitcoin-staking/src/fetch.ts#L118-L141)

***

### Signature

```ts
function fetchAccountStatus(
  opts: { address: string } & NetworkClientParam
): Promise<AccountStatus>;
```

`opts` is a [NetworkClientParam](/reference/stacks.js/stacks-network/network/networkclientparam.md) plus `address`.

***

### Returns

`Promise<AccountStatus>`

Resolves to an [AccountStatus](/reference/stacks.js/stacks-bitcoin-staking/types/accountstatus.md) built from the node's response.

***

### Parameters

#### opts.address (required)

* **Type**: `string`

Stacks address of the account. It is URL-encoded into the request path.

#### opts.network (optional)

* **Type**: `StacksNetworkName | StacksNetwork`

The network to query: a name such as `'mainnet'` or `'testnet'`, or a [StacksNetwork](/reference/stacks.js/stacks-network/network/stacksnetwork.md) object. Defaults to `'mainnet'`.

#### opts.client (optional)

* **Type**: `{ baseUrl?: string; fetch?: FetchFn }`

Overrides the API base URL or the `fetch` function, for example to query your own node. Fields you set replace the network's defaults.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stacks.co/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchaccountstatus.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.