> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WalletsApiClient

<Note>
  **This page has been updated for Wallets SDK V1.** If you are using the previous version,
  see the [previous version of this page](/sdk-reference/wallets/v0/typescript/classes/WalletsApiClient) or the [V1 migration guide](/wallets/guides/migrate-to-v1).
</Note>

Defined in: [packages/wallets/src/api/client.ts:40](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L40)

## Extends

* `CrossmintApiClient`

## Constructors

### new WalletsApiClient()

> **new WalletsApiClient**(`crossmint`): `ApiClient`

Defined in: [packages/wallets/src/api/client.ts:44](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L44)

#### Parameters

| Parameter   | Type        |
| ----------- | ----------- |
| `crossmint` | `Crossmint` |

#### Returns

`ApiClient`

#### Overrides

`CrossmintApiClient.constructor`

## Properties

| Property                         | Type        | Inherited from                 | Defined in                                                     |
| -------------------------------- | ----------- | ------------------------------ | -------------------------------------------------------------- |
| <a id="crossmint" /> `crossmint` | `Crossmint` | `CrossmintApiClient.crossmint` | packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:15 |

## Accessors

### baseUrl

#### Get Signature

> **get** **baseUrl**(): `string`

Defined in: packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:21

##### Returns

`string`

#### Inherited from

`CrossmintApiClient.baseUrl`

***

### commonHeaders

#### Get Signature

> **get** **commonHeaders**(): `object`

Defined in: packages/common/base/dist/apiClient/CrossmintApiClient.d.ts:22

##### Returns

`object`

###### Authorization?

> `optional` **Authorization**: `string`

###### x-api-key

> **x-api-key**: `string`

###### x-app-identifier?

> `optional` **x-app-identifier**: `string`

###### x-client-name

> **x-client-name**: `string`

###### x-client-version

> **x-client-version**: `string`

###### x-extension-id?

> `optional` **x-extension-id**: `string`

#### Inherited from

`CrossmintApiClient.commonHeaders`

***

### environment

#### Get Signature

> **get** **environment**(): `APIKeyEnvironmentPrefix`

Defined in: [packages/wallets/src/api/client.ts:274](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L274)

##### Returns

`APIKeyEnvironmentPrefix`

#### Overrides

`CrossmintApiClient.environment`

***

### isServerSide

#### Get Signature

> **get** **isServerSide**(): `boolean`

Defined in: [packages/wallets/src/api/client.ts:270](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L270)

##### Returns

`boolean`

***

### projectId

#### Get Signature

> **get** **projectId**(): `string`

Defined in: [packages/wallets/src/api/client.ts:281](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L281)

##### Returns

`string`

## Methods

### approveSignature()

> **approveSignature**(`walletLocator`, `signatureId`, `params`): `Promise`\<`ApproveSignatureResponse`>

Defined in: [packages/wallets/src/api/client.ts:139](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L139)

#### Parameters

| Parameter       | Type                     |
| --------------- | ------------------------ |
| `walletLocator` | `string`                 |
| `signatureId`   | `string`                 |
| `params`        | `SubmitApprovalV2025Dto` |

#### Returns

`Promise`\<`ApproveSignatureResponse`>

***

### approveTransaction()

> **approveTransaction**(`walletLocator`, `transactionId`, `params`): `Promise`\<`ApproveTransactionResponse`>

Defined in: [packages/wallets/src/api/client.ts:109](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L109)

#### Parameters

| Parameter       | Type                     |
| --------------- | ------------------------ |
| `walletLocator` | `string`                 |
| `transactionId` | `string`                 |
| `params`        | `SubmitApprovalV2025Dto` |

#### Returns

`Promise`\<`ApproveTransactionResponse`>

***

### buildUrl()

> **buildUrl**(`path`): `string`

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:11

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `path`    | `string` |

#### Returns

`string`

#### Inherited from

`CrossmintApiClient.buildUrl`

***

### createSignature()

> **createSignature**(`walletLocator`, `params`): `Promise`\<`CreateSignatureResponse`>

Defined in: [packages/wallets/src/api/client.ts:128](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L128)

#### Parameters

| Parameter       | Type                      |
| --------------- | ------------------------- |
| `walletLocator` | `string`                  |
| `params`        | `CreateSignatureV2025Dto` |

#### Returns

`Promise`\<`CreateSignatureResponse`>

***

### createTransaction()

> **createTransaction**(`walletLocator`, `params`): `Promise`\<`CreateTransactionResponse`>

Defined in: [packages/wallets/src/api/client.ts:98](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L98)

#### Parameters

| Parameter       | Type                        |
| --------------- | --------------------------- |
| `walletLocator` | `string`                    |
| `params`        | `CreateTransactionV2025Dto` |

#### Returns

`Promise`\<`CreateTransactionResponse`>

***

### createWallet()

> **createWallet**(`params`): `Promise`\<`CreateWalletResponse`>

Defined in: [packages/wallets/src/api/client.ts:52](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L52)

#### Parameters

| Parameter | Type                   |
| --------- | ---------------------- |
| `params`  | `CreateWalletV2025Dto` |

#### Returns

`Promise`\<`CreateWalletResponse`>

***

### delete()

> **delete**(`path`, `params`): `Promise`\<`Response`>

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:15

#### Parameters

| Parameter | Type                               |
| --------- | ---------------------------------- |
| `path`    | `string`                           |
| `params`  | `Omit`\<`RequestInit`, `"method"`> |

#### Returns

`Promise`\<`Response`>

#### Inherited from

`CrossmintApiClient.delete`

***

### fundWallet()

> **fundWallet**(`walletLocator`, `params`): `Promise`\<`FundWalletResponse`>

Defined in: [packages/wallets/src/api/client.ts:218](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L218)

#### Parameters

| Parameter       | Type                  |
| --------------- | --------------------- |
| `walletLocator` | `string`              |
| `params`        | `FundWalletAmountDto` |

#### Returns

`Promise`\<`FundWalletResponse`>

***

### get()

> **get**(`path`, `params`): `Promise`\<`Response`>

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:12

#### Parameters

| Parameter | Type                               |
| --------- | ---------------------------------- |
| `path`    | `string`                           |
| `params`  | `Omit`\<`RequestInit`, `"method"`> |

#### Returns

`Promise`\<`Response`>

#### Inherited from

`CrossmintApiClient.get`

***

### getBalance()

> **getBalance**(`walletLocator`, `params`): `Promise`\<`GetBalanceResponse`>

Defined in: [packages/wallets/src/api/client.ts:202](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L202)

#### Parameters

| Parameter       | Type                                                                       |
| --------------- | -------------------------------------------------------------------------- |
| `walletLocator` | `string`                                                                   |
| `params`        | \{ `chains`: [`Chain`](../type-aliases/Chain)\[]; `tokens`: `string`\[]; } |
| `params.chains` | [`Chain`](../type-aliases/Chain)\[]                                        |
| `params.tokens` | `string`\[]                                                                |

#### Returns

`Promise`\<`GetBalanceResponse`>

***

### getNfts()

> **getNfts**(`params`): `Promise`\<`unknown`>

Defined in: [packages/wallets/src/api/client.ts:165](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L165)

#### Parameters

| Parameter        | Type                                                                                |
| ---------------- | ----------------------------------------------------------------------------------- |
| `params`         | \{ `address`: `string`; `chain`: `string`; `page`: `number`; `perPage`: `number`; } |
| `params.address` | `string`                                                                            |
| `params.chain`   | `string`                                                                            |
| `params.page`    | `number`                                                                            |
| `params.perPage` | `number`                                                                            |

#### Returns

`Promise`\<`unknown`>

***

### getSignature()

> **getSignature**(`walletLocator`, `signatureId`): `Promise`\<`GetSignatureResponse`>

Defined in: [packages/wallets/src/api/client.ts:151](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L151)

#### Parameters

| Parameter       | Type     |
| --------------- | -------- |
| `walletLocator` | `string` |
| `signatureId`   | `string` |

#### Returns

`Promise`\<`GetSignatureResponse`>

***

### getSigner()

> **getSigner**(`walletLocator`, `signer`): `Promise`\<`GetSignerResponse`>

Defined in: [packages/wallets/src/api/client.ts:237](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L237)

#### Parameters

| Parameter       | Type     |
| --------------- | -------- |
| `walletLocator` | `string` |
| `signer`        | `string` |

#### Returns

`Promise`\<`GetSignerResponse`>

***

### getTransaction()

> **getTransaction**(`walletLocator`, `transactionId`): `Promise`\<`GetTransactionResponse`>

Defined in: [packages/wallets/src/api/client.ts:121](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L121)

#### Parameters

| Parameter       | Type     |
| --------------- | -------- |
| `walletLocator` | `string` |
| `transactionId` | `string` |

#### Returns

`Promise`\<`GetTransactionResponse`>

***

### getTransactions()

> **getTransactions**(`walletLocator`): `Promise`\<`GetTransactionsResponse`>

Defined in: [packages/wallets/src/api/client.ts:158](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L158)

#### Parameters

| Parameter       | Type     |
| --------------- | -------- |
| `walletLocator` | `string` |

#### Returns

`Promise`\<`GetTransactionsResponse`>

***

### getTransfers()

> **getTransfers**(`walletLocator`, `params`): `Promise`\<`GetTransfersResponse`>

Defined in: [packages/wallets/src/api/client.ts:181](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L181)

#### Parameters

| Parameter        | Type                                                                                                        |
| ---------------- | ----------------------------------------------------------------------------------------------------------- |
| `walletLocator`  | `string`                                                                                                    |
| `params`         | \{ `chain`: [`Chain`](../type-aliases/Chain); `status`: `"successful"` \| `"failed"`; `tokens`: `string`; } |
| `params.chain`   | [`Chain`](../type-aliases/Chain)                                                                            |
| `params.status`? | `"successful"` \| `"failed"`                                                                                |
| `params.tokens`? | `string`                                                                                                    |

#### Returns

`Promise`\<`GetTransfersResponse`>

***

### getWallet()

> **getWallet**(`locator`): `Promise`\<`GetWalletResponse`>

Defined in: [packages/wallets/src/api/client.ts:78](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L78)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `locator` | `string` |

#### Returns

`Promise`\<`GetWalletResponse`>

***

### patch()

> **patch**(`path`, `params`): `Promise`\<`Response`>

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:16

#### Parameters

| Parameter | Type                               |
| --------- | ---------------------------------- |
| `path`    | `string`                           |
| `params`  | `Omit`\<`RequestInit`, `"method"`> |

#### Returns

`Promise`\<`Response`>

#### Inherited from

`CrossmintApiClient.patch`

***

### post()

> **post**(`path`, `params`): `Promise`\<`Response`>

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:13

#### Parameters

| Parameter | Type                               |
| --------- | ---------------------------------- |
| `path`    | `string`                           |
| `params`  | `Omit`\<`RequestInit`, `"method"`> |

#### Returns

`Promise`\<`Response`>

#### Inherited from

`CrossmintApiClient.post`

***

### put()

> **put**(`path`, `params`): `Promise`\<`Response`>

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:14

#### Parameters

| Parameter | Type                               |
| --------- | ---------------------------------- |
| `path`    | `string`                           |
| `params`  | `Omit`\<`RequestInit`, `"method"`> |

#### Returns

`Promise`\<`Response`>

#### Inherited from

`CrossmintApiClient.put`

***

### registerSigner()

> **registerSigner**(`walletLocator`, `params`): `Promise`\<`RegisterSignerResponse`>

Defined in: [packages/wallets/src/api/client.ts:229](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L229)

#### Parameters

| Parameter       | Type                   |
| --------------- | ---------------------- |
| `walletLocator` | `string`               |
| `params`        | `RegisterSignerParams` |

#### Returns

`Promise`\<`RegisterSignerResponse`>

***

### send()

> **send**(`walletLocator`, `tokenLocator`, `params`): `Promise`\<`WalletsV1Alpha2TransactionResponseWithSendParamsDto`>

Defined in: [packages/wallets/src/api/client.ts:244](https://github.com/Crossmint/crossmint-sdk/blob/main/packages/wallets/src/api/client.ts#L244)

#### Parameters

| Parameter       | Type           |
| --------------- | -------------- |
| `walletLocator` | `string`       |
| `tokenLocator`  | `string`       |
| `params`        | `SendTokenDto` |

#### Returns

`Promise`\<`WalletsV1Alpha2TransactionResponseWithSendParamsDto`>

***

### normalizePath()

> `static` **normalizePath**(`path`): `string`

Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:17

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `path`    | `string` |

#### Returns

`string`

#### Inherited from

`CrossmintApiClient.normalizePath`