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 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.

Index

Constructors

constructor

Properties

accessToken apiKey appendedHeaders axios BACKEND_URL ConvertFunction

Methods

assertPositiveCollectionId assertPositiveInteger broadcastTx calculatePoints checkClaimSuccess checkIfSignedIn completeClaim createApplication createClaims createDeveloperApp createDynamicDataStore createSIWBBRequest createUtilityPage deleteApplication deleteClaims deleteDeveloperApp deleteDynamicDataStore deleteSIWBBRequest deleteUtilityPage exchangeSIWBBAuthorizationCode FilterTokensInCollection getAccount getAccounts getApplication getApplications getAttemptDataFromRequestBin getBalanceByAddress getBalanceByAddressSpecificToken getClaim getClaimActivityForUser getClaimAttempts getClaimAttemptStatus getClaims getCollection getCollectionAmountTrackerById getCollectionAmountTrackers getCollectionChallengeTrackerById getCollectionChallengeTrackers getCollectionClaims getCollectionListings getCollectionOwners getCollections getCollectionTransferActivity getDeveloperApp getDeveloperApps getDynamicDataActivity getDynamicDataStore getDynamicDataStores getDynamicDataStoreValue getDynamicDataStoreValuesPaginated getGatedContentForClaim getMap getMaps getMapValue getMapValues getOwners getPlugin getPlugins getPointsActivity getPointsActivityForUser getRefreshStatus getReservedClaimCodes getSearchResults getSIWBBRequestsForDeveloperApp getSiwbbRequestsForUser getStatus getTokenActivity getTokenMetadata getTokensViewForUser getTransferActivityForUser getUtilityPage getUtilityPages handleApiError performBatchStoreAction performStoreAction refreshMetadata revokeOauthAuthorization rotateSIWBBRequest searchApplications searchClaims searchDeveloperApps searchDynamicDataStores searchUtilityPages setAccessToken simulateClaim simulateTx unsetAccessToken updateApplication updateClaims updateDeveloperApp updateDynamicDataStore updateUtilityPage verifyOwnershipRequirements

Constructors

constructor

new BitBadgesAPI<T extends NumberType>(
apiDetails: iBitBadgesApi<T>,
): BitBadgesAPI<T>
Type Parameters
- T extends NumberType
Parameters
- apiDetails: iBitBadgesApi<T>
Returns BitBadgesAPI<T>
Overrides BaseBitBadgesApi.constructor
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:299

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

assertPositiveCollectionId

assertPositiveCollectionId(collectionId: string): void
Parameters
- collectionId: string
Returns void
Inherited from BaseBitBadgesApi.assertPositiveCollectionId
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:121

assertPositiveInteger

assertPositiveInteger(num: NumberType): void
Parameters
- num: NumberType
Returns void
Inherited from BaseBitBadgesApi.assertPositiveInteger
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:109

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:716

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1439

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1608

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:688

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:512

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1363

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1060

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2344

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2421

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:821

createUtilityPage

createUtilityPage(
payload: iCreateUtilityPagePayload<T>,
): Promise<CreateUtilityPageSuccessResponse<T>>
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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1524

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1415

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1083

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2370

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2475

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:872

deleteUtilityPage

deleteUtilityPage(
payload: iDeleteUtilityPagePayload,
): Promise<DeleteUtilityPageSuccessResponse>
Deletes a utility page.
Parameters
- payload: iDeleteUtilityPagePayload
Returns Promise<DeleteUtilityPageSuccessResponse>
Remarks
- API Route: DELETE /api/v0/utilityPages
- SDK Function Call: await BitBadgesApi.deleteUtilityPage(payload);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1564

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:763

FilterTokensInCollection

FilterTokensInCollection(
collectionId: string,
payload: iFilterTokensInCollectionPayload,
): Promise<FilterTokensInCollectionSuccessResponse<T>>
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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:993

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:676

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:659

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2091

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1312

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2594

getBalanceByAddress

getBalanceByAddress(
    collectionId: string,
    address: string,
    payload?: iGetBalanceByAddressPayload,
): Promise<GetBalanceByAddressSuccessResponse<T>>
Gets the balance of a specific token for a specific address
Parameters
- collectionId: string
- address: string
- Optionalpayload: iGetBalanceByAddressPayload
Returns Promise<GetBalanceByAddressSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collection/:collectionId/balance/:address
- SDK Function Call: await BitBadgesApi.getBalanceByAddress(collectionId, address);
Example
```
const res = await BitBadgesApi.getBalanceByAddress(collectionId, address);
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:411

getBalanceByAddressSpecificToken

getBalanceByAddressSpecificToken(
    collectionId: string,
    tokenId: NumberType,
    address: string,
    payload?: iGetBalanceByAddressPayload,
): Promise<GetBalanceByAddressSuccessResponse<T>>
Gets the balance for an address at the current time. This is a streamlined version of getBalanceByAddress.
Parameters
- collectionId: string
- tokenId: NumberType
- address: string
- Optionalpayload: iGetBalanceByAddressPayload
Returns Promise<GetBalanceByAddressSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/:tokenId/balance/:address
- SDK Function Call: await BitBadgesApi.getBalanceByAddress(collectionId, tokenId, address);
Example
```
const res = await BitBadgesApi.getBalanceByAddress(collectionId, tokenId, address);
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:433

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2061

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1740

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1583

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:623

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1013

getCollection

getCollection(
collectionId: string,
payload?: iGetCollectionPayload,
): Promise<GetCollectionSuccessResponse<T>>
Gets a specific collection.
Parameters
- collectionId: string
- 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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1841

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(...);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2550

getCollectionAmountTrackers

getCollectionAmountTrackers(
collectionId: string,
payload: iGetCollectionAmountTrackersPayload,
): Promise<GetCollectionAmountTrackersSuccessResponse<T>>
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
```
const res = await BitBadgesApi.getCollectionAmountTrackers("123", { bookmark: "123" });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1964

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(...);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2572

getCollectionChallengeTrackers

getCollectionChallengeTrackers(
collectionId: string,
payload: iGetCollectionChallengeTrackersPayload,
): Promise<GetCollectionChallengeTrackersSuccessResponse<T>>
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
```
const res = await BitBadgesApi.getCollectionChallengeTrackers("123", { bookmark: "123" });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1928

getCollectionClaims

getCollectionClaims(
collectionId: string,
): Promise<GetCollectionClaimsSuccessResponse<T>>
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
```
const res = await BitBadgesApi.getCollectionClaims("123");
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2036

getCollectionListings

getCollectionListings(
collectionId: string,
payload: iGetCollectionListingsPayload,
): Promise<GetCollectionListingsSuccessResponse<T>>
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
```
const res = await BitBadgesApi.getCollectionListings("123", { bookmark: "123" });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2000

getCollectionOwners

getCollectionOwners(
collectionId: string,
payload: iGetCollectionOwnersPayload,
): Promise<GetCollectionOwnersSuccessResponse<T>>
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
```
const res = await BitBadgesApi.getCollectionOwners("123", { bookmark: "123" });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1808

getCollections

getCollections(
payload: iGetCollectionsPayload,
): Promise<GetCollectionsSuccessResponse<T>>
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
```
const res = await BitBadgesApi.getCollections([{ collectionId, metadataToFetch: { tokenIds: [{ start: 1n, end: 10n }] } }]);
const collection = res.collections[0];
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:377

getCollectionTransferActivity

getCollectionTransferActivity(
collectionId: string,
payload: iGetCollectionTransferActivityPayload,
): Promise<GetCollectionTransferActivitySuccessResponse<T>>
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
```
const res = await BitBadgesApi.getCollectionTransferActivity("123", { bookmark: "123" });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1892

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2271

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2500

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1238

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2122

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1258

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, { ... });
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2150

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, { ... });
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2178

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1153

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:930

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:908

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:976

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:954

getOwners

getOwners(
    collectionId: string,
    tokenId: NumberType,
    payload: iGetOwnersPayload,
): Promise<GetOwnersSuccessResponse<T>>
Gets the owners for a specific token in a collection
Parameters
- collectionId: string
- tokenId: NumberType
- payload: iGetOwnersPayload
Returns Promise<GetOwnersSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/:tokenId/owners
- SDK Function Call: await BitBadgesApi.getOwners(collectionId, tokenId, payload);
Example
```
const res = await BitBadgesApi.getOwners(collectionId, tokenId, { bookmark: 'prev' });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:394

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2214

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2296

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1459

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1774

getRefreshStatus

getRefreshStatus(
collectionId: string,
): 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: string
Returns Promise<RefreshStatusSuccessResponse<NumberType>>
Remarks
- API Route: GET /api/v0/collection/:collectionId/refreshStatus
- SDK Function Call: await BitBadgesApi.getRefreshStatus(payload);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:897

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:584

getSearchResults

getSearchResults(
searchValue: string,
payload?: iGetSearchPayload<NumberType>,
): Promise<GetSearchSuccessResponse<T>>
Search collections, tokens, accounts 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', {  noCollections: true });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:346

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:792

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1633

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:316

getTokenActivity

getTokenActivity(
    collectionId: string,
    tokenId: NumberType,
    payload: iGetTokenActivityPayload,
): Promise<GetTokenActivitySuccessResponse<T>>
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
```
const res = await BitBadgesApi.getTokenActivity(collectionId, tokenId, { bookmark: 'prev' });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:468

getTokenMetadata

getTokenMetadata(
collectionId: string,
tokenId: NumberType,
): Promise<GetTokenMetadataSuccessResponse<T>>
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
```
const res = await BitBadgesApi.getTokenMetadata("123", "456");
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1867

getTokensViewForUser

getTokensViewForUser(
address: string,
payload: iGetTokensViewForUserPayload,
): Promise<GetTokensViewForUserSuccessResponse<T>>
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/badges
- SDK Function Call: await BitBadgesApi.getTokensViewForUser(address, { viewType });
Example
```
const res = await BitBadgesApi.getTokensViewForUser("bb1...", { viewType: "collected" });
console.log(res);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1706

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1669

getUtilityPage

getUtilityPage(
utilityPageId: string,
payload?: iGetUtilityPagePayload,
): Promise<GetUtilityPageSuccessResponse<T>>
Get utility page by ID.
Parameters
- utilityPageId: string
- Optionalpayload: iGetUtilityPagePayload
Returns Promise<GetUtilityPageSuccessResponse<T>>
Remarks
- API Route: GET /api/v0/utilityPage/:utilityPageId
- SDK Function Call: await BitBadgesApi.getUtilityPage(utilityPageId, { ... });
Example
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2240

getUtilityPages

getUtilityPages(
payload: iGetUtilityPagesPayload,
): Promise<GetUtilityPagesSuccessResponse<T>>
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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1484

handleApiError

handleApiError(error: any): Promise<void>
Parameters
- error: any
Returns Promise<void>
Inherited from BaseBitBadgesApi.handleApiError
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:98

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1209

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1182

refreshMetadata

refreshMetadata(
collectionId: string,
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: string
- 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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:491

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1130

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:846

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1337

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1035

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2525

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1285

searchUtilityPages

searchUtilityPages(
payload: iSearchUtilityPagesPayload,
): Promise<SearchUtilityPagesSuccessResponse<T>>
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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1504

setAccessToken

setAccessToken(token: string): void
Parameters
- token: string
Returns void
Inherited from BaseBitBadgesApi.setAccessToken
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:88

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);
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:548

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:741

unsetAccessToken

unsetAccessToken(): void
Returns void
Inherited from BaseBitBadgesApi.unsetAccessToken
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:93

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1389

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1108

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.
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2396

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2448

updateUtilityPage

updateUtilityPage(
payload: iUpdateUtilityPagePayload<T>,
): Promise<UpdateUtilityPageSuccessResponse<T>>
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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1544

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);
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2318

Class BitBadgesAPI<T>

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BitBadgesAPI<T>

Properties

accessToken

apiKey

appendedHeaders

axios

BACKEND_URL

ConvertFunction

Methods

assertPositiveCollectionId

Parameters

Returns void

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

createApplication

Parameters

Returns Promise<CreateApplicationSuccessResponse<T>>

Remarks

createClaims

Parameters

Returns Promise<CreateClaimSuccessResponse>

Remarks

createDeveloperApp

Parameters

Returns Promise<CreateDeveloperAppSuccessResponse>

Remarks

createDynamicDataStore

Type Parameters

Parameters

Returns Promise<CreateDynamicDataStoreSuccessResponse<Q, T>>

Remarks

createSIWBBRequest

Parameters

Returns Promise<CreateSIWBBRequestSuccessResponse>

Remarks

createUtilityPage

Parameters

Returns Promise<CreateUtilityPageSuccessResponse<T>>

Remarks

deleteApplication

Parameters

Returns Promise<DeleteApplicationSuccessResponse>

Remarks

deleteClaims

Parameters

Returns Promise<DeleteClaimSuccessResponse>