> 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/fetchbondstatus.md).

# fetchBondStatus

Returns a protocol bond's status, such as `'open'` or `'locked'`, at the current Bitcoin block height. It fetches the PoX info and the bond's setup state if you do not pass them, then calls [bondStatus](/reference/stacks.js/stacks-bitcoin-staking/cycles/bondstatus.md).

***

### Usage

```ts
import { fetchBondStatus, fetchPoxInfo, fetchProtocolBond } from '@stacks/bitcoin-staking';

// Fetches /v2/pox and get-protocol-bond for you
const status = await fetchBondStatus({ bondIndex: 1, network: 'mainnet' });

// Reuses values you already hold, with no extra requests
const poxInfo = await fetchPoxInfo({ network: 'mainnet' });
const bond = await fetchProtocolBond({ bondIndex: 1, network: 'mainnet' });
const sameStatus = await fetchBondStatus({
  bondIndex: 1,
  poxInfo,
  isBondSetup: bond !== undefined,
});
```

#### Notes

* The source marks this `@experimental`.
* Without `opts.poxInfo` it calls [fetchPoxInfo](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchpoxinfo.md). Without `opts.isBondSetup` it calls [fetchProtocolBond](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchprotocolbond.md), which reads the pox-5 [`get-protocol-bond`](https://github.com/stacks-network/stacks-core/blob/10474cdec9f9c0bdf05841b58cffc89cdad87a9b/stackslib/src/chainstate/stacks/boot/pox-5.clar#L3322-L3324) read-only. The two requests run in parallel.
* The status is computed at `poxInfo.currentBurnchainBlockHeight`. A `poxInfo` you fetched earlier gives the status at that earlier height.
* Errors from either fetch propagate unchanged.

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

***

### Signature

```ts
function fetchBondStatus(
  opts: {
    bondIndex: number;
    poxInfo?: PoxInfo;
    isBondSetup?: boolean;
  } & NetworkClientParam
): Promise<BondStatusName>;
```

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

***

### Returns

`Promise<BondStatusName>`

Resolves to a [BondStatusName](/reference/stacks.js/stacks-bitcoin-staking/cycles/bondstatusname.md).

***

### Parameters

#### opts.bondIndex (required)

* **Type**: `number`

Index of the protocol bond.

#### opts.poxInfo (optional)

* **Type**: `PoxInfo`

A [PoxInfo](/reference/stacks.js/stacks-bitcoin-staking/types/poxinfo.md) you already hold. Fetched with [fetchPoxInfo](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchpoxinfo.md) when omitted.

#### opts.isBondSetup (optional)

* **Type**: `boolean`

Whether `setup-bond` has been called for this bond, for example `bond !== undefined` after [fetchProtocolBond](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchprotocolbond.md). Fetched when omitted.

#### 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/fetchbondstatus.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.