Class: BitBadgesAPI<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…

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:364

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.

convertFunction is used to convert any responses returned by the API to your desired NumberType.

typescript

import { BigIntify, Stringify, Numberify, BitBadgesAPI } from "bitbadges";
const BitBadgesApi = new BitBadgesAPI({ convertFunction: BigIntify, apiKey: '...' });
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

Extends

BaseBitBadgesApi<T>

Extended by

BitBadgesAdminAPI

Type Parameters

T

T extends NumberType

Constructors

Constructor

new BitBadgesAPI<T>(apiDetails): BitBadgesAPI<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:372

Parameters

apiDetails

iBitBadgesApi<T>

Returns

BitBadgesAPI<T>

Overrides

BaseBitBadgesApi.constructor

Properties

accessToken

accessToken: string = ''

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:63

Inherited from

BaseBitBadgesApi.accessToken

apiKey

apiKey: string | undefined

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:62

Inherited from

BaseBitBadgesApi.apiKey

appendedHeaders

appendedHeaders: Record<string, string> = {}

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:64

Inherited from

BaseBitBadgesApi.appendedHeaders

axios

axios: AxiosInstance

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:59

Inherited from

BaseBitBadgesApi.axios

BACKEND_URL

BACKEND_URL: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:60

Inherited from

BaseBitBadgesApi.BACKEND_URL

ConvertFunction

ConvertFunction: (num) => T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:61

Parameters

num

NumberType

Returns

T

Inherited from

BaseBitBadgesApi.ConvertFunction

Methods

assertPositiveCollectionId()

assertPositiveCollectionId(collectionId): void

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:118

Parameters

collectionId

string

Returns

void

Inherited from

BaseBitBadgesApi.assertPositiveCollectionId

assertPositiveInteger()

assertPositiveInteger(num): void

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:106

Parameters

num

NumberType

Returns

void

Inherited from

BaseBitBadgesApi.assertPositiveInteger

broadcastTx()

broadcastTx(payload): Promise<BroadcastTxSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:827

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.

checkClaimSuccess()

checkClaimSuccess(claimId, address): Promise<CheckClaimSuccessSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1462

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);

checkIfSignedIn()

checkIfSignedIn(payload?): Promise<CheckSignInStatusSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:799

Checks if the user is signed in.

Parameters

payload?

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.

completeClaim()

completeClaim(claimId, address, payload): Promise<CompleteClaimSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:586

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

typescript

const res = await BitBadgesApi.completeClaim(claimId, address, { ...body });
console.log(res);

createClaims()

createClaims(payload): Promise<CreateClaimSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1086

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.

createDeveloperApp()

createDeveloperApp(payload): Promise<CreateDeveloperAppSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2167

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.

createDynamicDataStore()

createDynamicDataStore<Q, NumberType>(payload): Promise<CreateDynamicDataStoreSuccessResponse<Q, T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2244

Creates a dynamic data bin.

Type Parameters

Q

Q extends "addresses"

NumberType

NumberType

Parameters

payload

iCreateDynamicDataStorePayload

Returns

Promise<CreateDynamicDataStoreSuccessResponse<Q, T>>

Remarks

API Route: POST /api/v0/dynamicStores
SDK Function Call: await BitBadgesApi.createDynamicDataStore(payload);

createSIWBBRequest()

createSIWBBRequest(payload?): Promise<CreateSIWBBRequestSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:932

Creates a SIWBB request.

Parameters

payload?

iCreateSIWBBRequestPayload

Returns

Promise<CreateSIWBBRequestSuccessResponse>

Remarks

API Route: POST /api/v0/siwbbRequest
SDK Function Call: await BitBadgesApi.createSIWBBRequest(payload);

createUtilityPage()

createUtilityPage(payload): Promise<CreateUtilityPageSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1378

Creates a utility page.

Parameters

payload

iCreateUtilityPagePayload<T>

Returns

Promise<CreateUtilityPageSuccessResponse<T>>

Remarks

API Route: POST /api/v0/utilityPages
SDK Function Call: await BitBadgesApi.createUtilityPage(payload);

deleteClaims()

deleteClaims(payload): Promise<DeleteClaimSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1109

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.

deleteDeveloperApp()

deleteDeveloperApp(payload): Promise<DeleteDeveloperAppSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2193

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.

deleteDynamicDataStore()

deleteDynamicDataStore(payload): Promise<DeleteDynamicDataStoreSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2298

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);

deleteSIWBBRequest()

deleteSIWBBRequest(payload?): Promise<DeleteSIWBBRequestSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:983

Deletes a SIWBB request.

Parameters

payload?

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.

deleteUtilityPage()

deleteUtilityPage(payload): Promise<DeleteUtilityPageSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1418

Deletes a utility page.

Parameters

payload

iDeleteUtilityPagePayload

Returns

Promise<DeleteUtilityPageSuccessResponse>

Remarks

API Route: DELETE /api/v0/utilityPages
SDK Function Call: await BitBadgesApi.deleteUtilityPage(payload);

estimateSwap()

estimateSwap(payload): Promise<iEstimateSwapSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2528

Estimate a swap from a token-in denom to a token-out denom across one or more chains.

Parameters

payload

iEstimateSwapPayload

Returns

Promise<iEstimateSwapSuccessResponse>

Remarks

API Route: POST /api/v0/swap/estimate
SDK Function Call: await BitBadgesApi.estimateSwap({ tokenIn: '1000000ubadge', tokenOutDenom: 'uusdc', chainIdsToAddresses: { 'bitbadges-1': 'bb1...' }, slippageTolerancePercent: 1 });
Honors a --local-only flag to restrict the route to BitBadges native pools (no Skip:Go rerouting).

estimateSwapLegacy()

estimateSwapLegacy(payload): Promise<iEstimateSwapSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2552

Parameters

payload

iEstimateSwapPayload

Returns

Promise<iEstimateSwapSuccessResponse>

Deprecated

Use estimateSwap instead. Pass-through shim kept so the documented legacy POST /api/v0/swaps/estimate route (which the indexer still serves as a deprecation alias) stays callable from generated SDK clients. New code should call estimateSwap.

exchangeSIWBBAuthorizationCode()

exchangeSIWBBAuthorizationCode(payload?): Promise<ExchangeSIWBBAuthorizationCodeSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:874

Gets and verifies a SIWBB request.

Parameters

payload?

iExchangeSIWBBAuthorizationCodePayload

Returns

Promise<ExchangeSIWBBAuthorizationCodeSuccessResponse<T>>

Remarks

API Route: POST /api/v0/siwbbRequest
SDK Function Call: await BitBadgesApi.exchangeSIWBBAuthorizationCode(payload);

filterCollectionApprovals()

filterCollectionApprovals(collectionId, payload): Promise<FilterCollectionApprovalsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2734

Filter approval items for a collection by a Mongo-style query, returning the matching approvers' balance docs. Pass 'any' as collectionId to search across all collections.

Parameters

collectionId

string

payload

iFilterCollectionApprovalsPayload

Returns

Promise<FilterCollectionApprovalsSuccessResponse<T>>

Remarks

API Route: POST /api/v0/collection/:collectionId/filterApprovals
SDK Function Call: await BitBadgesApi.filterCollectionApprovals('1', { query: { approvalType: 'intent', isActive: true }, sortBy: { _id: -1 } });

FilterTokensInCollection()

FilterTokensInCollection(collectionId, payload): Promise<FilterTokensInCollectionSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1019

Filters tokens in a collection based on multiple filter values.

Parameters

collectionId

string

payload

iFilterTokensInCollectionPayload

Returns

Promise<FilterTokensInCollectionSuccessResponse<T>>

Remarks

API Route: POST /api/v0/collection/:collectionId/filter
SDK Function Call: await BitBadgesApi.FilterTokensInCollection(payload);

getAccount()

getAccount(payload): Promise<GetAccountSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:750

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

typescript

const res = await BitBadgesApi.getAccount({ address: '...', username: '...' });
console.log(res);

getAccounts()

getAccounts(payload): Promise<GetAccountsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:733

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

typescript

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.

getBalanceByAddress()

getBalanceByAddress(collectionId, address, payload?): Promise<GetBalanceByAddressSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:484

Gets the balance of a specific token for a specific address

Parameters

collectionId

string

address

string

payload?

iGetBalanceByAddressPayload

Returns

Promise<GetBalanceByAddressSuccessResponse<T>>

Remarks

API Route: POST /api/v0/collection/:collectionId/balance/:address
SDK Function Call: await BitBadgesApi.getBalanceByAddress(collectionId, address);

Example

typescript

const res = await BitBadgesApi.getBalanceByAddress(collectionId, address);
console.log(res);

getBalanceByAddressSpecificToken()

getBalanceByAddressSpecificToken(collectionId, tokenId, address, payload?, options?): Promise<GetBalanceByAddressSpecificTokenSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:506

Gets the balance for an address at the current time. This is a streamlined version of getBalanceByAddress.

Parameters

collectionId

string

tokenId

NumberType

address

string

payload?

iGetBalanceByAddressPayload

options?

time?

NumberType

Returns

Promise<GetBalanceByAddressSpecificTokenSuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/:tokenId/balance/:address
SDK Function Call: await BitBadgesApi.getBalanceByAddress(collectionId, tokenId, address);

Example

typescript

const res = await BitBadgesApi.getBalanceByAddress(collectionId, tokenId, address);
console.log(res);

getClaim()

getClaim(claimId, payload?): Promise<GetClaimSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1915

Get a claim by ID.

Parameters

claimId

string

payload?

iGetClaimPayload

Returns

Promise<GetClaimSuccessResponse<T>>

Remarks

API Route: GET /api/v0/claim/:claimId
SDK Function Call: await BitBadgesApi.getClaim(claimId, { ... });

Example

typescript

const res = await BitBadgesApi.getClaim("123", { ... });
console.log(res);

getClaimActivityForUser()

getClaimActivityForUser(address, payload): Promise<GetClaimActivityForUserSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1594

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

typescript

const res = await BitBadgesApi.getClaimActivityForUser("bb1...", { viewType: "public" });
console.log(res);

getClaimAttempts()

getClaimAttempts(claimId, payload): Promise<GetClaimAttemptsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1437

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);

getClaimAttemptStatus()

getClaimAttemptStatus(claimAttemptId): Promise<GetClaimAttemptStatusSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:697

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

typescript

const res = await BitBadgesApi.getClaimAttemptStatus(claimAttemptId);
console.log(res);

getClaims()

getClaims(payload): Promise<GetClaimsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1039

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

typescript

const res = await BitBadgesApi.getClaims(payload);
console.log(res);

getCollection()

getCollection(collectionId, payload?): Promise<GetCollectionSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1695

Gets a specific collection.

Parameters

collectionId

string

payload?

iGetCollectionPayload

Returns

Promise<GetCollectionSuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId
SDK Function Call: await BitBadgesApi.getCollection(collectionId);

Example

typescript

const res = await BitBadgesApi.getCollection("123");
console.log(res);

getCollectionAmountTrackerById()

getCollectionAmountTrackerById<T>(trackerDetails): Promise<GetCollectionAmountTrackerByIdSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2373

Gets a specific amount tracker by ID for a collection

Type Parameters

T

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(...);

getCollectionAmountTrackers()

getCollectionAmountTrackers(collectionId, payload): Promise<GetCollectionAmountTrackersSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1818

Gets amount trackers for a specific collection.

Parameters

collectionId

string

payload

iGetCollectionAmountTrackersPayload

Returns

Promise<GetCollectionAmountTrackersSuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/amountTrackers
SDK Function Call: await BitBadgesApi.getCollectionAmountTrackers(collectionId, { bookmark });

Example

typescript

const res = await BitBadgesApi.getCollectionAmountTrackers("123", { bookmark: "123" });
console.log(res);

getCollectionChallengeTrackerById()

getCollectionChallengeTrackerById<T>(trackerDetails): Promise<GetCollectionChallengeTrackerByIdSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2395

Gets a specific challenge tracker by ID for a collection

Type Parameters

T

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(...);

getCollectionChallengeTrackers()

getCollectionChallengeTrackers(collectionId, payload): Promise<GetCollectionChallengeTrackersSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1782

Gets challenge trackers for a specific collection.

Parameters

collectionId

string

payload

iGetCollectionChallengeTrackersPayload

Returns

Promise<GetCollectionChallengeTrackersSuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/challengeTrackers
SDK Function Call: await BitBadgesApi.getCollectionChallengeTrackers(collectionId, { bookmark });

Example

typescript

const res = await BitBadgesApi.getCollectionChallengeTrackers("123", { bookmark: "123" });
console.log(res);

getCollectionClaims()

getCollectionClaims(collectionId): Promise<GetCollectionClaimsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1890

Gets claims for a specific collection.

Parameters

collectionId

string

Returns

Promise<GetCollectionClaimsSuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/claims
SDK Function Call: await BitBadgesApi.getCollectionClaims(collectionId);

Example

typescript

const res = await BitBadgesApi.getCollectionClaims("123");
console.log(res);

getCollectionListings()

getCollectionListings(collectionId, payload): Promise<GetCollectionListingsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1854

Gets listings for a specific collection.

Parameters

collectionId

string

payload

iGetCollectionListingsPayload

Returns

Promise<GetCollectionListingsSuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/listings
SDK Function Call: await BitBadgesApi.getCollectionListings(collectionId, { bookmark });

Example

typescript

const res = await BitBadgesApi.getCollectionListings("123", { bookmark: "123" });
console.log(res);

getCollectionOwners()

getCollectionOwners(collectionId, payload): Promise<GetCollectionOwnersSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1662

Gets owners for a specific collection.

Parameters

collectionId

string

payload

iGetCollectionOwnersPayload

Returns

Promise<GetCollectionOwnersSuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/owners
SDK Function Call: await BitBadgesApi.getCollectionOwners(collectionId, { bookmark });

Example

typescript

const res = await BitBadgesApi.getCollectionOwners("123", { bookmark: "123" });
console.log(res);

getCollections()

getCollections(payload): Promise<GetCollectionsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:450

This function retrieves 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

typescript

const res = await BitBadgesApi.getCollections([{ collectionId, metadataToFetch: { tokenIds: [{ start: 1n, end: 10n }] } }]);
const collection = res.collections[0];

getCollectionTransferActivity()

getCollectionTransferActivity(collectionId, payload): Promise<GetCollectionTransferActivitySuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1746

Gets transfer activity for a specific collection.

Parameters

collectionId

string

payload

iGetCollectionTransferActivityPayload

Returns

Promise<GetCollectionTransferActivitySuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/activity
SDK Function Call: await BitBadgesApi.getCollectionTransferActivity(collectionId, { bookmark });

Example

typescript

const res = await BitBadgesApi.getCollectionTransferActivity("123", { bookmark: "123" });
console.log(res);

getDeveloperApp()

getDeveloperApp(developerAppId, payload?): Promise<GetDeveloperAppSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2094

Get developer app by ID.

Parameters

developerAppId

string

payload?

iGetDeveloperAppPayload

Returns

Promise<GetDeveloperAppSuccessResponse<T>>

Remarks

API Route: GET /api/v0/developerApp/:developerAppId
SDK Function Call: await BitBadgesApi.getDeveloperApp(developerAppId, { ... });

Example

typescript

const res = await BitBadgesApi.getDeveloperApp("developerApp123", { ... });
console.log(res);

getDeveloperApps()

getDeveloperApps(payload): Promise<GetDeveloperAppsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2323

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);

getDynamicDataActivity()

getDynamicDataActivity(payload): Promise<GetDynamicDataActivitySuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1264

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);

getDynamicDataStore()

getDynamicDataStore<Q>(dynamicStoreId, payload?): Promise<GetDynamicDataStoreSuccessResponse<Q, T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1945

Get a dynamic data store by ID.

Type Parameters

Q

Q extends "addresses"

Parameters

dynamicStoreId

string

payload?

iGetDynamicDataStorePayload

Returns

Promise<GetDynamicDataStoreSuccessResponse<Q, T>>

Remarks

API Route: GET /api/v0/dynamicStore/:dynamicStoreId
SDK Function Call: await BitBadgesApi.getDynamicDataStore(dynamicStoreId, { ... });

Example

typescript

const res = await BitBadgesApi.getDynamicDataStore("store123", { ... });
console.log(res);

getDynamicDataStores()

getDynamicDataStores<Q, NumberType>(payload): Promise<GetDynamicDataStoresSuccessResponse<Q, T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1284

Gets dynamic data stores.

Type Parameters

Q

Q extends "addresses"

NumberType

NumberType

Parameters

payload

iGetDynamicDataStoresPayload

Returns

Promise<GetDynamicDataStoresSuccessResponse<Q, T>>

Remarks

API Route: POST /api/v0/dynamicStores/fetch
SDK Function Call: await BitBadgesApi.getDynamicDataStores(payload);

getDynamicDataStoreValue()

getDynamicDataStoreValue(dynamicStoreId, payload?): Promise<GetDynamicDataStoreValueSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1973

Get a dynamic data store value by ID.

Parameters

dynamicStoreId

string

payload?

iGetDynamicDataStoreValuePayload

Returns

Promise<GetDynamicDataStoreValueSuccessResponse>

Remarks

API Route: GET /api/v0/dynamicStore/:dynamicStoreId/:key
SDK Function Call: await BitBadgesApi.getDynamicDataStoreValue(dynamicStoreId, { ... });

getDynamicDataStoreValuesPaginated()

getDynamicDataStoreValuesPaginated<Q>(dynamicStoreId, payload?): Promise<GetDynamicDataStoreValuesPaginatedSuccessResponse<Q, T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2001

Get a dynamic data store values paginated by ID.

Type Parameters

Q

Q extends "addresses"

Parameters

dynamicStoreId

string

payload?

iGetDynamicDataStoreValuesPaginatedPayload

Returns

Promise<GetDynamicDataStoreValuesPaginatedSuccessResponse<Q, T>>

Remarks

API Route: GET /api/v0/dynamicStore/:dynamicStoreId/values
SDK Function Call: await BitBadgesApi.getDynamicDataStoreValuesPaginated(dynamicStoreId, { ... });

getGatedContentForClaim()

getGatedContentForClaim(claimId, payload?): Promise<GetGatedContentForClaimSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1179

Get the gated content for a claim.

Parameters

claimId

string

payload?

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.

getIntents()

getIntents(address?, payload?): Promise<GetIntentsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2707

Get exchange-approval "intents" — either the global browse list (no address) or a specific user's intents (pass an address; combine with includeAll: true to include used/expired/inactive ones).

Parameters

address?

string

payload?

iGetIntentsPayload

Returns

Promise<GetIntentsSuccessResponse<T>>

Remarks

API Route: GET /api/v0/intents (no address) or GET /api/v0/intents/:address
SDK Function Call: await BitBadgesApi.getIntents('bb1...', { includeAll: true });

getOnChainDynamicStore()

getOnChainDynamicStore(storeId): Promise<GetOnChainDynamicStoreSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2768

Get On-Chain Dynamic Store by ID

Parameters

storeId

string

Returns

Promise<GetOnChainDynamicStoreSuccessResponse<T>>

Remarks

API Route: GET /api/v0/onChainDynamicStore/:storeId
SDK Function Call: await BitBadgesApi.getOnChainDynamicStore(storeId);

Example

typescript

const res = await BitBadgesApi.getOnChainDynamicStore(storeId);
console.log(res);

getOnChainDynamicStoresByCreator()

getOnChainDynamicStoresByCreator(address): Promise<GetOnChainDynamicStoresByCreatorSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2793

Get On-Chain Dynamic Stores by Creator

Parameters

address

string

Returns

Promise<GetOnChainDynamicStoresByCreatorSuccessResponse<T>>

Remarks

API Route: GET /api/v0/onChainDynamicStores/by-creator/:address
SDK Function Call: await BitBadgesApi.getOnChainDynamicStoresByCreator(address);

Example

typescript

const res = await BitBadgesApi.getOnChainDynamicStoresByCreator(address);
console.log(res);

getOnChainDynamicStoreValue()

getOnChainDynamicStoreValue(storeId, address): Promise<GetOnChainDynamicStoreValueSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2818

Get On-Chain Dynamic Store Value

Parameters

storeId

string

address

string

Returns

Promise<GetOnChainDynamicStoreValueSuccessResponse<T>>

Remarks

API Route: GET /api/v0/onChainDynamicStore/:storeId/value/:address
SDK Function Call: await BitBadgesApi.getOnChainDynamicStoreValue(storeId, address);

Example

typescript

const res = await BitBadgesApi.getOnChainDynamicStoreValue(storeId, address);
console.log(res);

getOnChainDynamicStoreValuesPaginated()

getOnChainDynamicStoreValuesPaginated(storeId, payload?): Promise<GetOnChainDynamicStoreValuesPaginatedSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2846

Get On-Chain Dynamic Store Values (Paginated)

Parameters

storeId

string

payload?

iGetOnChainDynamicStoreValuesPaginatedPayload

Returns

Promise<GetOnChainDynamicStoreValuesPaginatedSuccessResponse<T>>

Remarks

API Route: GET /api/v0/onChainDynamicStore/:storeId/values
SDK Function Call: await BitBadgesApi.getOnChainDynamicStoreValuesPaginated(storeId, { bookmark: '', limit: 25 });

Example

typescript

const res = await BitBadgesApi.getOnChainDynamicStoreValuesPaginated(storeId, {
  bookmark: '',
  limit: 25
});
console.log(res);

getOwners()

getOwners(collectionId, tokenId, payload): Promise<GetOwnersSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:467

Gets the owners for a specific token in a collection

Parameters

collectionId

string

Remarks

API Route: GET /api/v0/collection/:collectionId/:tokenId/owners
SDK Function Call: await BitBadgesApi.getOwners(collectionId, tokenId, payload);

Example

typescript

const res = await BitBadgesApi.getOwners(collectionId, tokenId, { bookmark: 'prev' });
console.log(res);

getPlugin()

getPlugin(pluginId, payload?): Promise<GetPluginSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2037

Get plugin by ID.

Parameters

pluginId

string

payload?

iGetPluginPayload

Returns

Promise<GetPluginSuccessResponse<T>>

Remarks

API Route: GET /api/v0/plugin/:pluginId
SDK Function Call: await BitBadgesApi.getPlugin(pluginId, { ... });

Example

typescript

const res = await BitBadgesApi.getPlugin("plugin123", { ... });
console.log(res);

getPlugins()

getPlugins(payload): Promise<GetPluginsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2119

Get all developer apps for a user.

Parameters

payload

iGetPluginsPayload

Returns

Promise<GetPluginsSuccessResponse<T>>

Remarks

API Route: POST /api/v0/plugins/fetch
SDK Function Call: await BitBadgesApi.getPlugins(payload);

getPointsActivityForUser()

getPointsActivityForUser(address, payload): Promise<GetPointsActivityForUserSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1628

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

typescript

const res = await BitBadgesApi.getPointsActivityForUser("bb1...", { ... });
console.log(res);

getRefreshStatus()

getRefreshStatus(collectionId): Promise<RefreshStatusSuccessResponse<NumberType>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1008

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

string

Returns

Promise<RefreshStatusSuccessResponse<NumberType>>

Remarks

API Route: GET /api/v0/collection/:collectionId/refreshStatus
SDK Function Call: await BitBadgesApi.getRefreshStatus(payload);

getReservedClaimCodes()

getReservedClaimCodes(claimId, address, payload): Promise<GetReservedClaimCodesSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:658

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

typescript

const res = await BitBadgesApi.getReservedClaimCodes(claimId, address, { ...body });
console.log(res);

getSearchResults()

getSearchResults(searchValue, payload?): Promise<GetSearchSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:419

Search collections, tokens, accounts based on a search value.

Parameters

searchValue

string

payload?

iGetSearchPayload<NumberType>

Returns

Promise<GetSearchSuccessResponse<T>>

Remarks

API Route: POST /api/v0/search/:searchValue
SDK Function Call: await BitBadgesApi.getSearchResults(searchValue);

Example

typescript

const res = await BitBadgesApi.getSearchResults('vitalik.eth', {  noCollections: true });
console.log(res);

getSIWBBRequestsForDeveloperApp()

getSIWBBRequestsForDeveloperApp(payload): Promise<GetSIWBBRequestsForDeveloperAppSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:903

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);

getSiwbbRequestsForUser()

getSiwbbRequestsForUser(address, payload): Promise<GetSiwbbRequestsForUserSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1487

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

typescript

const res = await BitBadgesApi.getSiwbbRequestsForUser("bb1...", { });
console.log(res);

getSkipAssets()

getSkipAssets(payload?): Promise<GetSkipAssetsSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2633

Parameters

payload?

iGetSkipAssetsPayload

Returns

Promise<GetSkipAssetsSuccessResponse>

Deprecated

Use getSwapAssets instead. This is a thin wrapper that forwards to the consolidated /swap/assets endpoint.

Get Skip:Go cross-chain assets (filtered to BitBadges-allowed chains).

Remarks

API Route: GET /api/v0/swap/assets (was /api/v0/skip/assets)

getSkipBalances()

getSkipBalances(payload): Promise<GetSkipBalancesSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2663

Parameters

payload

iGetSkipBalancesPayload

Returns

Promise<GetSkipBalancesSuccessResponse>

Deprecated

Use getSwapBalances instead. This is a thin wrapper that forwards to the consolidated /swap/balances endpoint.

Get Skip:Go balances for one or more (chain, address) pairs.

Remarks

API Route: POST /api/v0/swap/balances (was /api/v0/skip/balances)

getSkipChains()

getSkipChains(payload?): Promise<GetSkipChainsSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2649

Parameters

payload?

iGetSkipChainsPayload

Returns

Promise<GetSkipChainsSuccessResponse>

Deprecated

Use getSwapChains instead. This is a thin wrapper that forwards to the consolidated /swap/chains endpoint.

Get Skip:Go cross-chain chain registry (filtered to BitBadges-allowed chains).

Remarks

API Route: GET /api/v0/swap/chains (was /api/v0/skip/chains)

getSkipTxStatus()

getSkipTxStatus(payload): Promise<GetSkipTxStatusSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2692

Parameters

payload

iGetSkipTxStatusPayload

Returns

Promise<GetSkipTxStatusSuccessResponse>

Deprecated

Use getSwapStatus instead. This is a thin wrapper that forwards to the consolidated /swap/status endpoint.

Get the status of a tracked Skip:Go transaction.

Remarks

API Route: GET /api/v0/swap/status (was /api/v0/skip/v2/tx/status)

getStatus()

getStatus(payload?): Promise<GetStatusSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:389

Gets the current status details about the blockchain / indexer (gas, block height, etc).

Parameters

payload?

iGetStatusPayload

Returns

Promise<GetStatusSuccessResponse<T>>

Remarks

API Route: GET /api/v0/status
SDK Function Call: await BitBadgesApi.getStatus();

Example

typescript

const res = await BitBadgesApi.getStatus();
console.log(res);

getSwapActivities()

getSwapActivities(payload?): Promise<GetSwapActivitiesSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2423

Get Swap Activities

Parameters

payload?

iGetSwapActivitiesPayload

Returns

Promise<GetSwapActivitiesSuccessResponse<T>>

Remarks

API Route: GET /api/v0/swapActivities
SDK Function Call: await BitBadgesApi.getSwapActivities({ bookmark: '', limit: 25 });

Example

typescript

const res = await BitBadgesApi.getSwapActivities({ bookmark: '', limit: 25 });
console.log(res);

getSwapAssets()

getSwapAssets(payload?): Promise<GetSwapAssetsSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2450

Get consolidated cross-chain assets (Skip:Go + CoinsRegistry + verified BitBadges asset metadata).

Parameters

payload?

iGetSwapAssetsPayload

Returns

Promise<GetSwapAssetsSuccessResponse>

Remarks

API Route: GET /api/v0/swap/assets
SDK Function Call: await BitBadgesApi.getSwapAssets({ includeSvm: false, includeCw20: false });
The indexer merges Skip:Go assets with BB-side CoinsRegistry entries and verified AssetInfoDoc rows for the BitBadges chain. Non-BitBadges chains pass through Skip unmodified.
Each asset carries a source ('skip' | 'coinregistry' | 'verified' | 'native') and an optional isWrapped flag for verified badgeslp:/badges: wrapped denoms.

getSwapBalances()

getSwapBalances(payload): Promise<GetSwapBalancesSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2502

Get consolidated cross-chain balances for one or more (chain, address) pairs.

Parameters

payload

iGetSwapBalancesPayload

Returns

Promise<GetSwapBalancesSuccessResponse>

Remarks

API Route: POST /api/v0/swap/balances
SDK Function Call: await BitBadgesApi.getSwapBalances({ chains: { 'bitbadges-1': ['bb1...'] } });
For BitBadges chains, the indexer merges Skip-returned balances with on-chain bank balances for CoinsRegistry denoms Skip didn't report and computed wrappable amounts for verified badgeslp:/badges: denoms. Each balance row may carry decimals, symbol, and a source tag.

getSwapChains()

getSwapChains(payload?): Promise<GetSwapChainsSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2476

Get cross-chain chain registry (Skip:Go chains filtered to BitBadges-allowed chains).

Parameters

payload?

iGetSwapChainsPayload

Returns

Promise<GetSwapChainsSuccessResponse>

Remarks

API Route: GET /api/v0/swap/chains
SDK Function Call: await BitBadgesApi.getSwapChains({ includeSvm: false, onlyTestnets: false });
Same behavior as the legacy /skip/chains endpoint; no merge layer (chains are Skip's domain).

getSwapStatus()

getSwapStatus(payload): Promise<GetSwapStatusSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2593

Get the status of a tracked swap transaction.

Parameters

payload

iGetSwapStatusPayload

Returns

Promise<GetSwapStatusSuccessResponse>

Remarks

API Route: GET /api/v0/swap/status
SDK Function Call: await BitBadgesApi.getSwapStatus({ txHash, chainId });
The indexer enriches the upstream response with a swapEventInfo field derived from BitBadges on-chain swap events when the final destination is BitBadges.

getTokenActivity()

getTokenActivity(collectionId, tokenId, payload): Promise<GetTokenActivitySuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:542

Gets the activity for a specific token in a collection

Parameters

collectionId

string

tokenId

NumberType

payload

iGetTokenActivityPayload

Returns

Promise<GetTokenActivitySuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/:tokenId/activity
SDK Function Call: await BitBadgesApi.getTokenActivity(collectionId, tokenId, payload);

Example

typescript

const res = await BitBadgesApi.getTokenActivity(collectionId, tokenId, { bookmark: 'prev' });
console.log(res);

getTokenMetadata()

getTokenMetadata(collectionId, tokenId): Promise<GetTokenMetadataSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1721

Gets current metadata for a specific token in a collection.

Parameters

collectionId

string

tokenId

NumberType

Returns

Promise<GetTokenMetadataSuccessResponse<T>>

Remarks

API Route: GET /api/v0/collection/:collectionId/:tokenId/metadata
SDK Function Call: await BitBadgesApi.getTokenMetadata(collectionId, tokenId);

Example

typescript

const res = await BitBadgesApi.getTokenMetadata("123", "456");
console.log(res);

getTokensViewForUser()

getTokensViewForUser(address, payload): Promise<GetTokensViewForUserSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1560

Gets tokens for a specific user. Specify the viewType to determine what tokens to retrieve.

Parameters

address

string

payload

iGetTokensViewForUserPayload

Returns

Promise<GetTokensViewForUserSuccessResponse<T>>

Remarks

API Route: GET /api/v0/account/:address/tokens
SDK Function Call: await BitBadgesApi.getTokensViewForUser(address, { viewType });

Example

typescript

const res = await BitBadgesApi.getTokensViewForUser("bb1...", { viewType: "collected" });
console.log(res);

getTransferActivityForUser()

getTransferActivityForUser(address, payload): Promise<GetTransferActivityForUserSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1523

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/tokens
SDK Function Call: await BitBadgesApi.getTransferActivityForUser(address, { });

Example

typescript

const res = await BitBadgesApi.getTransferActivityForUser("bb1...", { });
console.log(res);

getUserBalances()

getUserBalances(address, payload?): Promise<GetUserBalancesSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:772

Gets the BitBadges-standard balance docs for a user.

Lean alternative to fetching /users with a tokensCollected view — returns only the balance docs (no account wrapper, no metadata). Use this when you just need the balances and want to skip the full account-fetch round trip.

Parameters

address

string

payload?

iGetUserBalancesPayload

Returns

Promise<GetUserBalancesSuccessResponse<T>>

Remarks

API Route: GET /api/v0/account/:address/balances
SDK Function Call: await BitBadgesApi.getUserBalances(address, { bookmark, limit });

Example

typescript

const res = await BitBadgesApi.getUserBalances("bb1...", { limit: 100 });
console.log(res.docs, res.pagination);

getUtilityPage()

getUtilityPage(utilityPageId, payload?): Promise<GetUtilityPageSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2063

Get utility page by ID.

Parameters

utilityPageId

string

payload?

iGetUtilityPagePayload

Returns

Promise<GetUtilityPageSuccessResponse<T>>

Remarks

API Route: GET /api/v0/utilityPage/:utilityPageId
SDK Function Call: await BitBadgesApi.getUtilityPage(utilityPageId, { ... });

Example

ts

getUtilityPages()

getUtilityPages(payload): Promise<GetUtilityPagesSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1338

Gets utility pages.

Parameters

payload

iGetUtilityPagesPayload

Returns

Promise<GetUtilityPagesSuccessResponse<T>>

Remarks

API Route: POST /api/v0/utilityPages/fetch
SDK Function Call: await BitBadgesApi.getUtilityPages(payload);

handleApiError()

handleApiError(error): Promise<void>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:95

Parameters

error

any

Returns

Promise<void>

Inherited from

BaseBitBadgesApi.handleApiError

performBatchStoreAction()

performBatchStoreAction(payload): Promise<BatchStoreActionSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1235

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.

performStoreAction()

performStoreAction(payload): Promise<PerformStoreActionSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1208

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.

refreshMetadata()

refreshMetadata(collectionId, payload?): Promise<RefreshMetadataSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:565

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

string

payload?

iRefreshMetadataPayload

Returns

Promise<RefreshMetadataSuccessResponse>

Remarks

API Route: POST /api/v0/collection/:collectionId/refresh
SDK Function Call: await BitBadgesApi.refreshMetadata(collectionId, payload);

Example

typescript

const res = await BitBadgesApi.refreshMetadata(collectionId);
console.log(res);

revokeOauthAuthorization()

revokeOauthAuthorization(payload): Promise<OauthRevokeSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1156

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);

rotateSIWBBRequest()

rotateSIWBBRequest(payload): Promise<RotateSIWBBRequestSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:957

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);

searchClaims()

searchClaims(payload): Promise<SearchClaimsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1061

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);

searchDeveloperApps()

searchDeveloperApps(payload): Promise<SearchDeveloperAppsSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2348

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);

searchDynamicDataStores()

searchDynamicDataStores<Q>(payload): Promise<SearchDynamicDataStoresSuccessResponse<Q, T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1311

Searches dynamic data stores.

Type Parameters

Q

Q extends "addresses"

Parameters

payload

iSearchDynamicDataStoresPayload

Returns

Promise<SearchDynamicDataStoresSuccessResponse<Q, T>>

Remarks

API Route: GET /api/v0/dynamicStores/search
SDK Function Call: await BitBadgesApi.searchDynamicDataStores(payload);

searchUtilityPages()

searchUtilityPages(payload): Promise<SearchUtilityPagesSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1358

Searches for utility pages.

Parameters

payload

iSearchUtilityPagesPayload

Returns

Promise<SearchUtilityPagesSuccessResponse<T>>

Remarks

API Route: GET /api/v0/utilityPages/search
SDK Function Call: await BitBadgesApi.searchUtilityPages(payload);

setAccessToken()

setAccessToken(token): void

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:85

Parameters

token

string

Returns

void

Inherited from

BaseBitBadgesApi.setAccessToken

simulateClaim()

simulateClaim(claimId, address, payload): Promise<SimulateClaimSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:622

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

typescript

const res = await BitBadgesApi.simulateClaim(claimId, address, { ...body });
console.log(res);

simulateTx()

simulateTx(payload): Promise<SimulateTxSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:852

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.

trackSkipTx()

trackSkipTx(payload): Promise<TrackSkipTxSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2678

Parameters

payload

iTrackSkipTxPayload

Returns

Promise<TrackSkipTxSuccessResponse>

Deprecated

Use trackSwap instead. This is a thin wrapper that forwards to the consolidated /swap/track endpoint.

Register a broadcast tx with cross-chain tracking.

Remarks

API Route: POST /api/v0/swap/track (was /api/v0/skip/v2/tx/track)

trackSwap()

trackSwap(payload): Promise<TrackSwapSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2567

Register a broadcast tx with the cross-chain tracker.

Parameters

payload

iTrackSwapPayload

Returns

Promise<TrackSwapSuccessResponse>

Remarks

API Route: POST /api/v0/swap/track
SDK Function Call: await BitBadgesApi.trackSwap({ txHash, chainId, tokenIn: '1000ubadge' });
When called by an authenticated user, the indexer writes a tracking doc keyed by ${txHash}-${chainId} so subsequent getSwapStatus calls can short-circuit.

unsetAccessToken()

unsetAccessToken(): void

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:90

Returns

void

Inherited from

BaseBitBadgesApi.unsetAccessToken

updateClaims()

updateClaims(payload): Promise<UpdateClaimSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1134

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.

updateDeveloperApp()

updateDeveloperApp(payload): Promise<UpdateDeveloperAppSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2219

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.

updateDynamicDataStore()

updateDynamicDataStore<Q, T>(payload): Promise<UpdateDynamicDataStoreSuccessResponse<Q, T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2271

Updates a dynamic data bin.

Type Parameters

Q

Q extends "addresses"

T

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);

updateUtilityPage()

updateUtilityPage(payload): Promise<UpdateUtilityPageSuccessResponse<T>>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1398

Updates a utility page.

Parameters

payload

iUpdateUtilityPagePayload<T>

Returns

Promise<UpdateUtilityPageSuccessResponse<T>>

Remarks

API Route: PUT /api/v0/utilityPages
SDK Function Call: await BitBadgesApi.updateUtilityPage(payload);

verifyOwnershipRequirements()

verifyOwnershipRequirements(payload): Promise<GenericVerifyAssetsSuccessResponse>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2141

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);

Edit this page on GitHub

See#

Extends#

Extended by#

Type Parameters#

T#

Constructors#

Constructor#

Parameters#

apiDetails#

Returns#

Overrides#

Properties#

accessToken#

Inherited from#

apiKey#

Inherited from#

appendedHeaders#

Inherited from#

axios#

Inherited from#

BACKEND_URL#

Inherited from#

ConvertFunction#

Parameters#

num#

Returns#

Inherited from#

Methods#

assertPositiveCollectionId()#

Parameters#

collectionId#

Returns#

Inherited from#

assertPositiveInteger()#

Parameters#

num#

Returns#

Inherited from#

broadcastTx()#

Parameters#

payload#

Returns#

Remarks#

checkClaimSuccess()#

Parameters#

claimId#

address#

Returns#

Remarks#

checkIfSignedIn()#

Parameters#

payload?#

Returns#

Remarks#

completeClaim()#

Parameters#

claimId#

address#

payload#

Returns#

Remarks#

Example#

createClaims()#

Parameters#

payload#

Returns#

Remarks#

createDeveloperApp()#

Parameters#

payload#

Returns#

Remarks#

createDynamicDataStore()#

Type Parameters#

Q#

NumberType#

Parameters#

payload#

Returns#

Remarks#

See

Extends

Extended by

Type Parameters

T

Constructors

Constructor

Parameters

apiDetails

Returns

Overrides

Properties

accessToken

Inherited from

apiKey

Inherited from

appendedHeaders

Inherited from

axios

Inherited from

BACKEND_URL

Inherited from

ConvertFunction

Parameters

num

Returns

Inherited from

Methods

assertPositiveCollectionId()

Parameters

collectionId

Returns

Inherited from

assertPositiveInteger()

Parameters

num

Returns

Inherited from

broadcastTx()

Parameters

payload

Returns

Remarks

checkClaimSuccess()

Parameters

claimId

address

Returns

Remarks

checkIfSignedIn()

Parameters

payload?

Returns

Remarks

completeClaim()

Parameters

claimId

address

payload

Returns

Remarks

Example

createClaims()

Parameters

payload

Returns

Remarks

createDeveloperApp()

Parameters

payload

Returns

Remarks

createDynamicDataStore()

Type Parameters

Q

NumberType

Parameters

payload

Returns

Remarks