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

# connect

Initiates a wallet connection by prompting the user to select a wallet and then requesting their addresses. This is a convenience wrapper around [`request`](/reference/stacks.js/stacks-connect/request/request.md) that calls `getAddresses` with `forceWalletSelect: true`.

***

### Usage

```ts
import { connect } from '@stacks/connect';

const response = await connect();

console.log('Addresses:', response.addresses);
```

```ts
import { connect } from '@stacks/connect';

// With options
const response = await connect({
  forceWalletSelect: true,
  approvedProviderIds: ['LeatherProvider', 'XverseProviders.BitcoinProvider'],
  network: 'mainnet',
});
```

#### Notes

* This always opens the wallet selection modal, regardless of whether a wallet was previously selected.
* The returned addresses include both STX and BTC addresses provided by the wallet.
* Accepts all [`ConnectRequestOptions`](/reference/stacks.js/stacks-connect/request/connectrequestoptions.md) properties as well as `GetAddressesParams` (e.g. `network`).

[**Reference Link**](https://github.com/stx-labs/connect/blob/main/packages/connect/src/request.ts#L307)

***

### Signature

```ts
function connect(
  options?: ConnectRequestOptions & MethodParams<'getAddresses'>
): Promise<GetAddressesResult>
```

***

### Returns

`Promise<GetAddressesResult>`

```ts
interface GetAddressesResult {
  addresses: AddressEntry[];
}

interface AddressEntry {
  symbol?: string;
  address: string;
  publicKey: string;
}
```

An object containing an `addresses` array. Each entry includes the address string, its public key, and an optional `symbol` (e.g. `'STX'` or `'BTC'`).

***

### Parameters

#### options (optional)

* **Type**: `ConnectRequestOptions & MethodParams<'getAddresses'>`

Combines all properties from [`ConnectRequestOptions`](/reference/stacks.js/stacks-connect/request/connectrequestoptions.md) with `GetAddressesParams`.

The additional parameter from `GetAddressesParams`:

| Name      | Type            | Required | Description                                                           |
| --------- | --------------- | -------- | --------------------------------------------------------------------- |
| `network` | `NetworkString` | No       | The network to request addresses for (e.g. `'mainnet'`, `'testnet'`). |


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.stacks.co/reference/stacks.js/stacks-connect/connection/connect.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
