Class BitBadgesAdminAPI<T>

This is the BitBadgesAPI class which provides all typed API calls to the BitBadges API. See official documentation for more details and examples. Must pass in a valid API key. , iGetDeveloperAppsPayload convertFunction is used to convert any responses returned by the API to your desired NumberType.

import { BigIntify, Stringify, Numberify, BitBadgesAPI } from "bitbadgesjs-sdk";
const BitBadgesApi = new BitBadgesAPI({ convertFunction: BigIntify, ....})
const collections = await BitBadgesApi.getCollections(...);

By default, we use the official API URL (https://api.bitbadges.io). You can override this by passing in a custom apiUrl.

See

BitBadges API Documentation

Type Parameters

T extends NumberType

Hierarchy (View Summary, Expand)

BitBadgesAPI<T>
- BitBadgesAdminAPI

Index

Constructors

constructor

new BitBadgesAdminAPI<T extends NumberType>(
apiDetails: iBitBadgesApi<T>,
): BitBadgesAdminAPI<T>
Type Parameters
- T extends NumberType
Parameters
- apiDetails: iBitBadgesApi<T>
Returns BitBadgesAdminAPI<T>
Overrides BitBadgesAPI.constructor
- Defined in src/api-indexer/BitBadgesApi.ts:3300

Properties

accessToken

accessToken: string = ''

apiKey

apiKey: undefined | string = process.env.BITBADGES_API_KEY

appendedHeaders

appendedHeaders: Record<string, string> = {}

axios

axios: AxiosInstance = ...

BACKEND_URL

BACKEND_URL: string = ...

ConvertFunction

ConvertFunction: (num: NumberType) => T

Methods

addApprovalDetailsToOffChainStorage

addApprovalDetailsToOffChainStorage(
payload: iAddApprovalDetailsToOffChainStoragePayload,
): Promise<AddApprovalDetailsToOffChainStorageSuccessResponse>
Adds approval details to off-chain storage.
Parameters
- payload: iAddApprovalDetailsToOffChainStoragePayload
Returns Promise<AddApprovalDetailsToOffChainStorageSuccessResponse>
Remarks
- API Route: POST /api/v0/addApprovalDetailsToOffChainStorage
- SDK Function Call: await BitBadgesApi.addApprovalDetailsToOffChainStorage(payload);
- CORS: Restricted to only BitBadges official site. Otherwise, you will need to self-host.
Example
```
const res = await BitBadgesApi.addApprovalDetailsToOffChainStorage(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:3533

addBalancesToOffChainStorage

addBalancesToOffChainStorage(
payload: iAddBalancesToOffChainStoragePayload,
): Promise<AddBalancesToOffChainStorageSuccessResponse>
Adds a balance map to off-chain storage. Mode can either be 'ipfs" for storing on IPFS or 'centralized' for storing on DigitalOcean.
Parameters
- payload: iAddBalancesToOffChainStoragePayload
Returns Promise<AddBalancesToOffChainStorageSuccessResponse>
Remarks
- API Route: POST /api/v0/addBalancesToOffChainStorage
- SDK Function Call: await BitBadgesApi.addBalancesToOffChainStorage(payload);
- CORS: Restricted to only BitBadges official site. Otherwise, you will need to self-host.
Example
```
const res = await BitBadgesApi.addBalancesToOffChainStorage(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:3751

addToIpfs

addToIpfs(payload: iAddToIpfsPayload): Promise<AddToIpfsSuccessResponse>
Adds metadata to IPFS.
Parameters
- payload: iAddToIpfsPayload
Returns Promise<AddToIpfsSuccessResponse>
Remarks
- API Route: POST /api/v0/addToIpfs
- SDK Function Call: await BitBadgesApi.addToIpfs(payload);
- CORS: Restricted to only BitBadges official site. Otherwise, you will need to self-host.
Example
```
const res = await BitBadgesApi.addToIpfs(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:3504

assertPositiveInteger

assertPositiveInteger(num: NumberType): void
Parameters
- num: NumberType
Returns void
Inherited from BitBadgesAPI.assertPositiveInteger
- Defined in src/api-indexer/base.ts:108

broadcastTx

broadcastTx(
payload: string | BroadcastPostBody,
): Promise<BroadcastTxSuccessResponse>
Broadcasts a transaction to the blockchain.
Parameters
- payload: string | BroadcastPostBody
Returns Promise<BroadcastTxSuccessResponse>
Remarks
- API Route: POST /api/v0/broadcast
- SDK Function Call: await BitBadgesApi.broadcastTx(payload);
- Tutorial: See Broadcasting Transactions tutorial on the official docs.
Also, consider checking out Broadcast UI, so you can simply copy and paste your transaction to a UI. All signing, API communication, etc is outsourced to the UI.
Inherited from BitBadgesAPI.broadcastTx
- Defined in src/api-indexer/BitBadgesApi.ts:785

calculatePoints

calculatePoints(
payload: iCalculatePointsPayload,
): Promise<CalculatePointsSuccessResponse>
Calculates points for a page in an application and caches the result.
Parameters
- payload: iCalculatePointsPayload
Returns Promise<CalculatePointsSuccessResponse>
Remarks
- API Route: POST /api/v0/applications/points
- SDK Function Call: await BitBadgesApi.calculatePoints(payload);
Inherited from BitBadgesAPI.calculatePoints
- Defined in src/api-indexer/BitBadgesApi.ts:1724

checkClaimSuccess

checkClaimSuccess(
claimId: string,
address: string,
): Promise<CheckClaimSuccessSuccessResponse>
Checks if a claim has been successfully completed.
Parameters
- claimId: string
- address: string
Returns Promise<CheckClaimSuccessSuccessResponse>
Remarks
- API Route: GET /api/v0/claims/success/:claimId/:address
- SDK Function Call: await BitBadgesApi.checkClaimSuccess(claimId, address);
Inherited from BitBadgesAPI.checkClaimSuccess
- Defined in src/api-indexer/BitBadgesApi.ts:1894

checkIfSignedIn

checkIfSignedIn(
payload?: iCheckSignInStatusPayload,
): Promise<CheckSignInStatusSuccessResponse>
Checks if the user is signed in.
Parameters
- Optionalpayload: iCheckSignInStatusPayload
Returns Promise<CheckSignInStatusSuccessResponse>
Remarks
- API Route: POST /api/v0/auth/status
- SDK Function Call: await BitBadgesApi.checkIfSignedIn(payload);
- Tutorial: See Authentication tutorial on the official docs.
Inherited from BitBadgesAPI.checkIfSignedIn
- Defined in src/api-indexer/BitBadgesApi.ts:757

completeClaim

completeClaim(
    claimId: string,
    address: string,
    payload: iCompleteClaimPayload,
): Promise<CompleteClaimSuccessResponse>
For password based approvals, we hand out codes behind the scenes whenever a user requests a password. This is to prevent replay attacks on the blockchain. This API call will return a valid code if a valid password is provided.

Each address is limited to one code per password. If the password is provided again, they will receive the same code.
Parameters
- claimId: string
- address: string
- payload: iCompleteClaimPayload
Returns Promise<CompleteClaimSuccessResponse>
Remarks
- API Route: POST /api/v0/claims/complete/:claimId/:address
- SDK Function Call: await BitBadgesApi.completeClaim(claimId, address, { ...body });
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.completeClaim(claimId, address, { ...body });
console.log(res);
```
Inherited from BitBadgesAPI.completeClaim
- Defined in src/api-indexer/BitBadgesApi.ts:581

createAddressLists

createAddressLists(
payload: iCreateAddressListsPayload<T>,
): Promise<CreateAddressListsSuccessResponse>
Creates address lists stored by BitBadges centralized servers.
Parameters
- payload: iCreateAddressListsPayload<T>
Returns Promise<CreateAddressListsSuccessResponse>
Remarks
- API Route: POST /api/v0/addressLists
- SDK Function Call: await BitBadgesApi.updateAddressLists(payload);
Must be created off-chain. For on-chain, they must be created through MsgCreateAddressMappings. Creator can update their created lists with no restrictions. Else, requires an edit key.
Inherited from BitBadgesAPI.createAddressLists
- Defined in src/api-indexer/BitBadgesApi.ts:834

createApiKey

createApiKey(
payload: iCreateApiKeyPayload,
): Promise<CreateApiKeySuccessResponse>
Creates an API key.
Parameters
- payload: iCreateApiKeyPayload
Returns Promise<CreateApiKeySuccessResponse>
Remarks
- API Route: POST /api/v0/apiKeys
- SDK Function Call: await BitBadgesApi.createApiKey(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:3599

createApplication

createApplication(
payload: iCreateApplicationPayload,
): Promise<CreateApplicationSuccessResponse<T>>
Creates an application.
Parameters
- payload: iCreateApplicationPayload
Returns Promise<CreateApplicationSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/applications
- SDK Function Call: await BitBadgesApi.createApplication(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.createApplication
- Defined in src/api-indexer/BitBadgesApi.ts:1648

createAttestation

createAttestation(
payload: iCreateAttestationPayload,
): Promise<CreateAttestationSuccessResponse>
Creates an off-chain attestation signature (typically a credential).
Parameters
- payload: iCreateAttestationPayload
Returns Promise<CreateAttestationSuccessResponse>
Remarks
- API Route: POST /api/v0/attestations
- SDK Function Call: await BitBadgesApi.createAttestation(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.createAttestation
- Defined in src/api-indexer/BitBadgesApi.ts:1243

createClaims

createClaims(payload: iCreateClaimPayload): Promise<CreateClaimSuccessResponse>
Creates a claim.
Parameters
- payload: iCreateClaimPayload
Returns Promise<CreateClaimSuccessResponse>
Remarks
- API Route: POST /api/v0/claims
- SDK Function Call: await BitBadgesApi.createClaim(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.createClaims
- Defined in src/api-indexer/BitBadgesApi.ts:1345

createDeveloperApp

createDeveloperApp(
payload: iCreateDeveloperAppPayload,
): Promise<CreateDeveloperAppSuccessResponse>
Creates an developer app.
Parameters
- payload: iCreateDeveloperAppPayload
Returns Promise<CreateDeveloperAppSuccessResponse>
Remarks
- API Route: POST /api/v0/developerApps
- SDK Function Call: await BitBadgesApi.createDeveloperApp(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.createDeveloperApp
- Defined in src/api-indexer/BitBadgesApi.ts:3011

createDynamicDataStore

createDynamicDataStore<Q extends DynamicDataHandlerType, NumberType>(
payload: iCreateDynamicDataStorePayload,
): Promise<CreateDynamicDataStoreSuccessResponse<Q, T>>
Creates a dynamic data bin.
Type Parameters
- Q extends DynamicDataHandlerType
- NumberType
Parameters
- payload: iCreateDynamicDataStorePayload
Returns Promise<CreateDynamicDataStoreSuccessResponse<Q, T>>
Remarks
- API Route: POST /api/v0/dynamicStores
- SDK Function Call: await BitBadgesApi.createDynamicDataStore(payload);
Inherited from BitBadgesAPI.createDynamicDataStore
- Defined in src/api-indexer/BitBadgesApi.ts:3088

createPaymentIntent

createPaymentIntent(
payload: iCreatePaymentIntentPayload,
): Promise<CreatePaymentIntentSuccessResponse>
Creates a payment intent for the user to pay.
Parameters
- payload: iCreatePaymentIntentPayload
Returns Promise<CreatePaymentIntentSuccessResponse>
Remarks
- API Route: POST /api/v0/createPaymentIntent
- SDK Function Call: await BitBadgesApi.createPaymentIntent(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:3562

createPlugin

createPlugin(
payload: iCreatePluginPayload,
): Promise<CreatePluginSuccessResponse>
Creates a plugin.
Parameters
- payload: iCreatePluginPayload
Returns Promise<CreatePluginSuccessResponse>
Remarks
- API Route: POST /api/v0/plugins
- SDK Function Call: await BitBadgesApi.createPlugin(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:3351

createSIWBBRequest

createSIWBBRequest(
payload?: iCreateSIWBBRequestPayload,
): Promise<CreateSIWBBRequestSuccessResponse>
Creates a SIWBB request.
Parameters
- Optionalpayload: iCreateSIWBBRequestPayload
Returns Promise<CreateSIWBBRequestSuccessResponse>
Remarks
- API Route: POST /api/v0/siwbbRequest
- SDK Function Call: await BitBadgesApi.createSIWBBRequest(payload);
Inherited from BitBadgesAPI.createSIWBBRequest
- Defined in src/api-indexer/BitBadgesApi.ts:952

createUtilityListing

createUtilityListing(
payload: iCreateUtilityListingPayload<T>,
): Promise<CreateUtilityListingSuccessResponse<T>>
Creates a utility listing.
Parameters
- payload: iCreateUtilityListingPayload<T>
Returns Promise<CreateUtilityListingSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/utilityListings
- SDK Function Call: await BitBadgesApi.createUtilityListing(payload);
Inherited from BitBadgesAPI.createUtilityListing
- Defined in src/api-indexer/BitBadgesApi.ts:1809

deleteAddressLists

deleteAddressLists(
payload: iDeleteAddressListsPayload,
): Promise<DeleteAddressListsSuccessResponse>
Deletes address lists. Must be created off-chain.
Parameters
- payload: iDeleteAddressListsPayload
Returns Promise<DeleteAddressListsSuccessResponse>
Remarks
- API Route: DELETE /api/v0/addressLists
- SDK Function Call: await BitBadgesApi.deleteAddressLists(payload);
- Authentication: Must be signed in and the creator of the address list.
Inherited from BitBadgesAPI.deleteAddressLists
- Defined in src/api-indexer/BitBadgesApi.ts:883

deleteApiKey

deleteApiKey(
payload: iDeleteApiKeyPayload,
): Promise<DeleteApiKeySuccessResponse>
Deletes an API key.
Parameters
- payload: iDeleteApiKeyPayload
Returns Promise<DeleteApiKeySuccessResponse>
Remarks
- API Route: DELETE /api/v0/apiKeys
- SDK Function Call: await BitBadgesApi.deleteApiKey(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:3633

deleteApplication

deleteApplication(
payload: iDeleteApplicationPayload,
): Promise<DeleteApplicationSuccessResponse>
Deletes an application.
Parameters
- payload: iDeleteApplicationPayload
Returns Promise<DeleteApplicationSuccessResponse>
Remarks
- API Route: DELETE /api/v0/applications
- SDK Function Call: await BitBadgesApi.deleteApplication(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.deleteApplication
- Defined in src/api-indexer/BitBadgesApi.ts:1700

deleteAttestation

deleteAttestation(
payload: iDeleteAttestationPayload,
): Promise<DeleteAttestationSuccessResponse>
Deletes an off-chain attestation signature (typically a credential).
Parameters
- payload: iDeleteAttestationPayload
Returns Promise<DeleteAttestationSuccessResponse>
Remarks
- API Route: DELETE /api/v0/attestations
- SDK Function Call: await BitBadgesApi.deleteAttestation(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.deleteAttestation
- Defined in src/api-indexer/BitBadgesApi.ts:1269

deleteClaims

deleteClaims(payload: iDeleteClaimPayload): Promise<DeleteClaimSuccessResponse>
Deletes a claim.
Parameters
- payload: iDeleteClaimPayload
Returns Promise<DeleteClaimSuccessResponse>
Remarks
- API Route: DELETE /api/v0/claims
- SDK Function Call: await BitBadgesApi.deleteClaim(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.deleteClaims
- Defined in src/api-indexer/BitBadgesApi.ts:1368

deleteConnectedAccount

deleteConnectedAccount(
accountId: string,
): Promise<DeleteConnectedAccountSuccessResponse>
Deletes a connected Stripe account.
Parameters
- accountId: string
Returns Promise<DeleteConnectedAccountSuccessResponse>
Remarks
- API Route: DELETE /api/v0/stripe/connected-accounts/:accountId
- SDK Function Call: await BitBadgesApi.deleteConnectedAccount(accountId);
- Defined in src/api-indexer/BitBadgesApi.ts:3725

deleteDeveloperApp

deleteDeveloperApp(
payload: iDeleteDeveloperAppPayload,
): Promise<DeleteDeveloperAppSuccessResponse>
Deletes an developer app.
Parameters
- payload: iDeleteDeveloperAppPayload
Returns Promise<DeleteDeveloperAppSuccessResponse>
Remarks
- API Route: DELETE /api/v0/developerApps
- SDK Function Call: await BitBadgesApi.deleteDeveloperApp(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.deleteDeveloperApp
- Defined in src/api-indexer/BitBadgesApi.ts:3037

deleteDynamicDataStore

deleteDynamicDataStore(
payload: iDeleteDynamicDataStorePayload,
): Promise<DeleteDynamicDataStoreSuccessResponse>
Deletes a dynamic data bin.
Parameters
- payload: iDeleteDynamicDataStorePayload
Returns Promise<DeleteDynamicDataStoreSuccessResponse>
Remarks
- API Route: DELETE /api/v0/dynamicStores
- SDK Function Call: await BitBadgesApi.deleteDynamicDataStore(payload);
Inherited from BitBadgesAPI.deleteDynamicDataStore
- Defined in src/api-indexer/BitBadgesApi.ts:3142

deletePlugin

deletePlugin(
payload: iDeletePluginPayload,
): Promise<DeletePluginSuccessResponse>
Deletes a plugin.
Parameters
- payload: iDeletePluginPayload
Returns Promise<DeletePluginSuccessResponse>
Remarks
- API Route: DELETE /api/v0/plugins
- SDK Function Call: await BitBadgesApi.deletePlugin(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:3397

deleteSIWBBRequest

deleteSIWBBRequest(
payload?: iDeleteSIWBBRequestPayload,
): Promise<DeleteSIWBBRequestSuccessResponse>
Deletes a SIWBB request.
Parameters
- Optionalpayload: iDeleteSIWBBRequestPayload
Returns Promise<DeleteSIWBBRequestSuccessResponse>
Remarks
- API Route: DELETE /api/v0/siwbbRequest
- SDK Function Call: await BitBadgesApi.deleteSIWBBRequest(payload);
- Authentication: Must be signed in and the owner of the requesy.
Inherited from BitBadgesAPI.deleteSIWBBRequest
- Defined in src/api-indexer/BitBadgesApi.ts:1003

deleteUtilityListing

deleteUtilityListing(
payload: iDeleteUtilityListingPayload,
): Promise<DeleteUtilityListingSuccessResponse>
Deletes a utility listing.
Parameters
- payload: iDeleteUtilityListingPayload
Returns Promise<DeleteUtilityListingSuccessResponse>
Remarks
- API Route: DELETE /api/v0/utilityListings
- SDK Function Call: await BitBadgesApi.deleteUtilityListing(payload);
Inherited from BitBadgesAPI.deleteUtilityListing
- Defined in src/api-indexer/BitBadgesApi.ts:1849

exchangeSIWBBAuthorizationCode

exchangeSIWBBAuthorizationCode(
payload?: iExchangeSIWBBAuthorizationCodePayload,
): Promise<ExchangeSIWBBAuthorizationCodeSuccessResponse<T>>
Gets and verifies a SIWBB request.
Parameters
- Optionalpayload: iExchangeSIWBBAuthorizationCodePayload
Returns Promise<ExchangeSIWBBAuthorizationCodeSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/siwbbRequest
- SDK Function Call: await BitBadgesApi.exchangeSIWBBAuthorizationCode(payload);
Inherited from BitBadgesAPI.exchangeSIWBBAuthorizationCode
- Defined in src/api-indexer/BitBadgesApi.ts:894

fetchMetadataDirectly

fetchMetadataDirectly(
payload: iFetchMetadataDirectlyPayload,
): Promise<FetchMetadataDirectlySuccessResponse<T>>
Fetches arbitrary metadata directly from IPFS. This is useful for fetching metadata that is not stored on-chain.
Parameters
- payload: iFetchMetadataDirectlyPayload
Returns Promise<FetchMetadataDirectlySuccessResponse<T>>
Remarks
- API Route: POST /api/v0/metadata
- SDK Function Call: await BitBadgesApi.fetchMetadataDirectly(payload);
- CORS: Restricted to only BitBadges official site.
- Defined in src/api-indexer/BitBadgesApi.ts:3446

filterBadgesInCollection

filterBadgesInCollection(
collectionId: T,
payload: iFilterBadgesInCollectionPayload,
): Promise<FilterBadgesInCollectionSuccessResponse<T>>
Filters badges in a collection based on multiple filter values.
Parameters
- collectionId: T
- payload: iFilterBadgesInCollectionPayload
Returns Promise<FilterBadgesInCollectionSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collection/:collectionId/filter
- SDK Function Call: await BitBadgesApi.filterBadgesInCollection(payload);
Inherited from BitBadgesAPI.filterBadgesInCollection
- Defined in src/api-indexer/BitBadgesApi.ts:1151

filterSuggestions

filterSuggestions(
collectionId: T,
payload?: iFilterSuggestionsPayload,
): Promise<FilterSuggestionsSuccessResponse>
Gets the filter suggestions based on attributes in a collection.
Parameters
- collectionId: T
- Optionalpayload: iFilterSuggestionsPayload
Returns Promise<FilterSuggestionsSuccessResponse>
Remarks
- API Route: POST /api/v0/collection/:collectionId/filterSuggestions
- SDK Function Call: await BitBadgesApi.filterSuggestions(collectionId, payload);
- Defined in src/api-indexer/BitBadgesApi.ts:3862

generateAppleWalletPass

generateAppleWalletPass(
payload: iGenerateAppleWalletPassPayload,
): Promise<GenerateAppleWalletPassSuccessResponse>
Generates an Apple wallet pass for a code.

Returns application/vnd.apple.pkpass content type.
Parameters
- payload: iGenerateAppleWalletPassPayload
Returns Promise<GenerateAppleWalletPassSuccessResponse>
Remarks
- API Route: POST /api/v0/siwbbRequest/appleWalletPass
- SDK Function Call: await BitBadgesApi.generateAppleWalletPass(payload);
Example
```
const res = await BitBadgesApi.generateAppleWalletPass(payload);
console.log(res);
```
Example
```
const pass = Buffer.from(res.data);

const blob = new Blob([pass], { type: 'application/vnd.apple.pkpass' });
const url = window.URL.createObjectURL(blob);
if (url) {
   const link = document.createElement('a');
   link.href = url;
   link.download = 'bitbadges.pkpass';
   link.click()
}
```
Inherited from BitBadgesAPI.generateAppleWalletPass
- Defined in src/api-indexer/BitBadgesApi.ts:2960

generateGoogleWallet

generateGoogleWallet(
payload: iGenerateGoogleWalletPayload,
): Promise<GenerateGoogleWalletSuccessResponse>
Generates an Google wallet pass for a code. Returns a saveUrl to be opened.
Parameters
- payload: iGenerateGoogleWalletPayload
Returns Promise<GenerateGoogleWalletSuccessResponse>
Remarks
- API Route: POST /api/v0/siwbbRequest/googleWalletPass
- SDK Function Call: await BitBadgesApi.generateGoogleWallet(payload);
Example
```
const res = await BitBadgesApi.generateGoogleWallet(payload);
console.log(res);
```
Inherited from BitBadgesAPI.generateGoogleWallet
- Defined in src/api-indexer/BitBadgesApi.ts:2913

getAccount

getAccount(payload: iGetAccountPayload): Promise<GetAccountSuccessResponse<T>>
Gets an account by address or username.
Parameters
- payload: iGetAccountPayload
Returns Promise<GetAccountSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/user
- SDK Function Call: await BitBadgesApi.getAccount({ address: '...', username: '...' });
Example
```
const res = await BitBadgesApi.getAccount({ address: '...', username: '...' });
console.log(res);
```
Inherited from BitBadgesAPI.getAccount
- Defined in src/api-indexer/BitBadgesApi.ts:745

getAccounts

getAccounts(
payload: iGetAccountsPayload,
): Promise<GetAccountsSuccessResponse<T>>
Gets accounts and accompying details.
Parameters
- payload: iGetAccountsPayload
Returns Promise<GetAccountsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/users
- SDK Function Call: await BitBadgesApi.getAccounts(payload);
- Tutorial: See the Fetching Accounts tutoral on the official docs.
- Authentication: Must be signed in, if fetching private information such as private lists or auth codes. If fetching public information only, no sign in required.
Example
```
const res = await BitBadgesApi.getAccounts([{ address }]);
console.log(res);
```
Note
This function is used to fetch accounts and their details. It is your responsibility to join the data together (paginations, etc). Use getAccountsAndUpdate for a more convenient way to handle paginations and appending metadata.
Inherited from BitBadgesAPI.getAccounts
- Defined in src/api-indexer/BitBadgesApi.ts:728

getActiveAuthorizations

getActiveAuthorizations(
payload?: iGetActiveAuthorizationsPayload,
): Promise<GetActiveAuthorizationsSuccessResponse<T>>
Gets all active authorizations for a user.
Parameters
- Optionalpayload: iGetActiveAuthorizationsPayload
Returns Promise<GetActiveAuthorizationsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/oauth/authorizations
- SDK Function Call: await BitBadgesApi.getActiveAuthorizations(payload);
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.getActiveAuthorizations(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:3325

getAddressList

getAddressList(
addressListId: string,
payload?: iGetAddressListPayload,
): Promise<GetAddressListSuccessResponse<T>>
Get an address list by ID.
Parameters
- addressListId: string
- Optionalpayload: iGetAddressListPayload
Returns Promise<GetAddressListSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/addressList/:addressListId
- SDK Function Call: await BitBadgesApi.getAddressList(addressListId, { ... });
Example
```
const res = await BitBadgesApi.getAddressList("list123", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getAddressList
- Defined in src/api-indexer/BitBadgesApi.ts:2618

getAddressListActivity

getAddressListActivity(
addressListId: string,
payload: iGetAddressListActivityPayload,
): Promise<GetAddressListActivitySuccessResponse<T>>
Gets activity for a specific address list.
Parameters
- addressListId: string
- payload: iGetAddressListActivityPayload
Returns Promise<GetAddressListActivitySuccessResponse<T>>
Remarks
- API Route: GET /api/v0/addressLists/:addressListId/activity
- SDK Function Call: await BitBadgesApi.getAddressListActivity(addressListId, { ... });
Example
```
const res = await BitBadgesApi.getAddressListActivity("list123", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getAddressListActivity
- Defined in src/api-indexer/BitBadgesApi.ts:2238

getAddressListClaims

getAddressListClaims(
addressListId: string,
): Promise<GetAddressListClaimsSuccessResponse<T>>
Gets claims for a specific address list.
Parameters
- addressListId: string
Returns Promise<GetAddressListClaimsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/addressLists/:addressListId/claims
- SDK Function Call: await BitBadgesApi.getAddressListClaims(addressListId);
Example
```
const res = await BitBadgesApi.getAddressListClaims("list123");
console.log(res);
```
Inherited from BitBadgesAPI.getAddressListClaims
- Defined in src/api-indexer/BitBadgesApi.ts:2563

getAddressListListings

getAddressListListings(
addressListId: string,
payload: iGetAddressListListingsPayload,
): Promise<GetAddressListListingsSuccessResponse<T>>
Gets listings for a specific address list.
Parameters
- addressListId: string
- payload: iGetAddressListListingsPayload
Returns Promise<GetAddressListListingsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/addressLists/:addressListId/listings
- SDK Function Call: await BitBadgesApi.getAddressListListings(addressListId, { bookmark });
Example
```
const res = await BitBadgesApi.getAddressListListings("list123", { bookmark: "123" });
console.log(res);
```
Inherited from BitBadgesAPI.getAddressListListings
- Defined in src/api-indexer/BitBadgesApi.ts:2274

getAddressLists

getAddressLists(
payload: iGetAddressListsPayload,
): Promise<GetAddressListsSuccessResponse<T>>
Gets address lists. Can be on-chain or off-chain.
Parameters
- payload: iGetAddressListsPayload
Returns Promise<GetAddressListsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/addressLists
- SDK Function Call: await BitBadgesApi.getAddressLists(payload);
Note for reserved lists, you can use getReservedAddressList from the SDK.
Inherited from BitBadgesAPI.getAddressLists
- Defined in src/api-indexer/BitBadgesApi.ts:871

getAddressListsForUser

getAddressListsForUser(
address: string,
payload: iGetAddressListsForUserPayload,
): Promise<GetAddressListsForUserSuccessResponse<T>>
Get address lists for a specific account. Specify the viewType to determine what address lists to retrieve.
Parameters
- address: string
- payload: iGetAddressListsForUserPayload
Returns Promise<GetAddressListsForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/lists
- SDK Function Call: await BitBadgesApi.getAddressListsForUser(address, { viewType });
Example
```
const res = await BitBadgesApi.getAddressListsForUser("bb1...", { viewType: "all" });
console.log(res);
```
Inherited from BitBadgesAPI.getAddressListsForUser
- Defined in src/api-indexer/BitBadgesApi.ts:1920

getApiKeys

getApiKeys(payload: iGetApiKeysPayload): Promise<GetApiKeysSuccessResponse>
Gets the API keys.
Parameters
- payload: iGetApiKeysPayload
Returns Promise<GetApiKeysSuccessResponse>
Remarks
- API Route: POST /api/v0/apiKeys/fetch
- SDK Function Call: await BitBadgesApi.getApiKeys();
- Defined in src/api-indexer/BitBadgesApi.ts:3582

getApplication

getApplication(
applicationId: string,
payload?: iGetApplicationPayload,
): Promise<GetApplicationSuccessResponse<T>>
Get an application by ID.
Parameters
- applicationId: string
- Optionalpayload: iGetApplicationPayload
Returns Promise<GetApplicationSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/application/:applicationId
- SDK Function Call: await BitBadgesApi.getApplication(applicationId, { ... });
Example
```
const res = await BitBadgesApi.getApplication("app123", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getApplication
- Defined in src/api-indexer/BitBadgesApi.ts:2649

getApplications

getApplications(
payload: iGetApplicationsPayload,
): Promise<GetApplicationsSuccessResponse<T>>
Gets applications.
Parameters
- payload: iGetApplicationsPayload
Returns Promise<GetApplicationsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/applications/fetch
- SDK Function Call: await BitBadgesApi.getApplications(payload);
Inherited from BitBadgesAPI.getApplications
- Defined in src/api-indexer/BitBadgesApi.ts:1597

getAttemptDataFromRequestBin

getAttemptDataFromRequestBin(
    claimId: string,
    claimAttemptId: string,
    payload?: iGetAttemptDataFromRequestBinPayload,
): Promise<GetAttemptDataFromRequestBinSuccessResponse>
Gets the attempt data for a specific claim attempt from the request bin plugin.
Parameters
- claimId: string
- claimAttemptId: string
- Optionalpayload: iGetAttemptDataFromRequestBinPayload
Returns Promise<GetAttemptDataFromRequestBinSuccessResponse>
Remarks
- API Route: GET /api/v0/requestBin/attemptData/{claimId}/{claimAttemptId}
- SDK Function Call: await BitBadgesApi.getAttemptDataFromRequestBin(claimId, claimAttemptId, payload);
Inherited from BitBadgesAPI.getAttemptDataFromRequestBin
- Defined in src/api-indexer/BitBadgesApi.ts:3261

getAttestation

getAttestation(
attestationId: string,
payload?: iGetAttestationPayload,
): Promise<GetAttestationSuccessResponse<T>>
Get attestation by ID.
Parameters
- attestationId: string
- Optionalpayload: iGetAttestationPayload
Returns Promise<GetAttestationSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/attestation/:attestationId
- SDK Function Call: await BitBadgesApi.getAttestation(attestationId, { ... });
Example
```
const res = await BitBadgesApi.getAttestation("attestation123", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getAttestation
- Defined in src/api-indexer/BitBadgesApi.ts:2829

getAttestations

getAttestations(
payload: iGetAttestationsPayload,
): Promise<GetAttestationsSuccessResponse<T>>
Get an off-chain attestation signature (typically a credential).
Parameters
- payload: iGetAttestationsPayload
Returns Promise<GetAttestationsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/attestations
- SDK Function Call: await BitBadgesApi.getAttestations(payload);
Inherited from BitBadgesAPI.getAttestations
- Defined in src/api-indexer/BitBadgesApi.ts:1217

getAttestationsForUser

getAttestationsForUser(
address: string,
payload: iGetAttestationsForUserPayload,
): Promise<GetAttestationsForUserSuccessResponse<T>>
Gets attestations by type for a specific user. Specify the viewType to determine what attestations to retrieve.
Parameters
- address: string
- payload: iGetAttestationsForUserPayload
Returns Promise<GetAttestationsForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/attestations
- SDK Function Call: await BitBadgesApi.getAttestationsForUser(address, { viewType });
Example
```
const res = await BitBadgesApi.getAttestationsForUser("bb1...", { viewType: "received" });
console.log(res);
```
Inherited from BitBadgesAPI.getAttestationsForUser
- Defined in src/api-indexer/BitBadgesApi.ts:2100

getBadgeActivity

getBadgeActivity(
    collectionId: NumberType,
    badgeId: NumberType,
    payload: iGetBadgeActivityPayload,
): Promise<GetBadgeActivitySuccessResponse<T>>
Gets the activity for a specific badge in a collection
Parameters
- collectionId: NumberType
- badgeId: NumberType
- payload: iGetBadgeActivityPayload
Returns Promise<GetBadgeActivitySuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/:badgeId/activity
- SDK Function Call: await BitBadgesApi.getBadgeActivity(collectionId, badgeId, payload);
Example
```
const res = await BitBadgesApi.getBadgeActivity(collectionId, badgeId, { bookmark: 'prev' });
console.log(res);
```
Inherited from BitBadgesAPI.getBadgeActivity
- Defined in src/api-indexer/BitBadgesApi.ts:537

getBadgeBalanceByAddress

getBadgeBalanceByAddress(
    collectionId: NumberType,
    address: string,
    payload?: iGetBadgeBalanceByAddressPayload,
): Promise<GetBadgeBalanceByAddressSuccessResponse<T>>
Gets the balance of a specific badge for a specific address
Parameters
- collectionId: NumberType
- address: string
- Optionalpayload: iGetBadgeBalanceByAddressPayload
Returns Promise<GetBadgeBalanceByAddressSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collection/:collectionId/balance/:address
- SDK Function Call: await BitBadgesApi.getBadgeBalanceByAddress(collectionId, address);
Example
```
const res = await BitBadgesApi.getBadgeBalanceByAddress(collectionId, address);
console.log(res);
```
Inherited from BitBadgesAPI.getBadgeBalanceByAddress
- Defined in src/api-indexer/BitBadgesApi.ts:480

getBadgeBalanceByAddressSpecificBadge

getBadgeBalanceByAddressSpecificBadge(
    collectionId: NumberType,
    badgeId: NumberType,
    address: string,
    payload?: iGetBadgeBalanceByAddressPayload,
): Promise<GetBadgeBalanceByAddressSuccessResponse<T>>
Gets the badge balance for an address at the current time. This is a streamlined version of getBadgeBalanceByAddress.
Parameters
- collectionId: NumberType
- badgeId: NumberType
- address: string
- Optionalpayload: iGetBadgeBalanceByAddressPayload
Returns Promise<GetBadgeBalanceByAddressSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/:badgeId/balance/:address
- SDK Function Call: await BitBadgesApi.getBadgeBalanceByAddress(collectionId, badgeId, address);
Example
```
const res = await BitBadgesApi.getBadgeBalanceByAddress(collectionId, badgeId, address);
console.log(res);
```
Inherited from BitBadgesAPI.getBadgeBalanceByAddressSpecificBadge
- Defined in src/api-indexer/BitBadgesApi.ts:502

getBadgeMetadata

getBadgeMetadata(
collectionId: NumberType,
badgeId: NumberType,
): Promise<GetBadgeMetadataSuccessResponse<T>>
Gets current metadata for a specific badge in a collection.
Parameters
- collectionId: NumberType
- badgeId: NumberType
Returns Promise<GetBadgeMetadataSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/:badgeId/metadata
- SDK Function Call: await BitBadgesApi.getBadgeMetadata(collectionId, badgeId);
Example
```
const res = await BitBadgesApi.getBadgeMetadata("123", "456");
console.log(res);
```
Inherited from BitBadgesAPI.getBadgeMetadata
- Defined in src/api-indexer/BitBadgesApi.ts:2369

getBadgesViewForUser

getBadgesViewForUser(
address: string,
payload: iGetBadgesViewForUserPayload,
): Promise<GetBadgesViewForUserSuccessResponse<T>>
Gets badges for a specific user. Specify the viewType to determine what badges to retrieve.
Parameters
- address: string
- payload: iGetBadgesViewForUserPayload
Returns Promise<GetBadgesViewForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/badges
- SDK Function Call: await BitBadgesApi.getBadgesViewForUser(address, { viewType });
Example
```
const res = await BitBadgesApi.getBadgesViewForUser("bb1...", { viewType: "collected" });
console.log(res);
```
Inherited from BitBadgesAPI.getBadgesViewForUser
- Defined in src/api-indexer/BitBadgesApi.ts:2030

getBrowse

getBrowse(payload: iGetBrowsePayload): Promise<GetBrowseSuccessResponse<T>>
Gets details for a browse / explore page.
Parameters
- payload: iGetBrowsePayload
Returns Promise<GetBrowseSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/browse
- SDK Function Call: await BitBadgesApi.GetBrowse(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:3887

getClaim

getClaim(
claimId: string,
payload?: iGetClaimPayload,
): Promise<GetClaimSuccessResponse<T>>
Get a claim by ID.
Parameters
- claimId: string
- Optionalpayload: iGetClaimPayload
Returns Promise<GetClaimSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/claim/:claimId
- SDK Function Call: await BitBadgesApi.getClaim(claimId, { ... });
Example
```
const res = await BitBadgesApi.getClaim("123", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getClaim
- Defined in src/api-indexer/BitBadgesApi.ts:2588

getClaimActivityForUser

getClaimActivityForUser(
address: string,
payload: iGetClaimActivityForUserPayload,
): Promise<GetClaimActivityForUserSuccessResponse<T>>
Gets claim activity by type for a specific user. Specify the viewType to determine what claim activity to retrieve.
Parameters
- address: string
- payload: iGetClaimActivityForUserPayload
Returns Promise<GetClaimActivityForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/activity/claims
- SDK Function Call: await BitBadgesApi.getClaimActivityForUser(address, { viewType });
Example
```
const res = await BitBadgesApi.getClaimActivityForUser("bb1...", { viewType: "public" });
console.log(res);
```
Inherited from BitBadgesAPI.getClaimActivityForUser
- Defined in src/api-indexer/BitBadgesApi.ts:2135

getClaimAlertsForUser

getClaimAlertsForUser(
address: string,
payload: iGetClaimAlertsForUserPayload,
): Promise<GetClaimAlertsForUserSuccessResponse<T>>
Gets claim alerts for a specific user. Specify viewType 'received' or 'sent' to determine what claim alerts to retrieve.
Parameters
- address: string
- payload: iGetClaimAlertsForUserPayload
Returns Promise<GetClaimAlertsForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/claimAlerts
- SDK Function Call: await BitBadgesApi.getClaimAlertsForUser(address, { viewType: 'received' });
Example
```
const res = await BitBadgesApi.getClaimAlertsForUser("bb1...", { viewType: 'received' });
console.log(res);
```
Inherited from BitBadgesAPI.getClaimAlertsForUser
- Defined in src/api-indexer/BitBadgesApi.ts:2204

getClaimAttempts

getClaimAttempts(
claimId: string,
payload: iGetClaimAttemptsPayload,
): Promise<GetClaimAttemptsSuccessResponse<T>>
Gets claim attempts.
Parameters
- claimId: string
- payload: iGetClaimAttemptsPayload
Returns Promise<GetClaimAttemptsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/claims/:claimId/attempts
- SDK Function Call: await BitBadgesApi.getClaimAttempts(claimId, payload);
Inherited from BitBadgesAPI.getClaimAttempts
- Defined in src/api-indexer/BitBadgesApi.ts:1869

getClaimAttemptStatus

getClaimAttemptStatus(
claimAttemptId: string,
): Promise<GetClaimAttemptStatusSuccessResponse>
Gets the status of a claim attempt.
Parameters
- claimAttemptId: string
Returns Promise<GetClaimAttemptStatusSuccessResponse>
Remarks
- API Route: POST /api/v0/claims/status/:claimId
- SDK Function Call: await BitBadgesApi.getClaimAttemptStatus(claimAttemptId);
Example
```
const res = await BitBadgesApi.getClaimAttemptStatus(claimAttemptId);
console.log(res);
```
Inherited from BitBadgesAPI.getClaimAttemptStatus
- Defined in src/api-indexer/BitBadgesApi.ts:692

getClaims

getClaims(payload: iGetClaimsPayloadV1): Promise<GetClaimsSuccessResponse<T>>
Gets the claim by ID.
Parameters
- payload: iGetClaimsPayloadV1
Returns Promise<GetClaimsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/claims
- SDK Function Call: await BitBadgesApi.getClaims(payload);
Example
```
const res = await BitBadgesApi.getClaims(payload);
console.log(res);
```
Inherited from BitBadgesAPI.getClaims
- Defined in src/api-indexer/BitBadgesApi.ts:1171

getCollection

getCollection(
collectionId: NumberType,
payload?: iGetCollectionPayload,
): Promise<GetCollectionSuccessResponse<T>>
Gets a specific collection.
Parameters
- collectionId: NumberType
- Optionalpayload: iGetCollectionPayload
Returns Promise<GetCollectionSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId
- SDK Function Call: await BitBadgesApi.getCollection(collectionId);
Example
```
const res = await BitBadgesApi.getCollection("123");
console.log(res);
```
Inherited from BitBadgesAPI.getCollection
- Defined in src/api-indexer/BitBadgesApi.ts:2343

getCollectionAmountTrackerById

getCollectionAmountTrackerById<T extends NumberType>(
trackerDetails: iAmountTrackerIdDetails<T>,
): Promise<GetCollectionAmountTrackerByIdSuccessResponse<T>>
Gets a specific amount tracker by ID for a collection
Type Parameters
- T extends NumberType
Parameters
- trackerDetails: iAmountTrackerIdDetails<T>
Returns Promise<GetCollectionAmountTrackerByIdSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/amountTracker
- SDK Function Call: await BitBadgesApi.getCollectionAmountTrackerById(...);
Inherited from BitBadgesAPI.getCollectionAmountTrackerById
- Defined in src/api-indexer/BitBadgesApi.ts:3217

getCollectionAmountTrackers

getCollectionAmountTrackers(
collectionId: NumberType,
payload: iGetCollectionAmountTrackersPayload,
): Promise<GetCollectionAmountTrackersSuccessResponse<T>>
Gets amount trackers for a specific collection.
Parameters
- collectionId: NumberType
- payload: iGetCollectionAmountTrackersPayload
Returns Promise<GetCollectionAmountTrackersSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/amountTrackers
- SDK Function Call: await BitBadgesApi.getCollectionAmountTrackers(collectionId, { bookmark });
Example
```
const res = await BitBadgesApi.getCollectionAmountTrackers("123", { bookmark: "123" });
console.log(res);
```
Inherited from BitBadgesAPI.getCollectionAmountTrackers
- Defined in src/api-indexer/BitBadgesApi.ts:2466

getCollectionChallengeTrackerById

getCollectionChallengeTrackerById<T extends NumberType>(
trackerDetails: iChallengeTrackerIdDetails<T>,
): Promise<GetCollectionChallengeTrackerByIdSuccessResponse<T>>
Gets a specific challenge tracker by ID for a collection
Type Parameters
- T extends NumberType
Parameters
- trackerDetails: iChallengeTrackerIdDetails<T>
Returns Promise<GetCollectionChallengeTrackerByIdSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/challengeTracker
- SDK Function Call: await BitBadgesApi.getCollectionChallengeTrackerById(...);
Inherited from BitBadgesAPI.getCollectionChallengeTrackerById
- Defined in src/api-indexer/BitBadgesApi.ts:3239

getCollectionChallengeTrackers

getCollectionChallengeTrackers(
collectionId: NumberType,
payload: iGetCollectionChallengeTrackersPayload,
): Promise<GetCollectionChallengeTrackersSuccessResponse<T>>
Gets challenge trackers for a specific collection.
Parameters
- collectionId: NumberType
- payload: iGetCollectionChallengeTrackersPayload
Returns Promise<GetCollectionChallengeTrackersSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/challengeTrackers
- SDK Function Call: await BitBadgesApi.getCollectionChallengeTrackers(collectionId, { bookmark });
Example
```
const res = await BitBadgesApi.getCollectionChallengeTrackers("123", { bookmark: "123" });
console.log(res);
```
Inherited from BitBadgesAPI.getCollectionChallengeTrackers
- Defined in src/api-indexer/BitBadgesApi.ts:2430

getCollectionClaims

getCollectionClaims(
collectionId: NumberType,
): Promise<GetCollectionClaimsSuccessResponse<T>>
Gets claims for a specific collection.
Parameters
- collectionId: NumberType
Returns Promise<GetCollectionClaimsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/claims
- SDK Function Call: await BitBadgesApi.getCollectionClaims(collectionId);
Example
```
const res = await BitBadgesApi.getCollectionClaims("123");
console.log(res);
```
Inherited from BitBadgesAPI.getCollectionClaims
- Defined in src/api-indexer/BitBadgesApi.ts:2538

getCollectionListings

getCollectionListings(
collectionId: NumberType,
payload: iGetCollectionListingsPayload,
): Promise<GetCollectionListingsSuccessResponse<T>>
Gets listings for a specific collection.
Parameters
- collectionId: NumberType
- payload: iGetCollectionListingsPayload
Returns Promise<GetCollectionListingsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/listings
- SDK Function Call: await BitBadgesApi.getCollectionListings(collectionId, { bookmark });
Example
```
const res = await BitBadgesApi.getCollectionListings("123", { bookmark: "123" });
console.log(res);
```
Inherited from BitBadgesAPI.getCollectionListings
- Defined in src/api-indexer/BitBadgesApi.ts:2502

getCollectionOwners

getCollectionOwners(
collectionId: NumberType,
payload: iGetCollectionOwnersPayload,
): Promise<GetCollectionOwnersSuccessResponse<T>>
Gets owners for a specific collection.
Parameters
- collectionId: NumberType
- payload: iGetCollectionOwnersPayload
Returns Promise<GetCollectionOwnersSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/owners
- SDK Function Call: await BitBadgesApi.getCollectionOwners(collectionId, { bookmark });
Example
```
const res = await BitBadgesApi.getCollectionOwners("123", { bookmark: "123" });
console.log(res);
```
Inherited from BitBadgesAPI.getCollectionOwners
- Defined in src/api-indexer/BitBadgesApi.ts:2310

getCollections

getCollections(
payload: iGetCollectionsPayload,
): Promise<GetCollectionsSuccessResponse<T>>
This function retrieves badge collections and accompanying details. Consider using the getCollectionsAndUpdate function instead for native support in handling paginations, appending metadata, and more.
Parameters
- payload: iGetCollectionsPayload
Returns Promise<GetCollectionsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collections
- Tutorial: Refer to the Fetching Collections tutorial on the official documentation.
Example
```
const res = await BitBadgesApi.getCollections([{ collectionId, metadataToFetch: { badgeIds: [{ start: 1n, end: 10n }] } }]);
const collection = res.collections[0];
```
Inherited from BitBadgesAPI.getCollections
- Defined in src/api-indexer/BitBadgesApi.ts:442

getCollectionTransferActivity

getCollectionTransferActivity(
collectionId: NumberType,
payload: iGetCollectionTransferActivityPayload,
): Promise<GetCollectionTransferActivitySuccessResponse<T>>
Gets transfer activity for a specific collection.
Parameters
- collectionId: NumberType
- payload: iGetCollectionTransferActivityPayload
Returns Promise<GetCollectionTransferActivitySuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/activity
- SDK Function Call: await BitBadgesApi.getCollectionTransferActivity(collectionId, { bookmark });
Example
```
const res = await BitBadgesApi.getCollectionTransferActivity("123", { bookmark: "123" });
console.log(res);
```
Inherited from BitBadgesAPI.getCollectionTransferActivity
- Defined in src/api-indexer/BitBadgesApi.ts:2394

getConnectedAccounts

getConnectedAccounts(): Promise<GetConnectedAccountsSuccessResponse>
Gets all connected Stripe accounts.

Returns Promise<GetConnectedAccountsSuccessResponse>
Remarks
- API Route: GET /api/v0/stripe/connected-accounts
- SDK Function Call: await BitBadgesApi.getConnectedAccounts();
- Defined in src/api-indexer/BitBadgesApi.ts:3706

getDeveloperApp

getDeveloperApp(
developerAppId: string,
payload?: iGetDeveloperAppPayload,
): Promise<GetDeveloperAppSuccessResponse<T>>
Get developer app by ID.
Parameters
- developerAppId: string
- Optionalpayload: iGetDeveloperAppPayload
Returns Promise<GetDeveloperAppSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/developerApp/:developerAppId
- SDK Function Call: await BitBadgesApi.getDeveloperApp(developerAppId, { ... });
Example
```
const res = await BitBadgesApi.getDeveloperApp("developerApp123", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getDeveloperApp
- Defined in src/api-indexer/BitBadgesApi.ts:2860

getDeveloperApps

getDeveloperApps(
payload: iGetDeveloperAppsPayload,
): Promise<GetDeveloperAppsSuccessResponse<T>>
Get all developer apps for a user.
Parameters
- payload: iGetDeveloperAppsPayload
Returns Promise<GetDeveloperAppsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/developerApps
- SDK Function Call: await BitBadgesApi.getDeveloperApp(payload);
Inherited from BitBadgesAPI.getDeveloperApps
- Defined in src/api-indexer/BitBadgesApi.ts:3167

getDynamicDataActivity

getDynamicDataActivity(
payload: iGetDynamicDataActivityPayload,
): Promise<GetDynamicDataActivitySuccessResponse>
Get dynamic data store activity
Parameters
- payload: iGetDynamicDataActivityPayload
Returns Promise<GetDynamicDataActivitySuccessResponse>
Remarks
- API Route: GET /api/v0/dynamicStores/activity
- SDK Function Call: await BitBadgesApi.getDynamicDataActivity(payload);
Inherited from BitBadgesAPI.getDynamicDataActivity
- Defined in src/api-indexer/BitBadgesApi.ts:1523

getDynamicDataStore

getDynamicDataStore<Q extends DynamicDataHandlerType>(
dynamicStoreId: string,
payload?: iGetDynamicDataStorePayload,
): Promise<GetDynamicDataStoreSuccessResponse<Q, T>>
Get a dynamic data store by ID.
Type Parameters
- Q extends DynamicDataHandlerType
Parameters
- dynamicStoreId: string
- Optionalpayload: iGetDynamicDataStorePayload
Returns Promise<GetDynamicDataStoreSuccessResponse<Q, T>>
Remarks
- API Route: GET /api/v0/dynamicStore/:dynamicStoreId
- SDK Function Call: await BitBadgesApi.getDynamicDataStore(dynamicStoreId, { ... });
Example
```
const res = await BitBadgesApi.getDynamicDataStore("store123", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getDynamicDataStore
- Defined in src/api-indexer/BitBadgesApi.ts:2680

getDynamicDataStores

getDynamicDataStores<Q extends DynamicDataHandlerType, NumberType>(
payload: iGetDynamicDataStoresPayload,
): Promise<GetDynamicDataStoresSuccessResponse<Q, T>>
Gets dynamic data stores.
Type Parameters
- Q extends DynamicDataHandlerType
- NumberType
Parameters
- payload: iGetDynamicDataStoresPayload
Returns Promise<GetDynamicDataStoresSuccessResponse<Q, T>>
Remarks
- API Route: POST /api/v0/dynamicStores/fetch
- SDK Function Call: await BitBadgesApi.getDynamicDataStores(payload);
Inherited from BitBadgesAPI.getDynamicDataStores
- Defined in src/api-indexer/BitBadgesApi.ts:1543

getDynamicDataStoreValue

getDynamicDataStoreValue(
dynamicStoreId: string,
payload?: iGetDynamicDataStoreValuePayload,
): Promise<GetDynamicDataStoreValueSuccessResponse>
Get a dynamic data store value by ID.
Parameters
- dynamicStoreId: string
- Optionalpayload: iGetDynamicDataStoreValuePayload
Returns Promise<GetDynamicDataStoreValueSuccessResponse>
Remarks
- API Route: GET /api/v0/dynamicStore/:dynamicStoreId/:key
- SDK Function Call: await BitBadgesApi.getDynamicDataStoreValue(dynamicStoreId, { ... });
Inherited from BitBadgesAPI.getDynamicDataStoreValue
- Defined in src/api-indexer/BitBadgesApi.ts:2708

getDynamicDataStoreValuesPaginated

getDynamicDataStoreValuesPaginated<Q extends DynamicDataHandlerType>(
dynamicStoreId: string,
payload?: iGetDynamicDataStoreValuesPaginatedPayload,
): Promise<GetDynamicDataStoreValuesPaginatedSuccessResponse<Q, T>>
Get a dynamic data store values paginated by ID.
Type Parameters
- Q extends DynamicDataHandlerType
Parameters
- dynamicStoreId: string
- Optionalpayload: iGetDynamicDataStoreValuesPaginatedPayload
Returns Promise<GetDynamicDataStoreValuesPaginatedSuccessResponse<Q, T>>
Remarks
- API Route: GET /api/v0/dynamicStore/:dynamicStoreId/values
- SDK Function Call: await BitBadgesApi.getDynamicDataStoreValuesPaginated(dynamicStoreId, { ... });
Inherited from BitBadgesAPI.getDynamicDataStoreValuesPaginated
- Defined in src/api-indexer/BitBadgesApi.ts:2736

getEmbeddedWallet

getEmbeddedWallet(
payload?: iGetOrCreateEmbeddedWalletPayload,
): Promise<GetOrCreateEmbeddedWalletSuccessResponse>
Parameters
- Optionalpayload: iGetOrCreateEmbeddedWalletPayload
Returns Promise<GetOrCreateEmbeddedWalletSuccessResponse>
- Defined in src/api-indexer/BitBadgesApi.ts:3660

getGatedContentForClaim

getGatedContentForClaim(
claimId: string,
payload?: iGetGatedContentForClaimPayload,
): Promise<GetGatedContentForClaimSuccessResponse<T>>
Get the gated content for a claim.
Parameters
- claimId: string
- Optionalpayload: iGetGatedContentForClaimPayload
Returns Promise<GetGatedContentForClaimSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/claims/gatedContent/{claimId}
- SDK Function Call: await BitBadgesApi.getGatedContentForClaim(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.getGatedContentForClaim
- Defined in src/api-indexer/BitBadgesApi.ts:1438

getListActivityForUser

getListActivityForUser(
address: string,
payload: iGetListActivityForUserPayload,
): Promise<GetListActivityForUserSuccessResponse<T>>
Gets lists activity for a specific user.
Parameters
- address: string
- payload: iGetListActivityForUserPayload
Returns Promise<GetListActivityForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/activity/lists
- SDK Function Call: await BitBadgesApi.getListActivityForUser(address, { ... });
Example
```
const res = await BitBadgesApi.getListActivityForUser("bb1...", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getListActivityForUser
- Defined in src/api-indexer/BitBadgesApi.ts:2063

getMap

getMap(
mapId: string,
payload?: iGetMapPayload,
): Promise<GetMapSuccessResponse<T>>
Get map by ID
Parameters
- mapId: string
- Optionalpayload: iGetMapPayload
Returns Promise<GetMapSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/map/{mapId}
- SDK Function Call: await BitBadgesApi.getMap(payload);
Inherited from BitBadgesAPI.getMap
- Defined in src/api-indexer/BitBadgesApi.ts:1088

getMaps

getMaps(payload: iGetMapsPayload): Promise<GetMapsSuccessResponse<T>>
Get maps by ID
Parameters
- payload: iGetMapsPayload
Returns Promise<GetMapsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/maps
- SDK Function Call: await BitBadgesApi.getMaps(payload);
Inherited from BitBadgesAPI.getMaps
- Defined in src/api-indexer/BitBadgesApi.ts:1066

getMapValue

getMapValue(mapId: string, key: string): Promise<GetMapValueSuccessResponse>
Get map value by ID
Parameters
- mapId: string
- key: string
Returns Promise<GetMapValueSuccessResponse>
Remarks
- API Route: GET /api/v0/mapValue/{mapId}/{key}
- SDK Function Call: await BitBadgesApi.getMapValue(mapId, key);
Inherited from BitBadgesAPI.getMapValue
- Defined in src/api-indexer/BitBadgesApi.ts:1134

getMapValues

getMapValues(
payload: iGetMapValuesPayload,
): Promise<GetMapValuesSuccessResponse>
Get map values
Parameters
- payload: iGetMapValuesPayload
Returns Promise<GetMapValuesSuccessResponse>
Remarks
- API Route: POST /api/v0/mapValues
- SDK Function Call: await BitBadgesApi.getMapValues(payload);
Inherited from BitBadgesAPI.getMapValues
- Defined in src/api-indexer/BitBadgesApi.ts:1112

getOwnersForBadge

getOwnersForBadge(
    collectionId: NumberType,
    badgeId: NumberType,
    payload: iGetOwnersForBadgePayload,
): Promise<GetOwnersForBadgeSuccessResponse<T>>
Gets the owners for a specific badge in a collection
Parameters
- collectionId: NumberType
- badgeId: NumberType
- payload: iGetOwnersForBadgePayload
Returns Promise<GetOwnersForBadgeSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/:badgeId/owners
- SDK Function Call: await BitBadgesApi.getOwnersForBadge(collectionId, badgeId, payload);
Example
```
const res = await BitBadgesApi.getOwnersForBadge(collectionId, badgeId, { bookmark: 'prev' });
console.log(res);
```
Inherited from BitBadgesAPI.getOwnersForBadge
- Defined in src/api-indexer/BitBadgesApi.ts:459

getPlugin

getPlugin(
pluginId: string,
payload?: iGetPluginPayload,
): Promise<GetPluginSuccessResponse<T>>
Get plugin by ID.
Parameters
- pluginId: string
- Optionalpayload: iGetPluginPayload
Returns Promise<GetPluginSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/plugin/:pluginId
- SDK Function Call: await BitBadgesApi.getPlugin(pluginId, { ... });
Example
```
const res = await BitBadgesApi.getPlugin("plugin123", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getPlugin
- Defined in src/api-indexer/BitBadgesApi.ts:2772

getPluginErrors

getPluginErrors(
payload: iGetPluginErrorsPayload,
): Promise<GetPluginErrorsSuccessResponse>
Parameters
- payload: iGetPluginErrorsPayload
Returns Promise<GetPluginErrorsSuccessResponse>
- Defined in src/api-indexer/BitBadgesApi.ts:3645

getPlugins

getPlugins(payload: iGetPluginsPayload): Promise<GetPluginsSuccessResponse<T>>
Get all developer apps for a user.
Parameters
- payload: iGetPluginsPayload
Returns Promise<GetPluginsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/plugins
- SDK Function Call: await BitBadgesApi.getPlugins(payload);
Inherited from BitBadgesAPI.getPlugins
- Defined in src/api-indexer/BitBadgesApi.ts:2885

getPointsActivity

getPointsActivity<T extends NumberType>(
payload: iGetPointsActivityPayload,
): Promise<GetPointsActivitySuccessResponse<T>>
Gets points activity for an application.
Type Parameters
- T extends NumberType
Parameters
- payload: iGetPointsActivityPayload
Returns Promise<GetPointsActivitySuccessResponse<T>>
Remarks
- API Route: GET /api/v0/applications/points/activity
- SDK Function Call: await BitBadgesApi.getPointsActivity(payload);
Inherited from BitBadgesAPI.getPointsActivity
- Defined in src/api-indexer/BitBadgesApi.ts:1744

getPointsActivityForUser

getPointsActivityForUser(
address: string,
payload: iGetPointsActivityForUserPayload,
): Promise<GetPointsActivityForUserSuccessResponse<T>>
Gets points activity for a specific user.
Parameters
- address: string
- payload: iGetPointsActivityForUserPayload
Returns Promise<GetPointsActivityForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/activity/points
- SDK Function Call: await BitBadgesApi.getPointsActivityForUser(address, { ... });
Example
```
const res = await BitBadgesApi.getPointsActivityForUser("bb1...", { ... });
console.log(res);
```
Inherited from BitBadgesAPI.getPointsActivityForUser
- Defined in src/api-indexer/BitBadgesApi.ts:2169

getRefreshStatus

getRefreshStatus(
collectionId: NumberType,
): Promise<RefreshStatusSuccessResponse<NumberType>>
Gets the refresh status for a collection. Used to track if any errors occur during a refresh, or if it is in the queue or not.
Parameters
- collectionId: NumberType
Returns Promise<RefreshStatusSuccessResponse<NumberType>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/refreshStatus
- SDK Function Call: await BitBadgesApi.getRefreshStatus(payload);
Inherited from BitBadgesAPI.getRefreshStatus
- Defined in src/api-indexer/BitBadgesApi.ts:1055

getReservedClaimCodes

getReservedClaimCodes(
    claimId: string,
    address: string,
    payload: iGetReservedClaimCodesPayload,
): Promise<GetReservedClaimCodesSuccessResponse>
For on-chain claims where codes are "reserved" for a specific address, this function will return all codes reserved.
Parameters
- claimId: string
- address: string
- payload: iGetReservedClaimCodesPayload
Returns Promise<GetReservedClaimCodesSuccessResponse>
Remarks
- API Route: POST /api/v0/claims/reserved/:claimId/:address
- SDK Function Call: await BitBadgesApi.getReservedClaimCodes(claimId, address, { ...body });
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.getReservedClaimCodes(claimId, address, { ...body });
console.log(res);
```
Inherited from BitBadgesAPI.getReservedClaimCodes
- Defined in src/api-indexer/BitBadgesApi.ts:653

getSearchResults

getSearchResults(
searchValue: string,
payload?: iGetSearchPayload<NumberType>,
): Promise<GetSearchSuccessResponse<T>>
Search collections, badges, accounts, address lists based on a search value.
Parameters
- searchValue: string
- Optionalpayload: iGetSearchPayload<NumberType>
Returns Promise<GetSearchSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/search/:searchValue
- SDK Function Call: await BitBadgesApi.getSearchResults(searchValue);
Example
```
const res = await BitBadgesApi.getSearchResults('vitalik.eth', { noAddressLists: true, noCollections: true, noBadges: true });
console.log(res);
```
Inherited from BitBadgesAPI.getSearchResults
- Defined in src/api-indexer/BitBadgesApi.ts:411

getSignInChallenge

getSignInChallenge(
payload: iGetSignInChallengePayload,
): Promise<GetSignInChallengeSuccessResponse<T>>
Gets the sign in challenge to be signed for authentication. The returned is the message to be signed by the user.
Parameters
- payload: iGetSignInChallengePayload
Returns Promise<GetSignInChallengeSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/auth/getChallenge
- SDK Function Call: await BitBadgesApi.getSignInChallenge(payload);
- Tutorial: See Authentication tutorial on the official docs.
Example
```
const res = await BitBadgesApi.getSignInChallenge(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:3785

getSIWBBRequestsForDeveloperApp

getSIWBBRequestsForDeveloperApp(
payload: iGetSIWBBRequestsForDeveloperAppPayload,
): Promise<GetSIWBBRequestsForDeveloperAppSuccessResponse<T>>
Gets the SIWBB requests for a specific developer app.
Parameters
- payload: iGetSIWBBRequestsForDeveloperAppPayload
Returns Promise<GetSIWBBRequestsForDeveloperAppSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/developerApps/siwbbRequests
- SDK Function Call: await BitBadgesApi.getSIWBBRequestsForDeveloperApp(payload);
Inherited from BitBadgesAPI.getSIWBBRequestsForDeveloperApp
- Defined in src/api-indexer/BitBadgesApi.ts:923

getSiwbbRequestsForUser

getSiwbbRequestsForUser(
address: string,
payload: iGetSiwbbRequestsForUserPayload,
): Promise<GetSiwbbRequestsForUserSuccessResponse<T>>
Gets Sign-In with BitBadges (SIWBB) requests (authentication requests) for a user.
Parameters
- address: string
- payload: iGetSiwbbRequestsForUserPayload
Returns Promise<GetSiwbbRequestsForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/requests/siwbb
- SDK Function Call: await BitBadgesApi.getSiwbbRequestsForUser(address, { });
Example
```
const res = await BitBadgesApi.getSiwbbRequestsForUser("bb1...", { });
console.log(res);
```
Inherited from BitBadgesAPI.getSiwbbRequestsForUser
- Defined in src/api-indexer/BitBadgesApi.ts:1957

getStatus

getStatus(payload?: iGetStatusPayload): Promise<GetStatusSuccessResponse<T>>
Gets the current status details about the blockchain / indexer (gas, block height, etc).
Parameters
- Optionalpayload: iGetStatusPayload
Returns Promise<GetStatusSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/status
- SDK Function Call: await BitBadgesApi.getStatus();
Example
```
const res = await BitBadgesApi.getStatus();
console.log(res);
```
Inherited from BitBadgesAPI.getStatus
- Defined in src/api-indexer/BitBadgesApi.ts:381

getTokensFromFaucet

getTokensFromFaucet(
payload?: iGetTokensFromFaucetPayload,
): Promise<GetTokensFromFaucetSuccessResponse>
Gets the tokens from the faucet. This will only work on betanet.
Parameters
- Optionalpayload: iGetTokensFromFaucetPayload
Returns Promise<GetTokensFromFaucetSuccessResponse>
Remarks
- API Route: POST /api/v0/faucet
- SDK Function Call: await BitBadgesApi.getTokensFromFaucet(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:3472

getTransferActivityForUser

getTransferActivityForUser(
address: string,
payload: iGetTransferActivityForUserPayload,
): Promise<GetTransferActivityForUserSuccessResponse<T>>
Gets transfer activity for a specific user.
Parameters
- address: string
- payload: iGetTransferActivityForUserPayload
Returns Promise<GetTransferActivityForUserSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/account/:address/activity/badges
- SDK Function Call: await BitBadgesApi.getTransferActivityForUser(address, { });
Example
```
const res = await BitBadgesApi.getTransferActivityForUser("bb1...", { });
console.log(res);
```
Inherited from BitBadgesAPI.getTransferActivityForUser
- Defined in src/api-indexer/BitBadgesApi.ts:1993

getUtilityListing

getUtilityListing(
utilityListingId: string,
payload?: iGetUtilityListingPayload,
): Promise<GetUtilityListingSuccessResponse<T>>
Get utility listing by ID.
Parameters
- utilityListingId: string
- Optionalpayload: iGetUtilityListingPayload
Returns Promise<GetUtilityListingSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/utilityListing/:utilityListingId
- SDK Function Call: await BitBadgesApi.getUtilityListing(utilityListingId, { ... });
Example
Inherited from BitBadgesAPI.getUtilityListing
- Defined in src/api-indexer/BitBadgesApi.ts:2798

getUtilityListings

getUtilityListings(
payload: iGetUtilityListingsPayload,
): Promise<GetUtilityListingsSuccessResponse<T>>
Gets utility listings.
Parameters
- payload: iGetUtilityListingsPayload
Returns Promise<GetUtilityListingsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/utilityListings/fetch
- SDK Function Call: await BitBadgesApi.getUtilityListings(payload);
Inherited from BitBadgesAPI.getUtilityListings
- Defined in src/api-indexer/BitBadgesApi.ts:1769

handleApiError

handleApiError(error: any): Promise<void>
Parameters
- error: any
Returns Promise<void>
Inherited from BitBadgesAPI.handleApiError
- Defined in src/api-indexer/base.ts:97

performBatchStoreAction

performBatchStoreAction(
payload: iPerformStoreActionBatchWithBodyAuthPayload,
): Promise<BatchStoreActionSuccessResponse>
Performs multiple actions for a dynamicStore in batch.
Parameters
- payload: iPerformStoreActionBatchWithBodyAuthPayload
Returns Promise<BatchStoreActionSuccessResponse>
Remarks
- API Route: POST /api/v0/storeActions/batch
- SDK Function Call: await BitBadgesApi.performBatchStoreAction(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.performBatchStoreAction
- Defined in src/api-indexer/BitBadgesApi.ts:1494

performStoreAction

performStoreAction(
payload: iPerformStoreActionSingleWithBodyAuthPayload,
): Promise<PerformStoreActionSuccessResponse>
Performs an action for a dynamicStore.
Parameters
- payload: iPerformStoreActionSingleWithBodyAuthPayload
Returns Promise<PerformStoreActionSuccessResponse>
Remarks
- API Route: POST /api/v0/storeActions/single
- SDK Function Call: await BitBadgesApi.performStoreAction(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.performStoreAction
- Defined in src/api-indexer/BitBadgesApi.ts:1467

refreshMetadata

refreshMetadata(
collectionId: NumberType,
payload?: iRefreshMetadataPayload,
): Promise<RefreshMetadataSuccessResponse>
Triggers a metadata refresh for a specific collection. BitBadges API uses a refresh queue system for fetching anything off-chain. This will refetch any details for the collection (such as metadata, balances, approval details, etc). Note it will reject if recently refreshed. Uses a cooldown of 5 minutes.
Parameters
- collectionId: NumberType
- Optionalpayload: iRefreshMetadataPayload
Returns Promise<RefreshMetadataSuccessResponse>
Remarks
- API Route: POST /api/v0/collection/:collectionId/refresh
- SDK Function Call: await BitBadgesApi.refreshMetadata(collectionId, payload);
Example
```
const res = await BitBadgesApi.refreshMetadata(collectionId);
console.log(res);
```
Inherited from BitBadgesAPI.refreshMetadata
- Defined in src/api-indexer/BitBadgesApi.ts:560

revokeOauthAuthorization

revokeOauthAuthorization(
payload: iOauthRevokePayload,
): Promise<OauthRevokeSuccessResponse>
Revokes an access token for a user.
Parameters
- payload: iOauthRevokePayload
Returns Promise<OauthRevokeSuccessResponse>
Remarks
- API Route: POST /api/v0/siwbb/token/revoke
- SDK Function Call: await BitBadgesApi.oauthRevoke(payload);
Inherited from BitBadgesAPI.revokeOauthAuthorization
- Defined in src/api-indexer/BitBadgesApi.ts:1415

rotateApiKey

rotateApiKey(
payload: iRotateApiKeyPayload,
): Promise<RotateApiKeySuccessResponse>
Rotates an API key.
Parameters
- payload: iRotateApiKeyPayload
Returns Promise<RotateApiKeySuccessResponse>
Remarks
- API Route: POST /api/v0/apiKeys/rotate
- SDK Function Call: await BitBadgesApi.rotateApiKey(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:3616

rotateSIWBBRequest

rotateSIWBBRequest(
payload: iRotateSIWBBRequestPayload,
): Promise<RotateSIWBBRequestSuccessResponse>
Rotates a SIWBB request.
Parameters
- payload: iRotateSIWBBRequestPayload
Returns Promise<RotateSIWBBRequestSuccessResponse>
Remarks
- API Route: POST /api/v0/siwbbRequest/rotate
- SDK Function Call: await BitBadgesApi.rotateSIWBBRequest(payload);
Inherited from BitBadgesAPI.rotateSIWBBRequest
- Defined in src/api-indexer/BitBadgesApi.ts:977

scheduleTokenRefresh

scheduleTokenRefresh(
payload: iScheduleTokenRefreshPayload,
): Promise<ScheduleTokenRefreshSuccessResponse>
Parameters
- payload: iScheduleTokenRefreshPayload
Returns Promise<ScheduleTokenRefreshSuccessResponse>
- Defined in src/api-indexer/BitBadgesApi.ts:3673

searchApplications

searchApplications(
payload: iSearchApplicationsPayload,
): Promise<SearchApplicationsSuccessResponse<T>>
Searches for applications.
Parameters
- payload: iSearchApplicationsPayload
Returns Promise<SearchApplicationsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/applications/search
- SDK Function Call: await BitBadgesApi.searchApplications(payload);
Inherited from BitBadgesAPI.searchApplications
- Defined in src/api-indexer/BitBadgesApi.ts:1622

searchClaims

searchClaims(
payload: iSearchClaimsPayload,
): Promise<SearchClaimsSuccessResponse<T>>
Searches for claims.
Parameters
- payload: iSearchClaimsPayload
Returns Promise<SearchClaimsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/claims/search
- SDK Function Call: await BitBadgesApi.searchClaims(payload);
Inherited from BitBadgesAPI.searchClaims
- Defined in src/api-indexer/BitBadgesApi.ts:1193

searchDeveloperApps

searchDeveloperApps(
payload: iSearchDeveloperAppsPayload,
): Promise<SearchDeveloperAppsSuccessResponse<T>>
Searches for developer apps.
Parameters
- payload: iSearchDeveloperAppsPayload
Returns Promise<SearchDeveloperAppsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/developerApps/search
- SDK Function Call: await BitBadgesApi.searchDeveloperApps(payload);
Inherited from BitBadgesAPI.searchDeveloperApps
- Defined in src/api-indexer/BitBadgesApi.ts:3192

searchDynamicDataStores

searchDynamicDataStores<Q extends DynamicDataHandlerType>(
payload: iSearchDynamicDataStoresPayload,
): Promise<SearchDynamicDataStoresSuccessResponse<Q, T>>
Searches dynamic data stores.
Type Parameters
- Q extends DynamicDataHandlerType
Parameters
- payload: iSearchDynamicDataStoresPayload
Returns Promise<SearchDynamicDataStoresSuccessResponse<Q, T>>
Remarks
- API Route: GET /api/v0/dynamicStores/search
- SDK Function Call: await BitBadgesApi.searchDynamicDataStores(payload);
Inherited from BitBadgesAPI.searchDynamicDataStores
- Defined in src/api-indexer/BitBadgesApi.ts:1570

searchPlugins

searchPlugins(
payload: iSearchPluginsPayload,
): Promise<SearchPluginsSuccessResponse<T>>
Searches for plugins.
Parameters
- payload: iSearchPluginsPayload
Returns Promise<SearchPluginsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/plugins/search
- SDK Function Call: await BitBadgesApi.searchPlugins(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:3421

searchUtilityListings

searchUtilityListings(
payload: iSearchUtilityListingsPayload,
): Promise<SearchUtilityListingsSuccessResponse<T>>
Searches for utility listings.
Parameters
- payload: iSearchUtilityListingsPayload
Returns Promise<SearchUtilityListingsSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/utilityListings/search
- SDK Function Call: await BitBadgesApi.searchUtilityListings(payload);
Inherited from BitBadgesAPI.searchUtilityListings
- Defined in src/api-indexer/BitBadgesApi.ts:1789

sendClaimAlert

sendClaimAlert(
payload: iSendClaimAlertsPayload,
): Promise<SendClaimAlertsSuccessResponse>
Sends claim alert notifications out.
Parameters
- payload: iSendClaimAlertsPayload
Returns Promise<SendClaimAlertsSuccessResponse>
Remarks
- API Route: POST /api/v0/claimAlerts/send
- SDK Function Call: await BitBadgesApi.sendClaimAlert(payload);
- Authentication: Must be signed in and the manager of the collection.
- CORS: Restricted to only BitBadges official site.
Inherited from BitBadgesAPI.sendClaimAlert
- Defined in src/api-indexer/BitBadgesApi.ts:1030

setAccessToken

setAccessToken(token: string): void
Parameters
- token: string
Returns void
Inherited from BitBadgesAPI.setAccessToken
- Defined in src/api-indexer/base.ts:87

signOut

signOut(payload?: iSignOutPayload): Promise<SignOutSuccessResponse>
Signs the user out.
Parameters
- Optionalpayload: iSignOutPayload
Returns Promise<SignOutSuccessResponse>
Remarks
- API Route: POST /api/v0/auth/logout
- SDK Function Call: await BitBadgesApi.signOut(payload);
- Tutorial: See Authentication tutorial on the official docs.
- Defined in src/api-indexer/BitBadgesApi.ts:3840

signWithEmbeddedWallet

signWithEmbeddedWallet(
payload: iSignWithEmbeddedWalletPayload,
): Promise<SignWithEmbeddedWalletSuccessResponse>
Parameters
- payload: iSignWithEmbeddedWalletPayload
Returns Promise<SignWithEmbeddedWalletSuccessResponse>
- Defined in src/api-indexer/BitBadgesApi.ts:3686

simulateClaim

simulateClaim(
    claimId: string,
    address: string,
    payload: iSimulateClaimPayload,
): Promise<SimulateClaimSuccessResponse>
Simulates a claim attempt. A success response means the claim is valid and can be completed.
Parameters
- claimId: string
- address: string
- payload: iSimulateClaimPayload
Returns Promise<SimulateClaimSuccessResponse>
Remarks
- API Route: POST /api/v0/claims/simulate/:claimId/:address
- SDK Function Call: await BitBadgesApi.simulateClaim(claimId, address, { ...body });
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.simulateClaim(claimId, address, { ...body });
console.log(res);
```
Inherited from BitBadgesAPI.simulateClaim
- Defined in src/api-indexer/BitBadgesApi.ts:617

simulateTx

simulateTx(
payload: string | BroadcastPostBody,
): Promise<SimulateTxSuccessResponse>
Simulates a transaction on the blockchain.
Parameters
- payload: string | BroadcastPostBody
Returns Promise<SimulateTxSuccessResponse>
Remarks
- API Route: POST /api/v0/simulate
- SDK Function Call: await BitBadgesApi.simulateTx(payload);
- Tutorial: See Broadcasting Transactions tutorial on the official docs.
This means that it will return the gas used and any errors that occur on a dry run. Should be used before broadcasting a transaction. Does not require signatures.
Inherited from BitBadgesAPI.simulateTx
- Defined in src/api-indexer/BitBadgesApi.ts:810

unsetAccessToken

unsetAccessToken(): void
Returns void
Inherited from BitBadgesAPI.unsetAccessToken
- Defined in src/api-indexer/base.ts:92

updateAccountInfo

updateAccountInfo(
payload: iUpdateAccountInfoPayload,
): Promise<UpdateAccountInfoSuccessResponse>
Updates the profile / account information for a user. We will only update the provided fields.
Parameters
- payload: iUpdateAccountInfoPayload
Returns Promise<UpdateAccountInfoSuccessResponse>
Remarks
- API Route: POST /api/v0/user/updateAccount
- SDK Function Call: await BitBadgesApi.updateAccountInfo(payload);
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.updateAccountInfo(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:3916

updateAddressListAddresses

updateAddressListAddresses(
payload: iUpdateAddressListAddressesPayload,
): Promise<UpdateAddressListAddressesSuccessResponse>
Updates the addresses of an address list.
Parameters
- payload: iUpdateAddressListAddressesPayload
Returns Promise<UpdateAddressListAddressesSuccessResponse>
Remarks
- API Route: PUT /api/v0/addressLists/addresses
- SDK Function Call: await BitBadgesApi.updateAddressListAddresses(payload);
Inherited from BitBadgesAPI.updateAddressListAddresses
- Defined in src/api-indexer/BitBadgesApi.ts:858

updateAddressListCoreDetails

updateAddressListCoreDetails<T extends NumberType>(
payload: iUpdateAddressListCoreDetailsPayload<T>,
): Promise<UpdateAddressListCoreDetailsSuccessResponse>
Updates the core details of an address list.
Type Parameters
- T extends NumberType
Parameters
- payload: iUpdateAddressListCoreDetailsPayload<T>
Returns Promise<UpdateAddressListCoreDetailsSuccessResponse>
Remarks
- API Route: PUT /api/v0/addressLists/coreDetails
- SDK Function Call: await BitBadgesApi.updateAddressListCoreDetails(payload);
Inherited from BitBadgesAPI.updateAddressListCoreDetails
- Defined in src/api-indexer/BitBadgesApi.ts:845

updateAddressLists

updateAddressLists(
payload: iUpdateAddressListsPayload<T>,
): Promise<UpdateAddressListsSuccessResponse>
Updates address lists stored by BitBadges centralized servers.

Warning: This is legacy and an all-inclusive route used by the frontend. Please opt for more fine-grained routes/

Warning: This route requires ALL claims to be provided. If any are not provided, they will not be included moving forward and will be deleted. To update an individual claim, you can use the update claim endpoint.
Parameters
- payload: iUpdateAddressListsPayload<T>
Returns Promise<UpdateAddressListsSuccessResponse>
Remarks
- API Route: PUT /api/v0/addressLists
- SDK Function Call: await BitBadgesApi.updateAddressLists(payload);
Deprecated
- Defined in src/api-indexer/BitBadgesApi.ts:3973

updateApplication

updateApplication(
payload: iUpdateApplicationPayload,
): Promise<UpdateApplicationSuccessResponse<T>>
Updates an application.
Parameters
- payload: iUpdateApplicationPayload
Returns Promise<UpdateApplicationSuccessResponse<T>>
Remarks
- API Route: PUT /api/v0/applications
- SDK Function Call: await BitBadgesApi.updateApplication(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.updateApplication
- Defined in src/api-indexer/BitBadgesApi.ts:1674

updateAttestation

updateAttestation(
payload: iUpdateAttestationPayload,
): Promise<UpdateAttestationSuccessResponse>
Update a attestation.
Parameters
- payload: iUpdateAttestationPayload
Returns Promise<UpdateAttestationSuccessResponse>
Remarks
- API Route: PUT /api/v0/attestations
- SDK Function Call: await BitBadgesApi.updateUserAttestations(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.updateAttestation
- Defined in src/api-indexer/BitBadgesApi.ts:1294

updateClaims

updateClaims(payload: iUpdateClaimPayload): Promise<UpdateClaimSuccessResponse>
Update an claim.
Parameters
- payload: iUpdateClaimPayload
Returns Promise<UpdateClaimSuccessResponse>
Remarks
- API Route: PUT /api/v0/claims
- SDK Function Call: await BitBadgesApi.updateClaim(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.updateClaims
- Defined in src/api-indexer/BitBadgesApi.ts:1393

updateDeveloperApp

updateDeveloperApp(
payload: iUpdateDeveloperAppPayload,
): Promise<UpdateDeveloperAppSuccessResponse>
Update an developer app.
Parameters
- payload: iUpdateDeveloperAppPayload
Returns Promise<UpdateDeveloperAppSuccessResponse>
Remarks
- API Route: `PUT /api/v0/developerApps
- SDK Function Call: await BitBadgesApi.updateUserDeveloperApps(payload);
- Authentication: Must be signed in.
Inherited from BitBadgesAPI.updateDeveloperApp
- Defined in src/api-indexer/BitBadgesApi.ts:3063

updateDynamicDataStore

updateDynamicDataStore<Q extends DynamicDataHandlerType, T extends NumberType>(
payload: iUpdateDynamicDataStorePayload,
): Promise<UpdateDynamicDataStoreSuccessResponse<Q, T>>
Updates a dynamic data bin.
Type Parameters
- Q extends DynamicDataHandlerType
- T extends NumberType
Parameters
- payload: iUpdateDynamicDataStorePayload
Returns Promise<UpdateDynamicDataStoreSuccessResponse<Q, T>>
Remarks
- API Route: PUT /api/v0/dynamicStores
- SDK Function Call: await BitBadgesApi.updateDynamicDataStore(payload);
Inherited from BitBadgesAPI.updateDynamicDataStore
- Defined in src/api-indexer/BitBadgesApi.ts:3115

updatePlugin

updatePlugin(
payload: iUpdatePluginPayload,
): Promise<UpdatePluginSuccessResponse>
Updates a plugin.
Parameters
- payload: iUpdatePluginPayload
Returns Promise<UpdatePluginSuccessResponse>
Remarks
- API Route: PUT /api/v0/plugins
- SDK Function Call: await BitBadgesApi.updatePlugin(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:3374

updateUserSeenActivity

updateUserSeenActivity(): Promise<UpdateAccountInfoSuccessResponse>
Updates the user's seen activity.

Returns Promise<UpdateAccountInfoSuccessResponse>
- Defined in src/api-indexer/BitBadgesApi.ts:3307

updateUtilityListing

updateUtilityListing(
payload: iUpdateUtilityListingPayload<T>,
): Promise<UpdateUtilityListingSuccessResponse<T>>
Updates a utility listing.
Parameters
- payload: iUpdateUtilityListingPayload<T>
Returns Promise<UpdateUtilityListingSuccessResponse<T>>
Remarks
- API Route: PUT /api/v0/utilityListings
- SDK Function Call: await BitBadgesApi.updateUtilityListing(payload);
Inherited from BitBadgesAPI.updateUtilityListing
- Defined in src/api-indexer/BitBadgesApi.ts:1829

uploadBalances

uploadBalances(
payload: iUploadBalancesPayload,
): Promise<UploadBalancesSuccessResponse>
Uploads balances for off-chain indexed balances managed by BitBadges.
Parameters
- payload: iUploadBalancesPayload
Returns Promise<UploadBalancesSuccessResponse>
Remarks
- API Route: POST /api/v0/uploadBalances
- SDK Function Call: await BitBadgesApi.uploadBalances(payload);
Inherited from BitBadgesAPI.uploadBalances
- Defined in src/api-indexer/BitBadgesApi.ts:3285

verifyAttestation

verifyAttestation(
payload: iVerifyAttestationPayload,
): Promise<VerifyAttestationSuccessResponse>
Verifies an attestation.
Parameters
- payload: iVerifyAttestationPayload
Returns Promise<VerifyAttestationSuccessResponse>
Remarks
- API Route: POST /api/v0/attestations/verify
- SDK Function Call: await BitBadgesApi.verifyAttestation(payload);
Inherited from BitBadgesAPI.verifyAttestation
- Defined in src/api-indexer/BitBadgesApi.ts:1319

verifyOwnershipRequirements

verifyOwnershipRequirements(
payload: iGenericVerifyAssetsPayload,
): Promise<GenericVerifyAssetsSuccessResponse>
A generic route for verifying asset ownership requirements. Asset requirements support AND / OR / NOT logic.
Parameters
- payload: iGenericVerifyAssetsPayload
Returns Promise<GenericVerifyAssetsSuccessResponse>
Remarks
- API Route: POST /api/v0/verifyOwnershipRequirements
- SDK Function Call: await BitBadgesApi.verifyOwnershipRequirements(payload);
Inherited from BitBadgesAPI.verifyOwnershipRequirements
- Defined in src/api-indexer/BitBadgesApi.ts:2985

verifySignIn

verifySignIn(
payload: iVerifySignInPayload,
): Promise<VerifySignInSuccessResponse>
Verifies the user signed challenge and grants them a valid session if everything checks out.
Parameters
- payload: iVerifySignInPayload
Returns Promise<VerifySignInSuccessResponse>
Remarks
- API Route: POST /api/v0/auth/verify
- SDK Function Call: await BitBadgesApi.verifySignIn(payload);
- Tutorial: See Authentication tutorial on the official docs.
Example
```
const res = await BitBadgesApi.verifySignIn(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:3817

verifySIWBBRequest

verifySIWBBRequest(
payload: iGenericBlockinVerifyPayload,
): Promise<GenericBlockinVerifySuccessResponse>
A generic route for verifying SIWBB requests. Used as a helper if implementing on your own.
Parameters
- payload: iGenericBlockinVerifyPayload
Returns Promise<GenericBlockinVerifySuccessResponse>
Remarks
- API Route: POST /api/v0/siwbbRequest/verify
- SDK Function Call: await BitBadgesApi.verifySIWBBRequest(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:3941

Class BitBadgesAdminAPI<T>

See

Type Parameters

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BitBadgesAdminAPI<T>

Properties

accessToken

apiKey

appendedHeaders

axios

BACKEND_URL

ConvertFunction

Methods

addApprovalDetailsToOffChainStorage

Parameters

Returns Promise<AddApprovalDetailsToOffChainStorageSuccessResponse>

Remarks

Example

addBalancesToOffChainStorage

Parameters

Returns Promise<AddBalancesToOffChainStorageSuccessResponse>

Remarks

Example

addToIpfs

Parameters

Returns Promise<AddToIpfsSuccessResponse>

Remarks

Example

assertPositiveInteger

Parameters

Returns void

broadcastTx

Parameters

Returns Promise<BroadcastTxSuccessResponse>

Remarks

calculatePoints

Parameters

Returns Promise<CalculatePointsSuccessResponse>

Remarks

checkClaimSuccess

Parameters

Returns Promise<CheckClaimSuccessSuccessResponse>

Remarks

checkIfSignedIn

Parameters

Returns Promise<CheckSignInStatusSuccessResponse>

Remarks

completeClaim

Parameters

Returns Promise<CompleteClaimSuccessResponse>

Remarks

Example

createAddressLists

Parameters

Returns Promise<CreateAddressListsSuccessResponse>

Remarks

createApiKey

Parameters

Returns Promise<CreateApiKeySuccessResponse>

Remarks

createApplication

Parameters

Returns Promise<CreateApplicationSuccessResponse<T>>

Remarks

createAttestation

Parameters

Returns Promise<CreateAttestationSuccessResponse>

Remarks

createClaims

Parameters

Returns Promise<CreateClaimSuccessResponse>

Remarks