Skip to main content

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.

This page has been updated for Wallets SDK V1. If you are using the previous version, see the previous version of this page or the V1 migration guide.
Defined in: packages/wallets/src/api/client.ts:40

​
Extends

  • CrossmintApiClient

​
Constructors

​
new WalletsApiClient()

new WalletsApiClient(crossmint): ApiClient
Defined in: packages/wallets/src/api/client.ts:44

​
Parameters

ParameterType
crossmintCrossmint

​
Returns

ApiClient

​
Overrides

CrossmintApiClient.constructor

​
Properties

PropertyTypeInherited fromDefined in
crossmintCrossmintCrossmintApiClient.crossmintpackages/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
Returns
APIKeyEnvironmentPrefix

​
Overrides

CrossmintApiClient.environment

​
isServerSide

​
Get Signature

get isServerSide(): boolean
Defined in: packages/wallets/src/api/client.ts:270
Returns
boolean

​
projectId

​
Get Signature

get projectId(): string
Defined in: packages/wallets/src/api/client.ts:281
Returns
string

​
Methods

​
approveSignature()

approveSignature(walletLocator, signatureId, params): Promise<ApproveSignatureResponse>
Defined in: packages/wallets/src/api/client.ts:139

​
Parameters

ParameterType
walletLocatorstring
signatureIdstring
paramsSubmitApprovalV2025Dto

​
Returns

Promise<ApproveSignatureResponse>

​
approveTransaction()

approveTransaction(walletLocator, transactionId, params): Promise<ApproveTransactionResponse>
Defined in: packages/wallets/src/api/client.ts:109

​
Parameters

ParameterType
walletLocatorstring
transactionIdstring
paramsSubmitApprovalV2025Dto

​
Returns

Promise<ApproveTransactionResponse>

​
buildUrl()

buildUrl(path): string
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:11

​
Parameters

ParameterType
pathstring

​
Returns

string

​
Inherited from

CrossmintApiClient.buildUrl

​
createSignature()

createSignature(walletLocator, params): Promise<CreateSignatureResponse>
Defined in: packages/wallets/src/api/client.ts:128

​
Parameters

ParameterType
walletLocatorstring
paramsCreateSignatureV2025Dto

​
Returns

Promise<CreateSignatureResponse>

​
createTransaction()

createTransaction(walletLocator, params): Promise<CreateTransactionResponse>
Defined in: packages/wallets/src/api/client.ts:98

​
Parameters

ParameterType
walletLocatorstring
paramsCreateTransactionV2025Dto

​
Returns

Promise<CreateTransactionResponse>

​
createWallet()

createWallet(params): Promise<CreateWalletResponse>
Defined in: packages/wallets/src/api/client.ts:52

​
Parameters

ParameterType
paramsCreateWalletV2025Dto

​
Returns

Promise<CreateWalletResponse>

​
delete()

delete(path, params): Promise<Response>
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:15

​
Parameters

ParameterType
pathstring
paramsOmit<RequestInit, "method">

​
Returns

Promise<Response>

​
Inherited from

CrossmintApiClient.delete

​
fundWallet()

fundWallet(walletLocator, params): Promise<FundWalletResponse>
Defined in: packages/wallets/src/api/client.ts:218

​
Parameters

ParameterType
walletLocatorstring
paramsFundWalletAmountDto

​
Returns

Promise<FundWalletResponse>

​
get()

get(path, params): Promise<Response>
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:12

​
Parameters

ParameterType
pathstring
paramsOmit<RequestInit, "method">

​
Returns

Promise<Response>

​
Inherited from

CrossmintApiClient.get

​
getBalance()

getBalance(walletLocator, params): Promise<GetBalanceResponse>
Defined in: packages/wallets/src/api/client.ts:202

​
Parameters

ParameterType
walletLocatorstring
params{ chains: Chain[]; tokens: string[]; }
params.chainsChain[]
params.tokensstring[]

​
Returns

Promise<GetBalanceResponse>

​
getNfts()

getNfts(params): Promise<unknown>
Defined in: packages/wallets/src/api/client.ts:165

​
Parameters

ParameterType
params{ address: string; chain: string; page: number; perPage: number; }
params.addressstring
params.chainstring
params.pagenumber
params.perPagenumber

​
Returns

Promise<unknown>

​
getSignature()

getSignature(walletLocator, signatureId): Promise<GetSignatureResponse>
Defined in: packages/wallets/src/api/client.ts:151

​
Parameters

ParameterType
walletLocatorstring
signatureIdstring

​
Returns

Promise<GetSignatureResponse>

​
getSigner()

getSigner(walletLocator, signer): Promise<GetSignerResponse>
Defined in: packages/wallets/src/api/client.ts:237

​
Parameters

ParameterType
walletLocatorstring
signerstring

​
Returns

Promise<GetSignerResponse>

​
getTransaction()

getTransaction(walletLocator, transactionId): Promise<GetTransactionResponse>
Defined in: packages/wallets/src/api/client.ts:121

​
Parameters

ParameterType
walletLocatorstring
transactionIdstring

​
Returns

Promise<GetTransactionResponse>

​
getTransactions()

getTransactions(walletLocator): Promise<GetTransactionsResponse>
Defined in: packages/wallets/src/api/client.ts:158

​
Parameters

ParameterType
walletLocatorstring

​
Returns

Promise<GetTransactionsResponse>

​
getTransfers()

getTransfers(walletLocator, params): Promise<GetTransfersResponse>
Defined in: packages/wallets/src/api/client.ts:181

​
Parameters

ParameterType
walletLocatorstring
params{ chain: Chain; status: "successful" | "failed"; tokens: string; }
params.chainChain
params.status?"successful" | "failed"
params.tokens?string

​
Returns

Promise<GetTransfersResponse>

​
getWallet()

getWallet(locator): Promise<GetWalletResponse>
Defined in: packages/wallets/src/api/client.ts:78

​
Parameters

ParameterType
locatorstring

​
Returns

Promise<GetWalletResponse>

​
patch()

patch(path, params): Promise<Response>
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:16

​
Parameters

ParameterType
pathstring
paramsOmit<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

ParameterType
pathstring
paramsOmit<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

ParameterType
pathstring
paramsOmit<RequestInit, "method">

​
Returns

Promise<Response>

​
Inherited from

CrossmintApiClient.put

​
registerSigner()

registerSigner(walletLocator, params): Promise<RegisterSignerResponse>
Defined in: packages/wallets/src/api/client.ts:229

​
Parameters

ParameterType
walletLocatorstring
paramsRegisterSignerParams

​
Returns

Promise<RegisterSignerResponse>

​
send()

send(walletLocator, tokenLocator, params): Promise<WalletsV1Alpha2TransactionResponseWithSendParamsDto>
Defined in: packages/wallets/src/api/client.ts:244

​
Parameters

ParameterType
walletLocatorstring
tokenLocatorstring
paramsSendTokenDto

​
Returns

Promise<WalletsV1Alpha2TransactionResponseWithSendParamsDto>

​
normalizePath()

static normalizePath(path): string
Defined in: packages/common/base/dist/apiClient/ApiClient.d.ts:17

​
Parameters

ParameterType
pathstring

​
Returns

string

​
Inherited from

CrossmintApiClient.normalizePath