# Class: BitBadgesAPI\ Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:364](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L364) 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](https://docs.bitbadges.io/for-developers/bitbadges-api/api) ## Extends - [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api)\<`T`\> ## Extended by - [`BitBadgesAdminAPI`](https://docs.bitbadges.io/sdk/reference/classes/bit-badges-admin-api) ## Type Parameters ### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ## Constructors ### Constructor > **new BitBadgesAPI**\<`T`\>(`apiDetails`): `BitBadgesAPI`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:372](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L372) #### Parameters ##### apiDetails [`iBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/interfaces/i-bit-badges-api)\<`T`\> #### Returns `BitBadgesAPI`\<`T`\> #### Overrides [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#constructor) ## Properties ### accessToken > **accessToken**: `string` = `''` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/base.ts:63](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L63) #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`accessToken`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#accesstoken) *** ### apiKey > **apiKey**: `string` \| `undefined` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/base.ts:62](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L62) #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`apiKey`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#apikey) *** ### appendedHeaders > **appendedHeaders**: `Record`\<`string`, `string`\> = `{}` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/base.ts:64](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L64) #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`appendedHeaders`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#appendedheaders) *** ### axios > **axios**: `AxiosInstance` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/base.ts:59](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L59) #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`axios`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#axios) *** ### BACKEND\_URL > **BACKEND\_URL**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/base.ts:60](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L60) #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`BACKEND_URL`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#backend_url) *** ### ConvertFunction > **ConvertFunction**: (`num`) => `T` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/base.ts:61](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L61) #### Parameters ##### num [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `T` #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`ConvertFunction`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#convertfunction) ## Methods ### assertPositiveCollectionId() > **assertPositiveCollectionId**(`collectionId`): `void` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/base.ts:118](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L118) #### Parameters ##### collectionId `string` #### Returns `void` #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`assertPositiveCollectionId`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#assertpositivecollectionid) *** ### assertPositiveInteger() > **assertPositiveInteger**(`num`): `void` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/base.ts:106](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L106) #### Parameters ##### num [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `void` #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`assertPositiveInteger`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#assertpositiveinteger) *** ### broadcastTx() > **broadcastTx**(`payload`): `Promise`\<[`BroadcastTxSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/broadcast-tx-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:827](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L827) Broadcasts a transaction to the blockchain. #### Parameters ##### payload `string` \| [`BroadcastPostBody`](https://docs.bitbadges.io/sdk/reference/interfaces/broadcast-post-body) #### Returns `Promise`\<[`BroadcastTxSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/broadcast-tx-success-response)\> #### 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](https://bitbadges.io/dev/broadcast), 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`](https://docs.bitbadges.io/sdk/reference/classes/check-claim-success-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1462](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1462) Checks if a claim has been successfully completed. #### Parameters ##### claimId `string` ##### address `string` #### Returns `Promise`\<[`CheckClaimSuccessSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/check-claim-success-success-response)\> #### Remarks - **API Route**: `GET /api/v0/claims/success/:claimId/:address` - **SDK Function Call**: `await BitBadgesApi.checkClaimSuccess(claimId, address);` *** ### checkIfSignedIn() > **checkIfSignedIn**(`payload?`): `Promise`\<[`CheckSignInStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/check-sign-in-status-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:799](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L799) Checks if the user is signed in. #### Parameters ##### payload? [`iCheckSignInStatusPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-check-sign-in-status-payload) #### Returns `Promise`\<[`CheckSignInStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/check-sign-in-status-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/complete-claim-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:586](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L586) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/i-complete-claim-payload) #### Returns `Promise`\<[`CompleteClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/complete-claim-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/create-claim-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1086](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1086) Creates a claim. #### Parameters ##### payload [`iCreateClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-create-claim-payload) #### Returns `Promise`\<[`CreateClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/create-claim-success-response)\> #### Remarks - **API Route**: `POST /api/v0/claims` - **SDK Function Call**: `await BitBadgesApi.createClaim(payload);` - **Authentication**: Must be signed in. *** ### createDeveloperApp() > **createDeveloperApp**(`payload`): `Promise`\<[`CreateDeveloperAppSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/create-developer-app-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2167](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2167) Creates an developer app. #### Parameters ##### payload [`iCreateDeveloperAppPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-create-developer-app-payload) #### Returns `Promise`\<[`CreateDeveloperAppSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/create-developer-app-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/create-dynamic-data-store-success-response)\<`Q`, `T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2244](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2244) Creates a dynamic data bin. #### Type Parameters ##### Q `Q` *extends* `"addresses"` ##### NumberType `NumberType` #### Parameters ##### payload [`iCreateDynamicDataStorePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-create-dynamic-data-store-payload) #### Returns `Promise`\<[`CreateDynamicDataStoreSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/create-dynamic-data-store-success-response)\<`Q`, `T`\>\> #### Remarks - **API Route**: `POST /api/v0/dynamicStores` - **SDK Function Call**: `await BitBadgesApi.createDynamicDataStore(payload);` *** ### createSIWBBRequest() > **createSIWBBRequest**(`payload?`): `Promise`\<[`CreateSIWBBRequestSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/create-siwbb-request-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:932](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L932) Creates a SIWBB request. #### Parameters ##### payload? [`iCreateSIWBBRequestPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-create-siwbb-request-payload) #### Returns `Promise`\<[`CreateSIWBBRequestSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/create-siwbb-request-success-response)\> #### Remarks - **API Route**: `POST /api/v0/siwbbRequest` - **SDK Function Call**: `await BitBadgesApi.createSIWBBRequest(payload);` *** ### createUtilityPage() > **createUtilityPage**(`payload`): `Promise`\<[`CreateUtilityPageSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/create-utility-page-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1378](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1378) Creates a utility page. #### Parameters ##### payload [`iCreateUtilityPagePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-create-utility-page-payload)\<`T`\> #### Returns `Promise`\<[`CreateUtilityPageSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/create-utility-page-success-response)\<`T`\>\> #### Remarks - **API Route**: `POST /api/v0/utilityPages` - **SDK Function Call**: `await BitBadgesApi.createUtilityPage(payload);` *** ### deleteClaims() > **deleteClaims**(`payload`): `Promise`\<[`DeleteClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-claim-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1109](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1109) Deletes a claim. #### Parameters ##### payload [`iDeleteClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-delete-claim-payload) #### Returns `Promise`\<[`DeleteClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-claim-success-response)\> #### Remarks - **API Route**: `DELETE /api/v0/claims` - **SDK Function Call**: `await BitBadgesApi.deleteClaim(payload);` - **Authentication**: Must be signed in. *** ### deleteDeveloperApp() > **deleteDeveloperApp**(`payload`): `Promise`\<[`DeleteDeveloperAppSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-developer-app-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2193](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2193) Deletes an developer app. #### Parameters ##### payload [`iDeleteDeveloperAppPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-delete-developer-app-payload) #### Returns `Promise`\<[`DeleteDeveloperAppSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-developer-app-success-response)\> #### Remarks - **API Route**: `DELETE /api/v0/developerApps` - **SDK Function Call**: `await BitBadgesApi.deleteDeveloperApp(payload);` - **Authentication**: Must be signed in. *** ### deleteDynamicDataStore() > **deleteDynamicDataStore**(`payload`): `Promise`\<[`DeleteDynamicDataStoreSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-dynamic-data-store-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2298](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2298) Deletes a dynamic data bin. #### Parameters ##### payload [`iDeleteDynamicDataStorePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-delete-dynamic-data-store-payload) #### Returns `Promise`\<[`DeleteDynamicDataStoreSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-dynamic-data-store-success-response)\> #### Remarks - **API Route**: `DELETE /api/v0/dynamicStores` - **SDK Function Call**: `await BitBadgesApi.deleteDynamicDataStore(payload);` *** ### deleteSIWBBRequest() > **deleteSIWBBRequest**(`payload?`): `Promise`\<[`DeleteSIWBBRequestSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-siwbb-request-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:983](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L983) Deletes a SIWBB request. #### Parameters ##### payload? [`iDeleteSIWBBRequestPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-delete-siwbb-request-payload) #### Returns `Promise`\<[`DeleteSIWBBRequestSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-siwbb-request-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/delete-utility-page-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1418](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1418) Deletes a utility page. #### Parameters ##### payload [`iDeleteUtilityPagePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-delete-utility-page-payload) #### Returns `Promise`\<[`DeleteUtilityPageSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/delete-utility-page-success-response)\> #### Remarks - **API Route**: `DELETE /api/v0/utilityPages` - **SDK Function Call**: `await BitBadgesApi.deleteUtilityPage(payload);` *** ### estimateSwap() > **estimateSwap**(`payload`): `Promise`\<[`iEstimateSwapSuccessResponse`](https://docs.bitbadges.io/sdk/reference/interfaces/i-estimate-swap-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2528](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2528) Estimate a swap from a token-in denom to a token-out denom across one or more chains. #### Parameters ##### payload [`iEstimateSwapPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-estimate-swap-payload) #### Returns `Promise`\<[`iEstimateSwapSuccessResponse`](https://docs.bitbadges.io/sdk/reference/interfaces/i-estimate-swap-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/interfaces/i-estimate-swap-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2552](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2552) #### Parameters ##### payload [`iEstimateSwapPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-estimate-swap-payload) #### Returns `Promise`\<[`iEstimateSwapSuccessResponse`](https://docs.bitbadges.io/sdk/reference/interfaces/i-estimate-swap-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/exchange-siwbb-authorization-code-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:874](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L874) Gets and verifies a SIWBB request. #### Parameters ##### payload? [`iExchangeSIWBBAuthorizationCodePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-exchange-siwbb-authorization-code-payload) #### Returns `Promise`\<[`ExchangeSIWBBAuthorizationCodeSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/exchange-siwbb-authorization-code-success-response)\<`T`\>\> #### Remarks - **API Route**: `POST /api/v0/siwbbRequest` - **SDK Function Call**: `await BitBadgesApi.exchangeSIWBBAuthorizationCode(payload);` *** ### filterCollectionApprovals() > **filterCollectionApprovals**(`collectionId`, `payload`): `Promise`\<[`FilterCollectionApprovalsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/filter-collection-approvals-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2734](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2734) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/i-filter-collection-approvals-payload) #### Returns `Promise`\<[`FilterCollectionApprovalsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/filter-collection-approvals-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/filter-tokens-in-collection-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1019](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1019) Filters tokens in a collection based on multiple filter values. #### Parameters ##### collectionId `string` ##### payload [`iFilterTokensInCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-filter-tokens-in-collection-payload) #### Returns `Promise`\<[`FilterTokensInCollectionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/filter-tokens-in-collection-success-response)\<`T`\>\> #### Remarks - **API Route**: `POST /api/v0/collection/:collectionId/filter` - **SDK Function Call**: `await BitBadgesApi.FilterTokensInCollection(payload);` *** ### getAccount() > **getAccount**(`payload`): `Promise`\<[`GetAccountSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-account-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:750](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L750) Gets an account by address or username. #### Parameters ##### payload [`iGetAccountPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-account-payload) #### Returns `Promise`\<[`GetAccountSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-account-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-accounts-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:733](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L733) Gets accounts and accompying details. #### Parameters ##### payload [`iGetAccountsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-accounts-payload) #### Returns `Promise`\<[`GetAccountsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-accounts-success-response)\<`T`\>\> #### Remarks - **API Route**: `POST /api/v0/users` - **SDK Function Call**: `await BitBadgesApi.getAccounts(payload);` - **Tutorial**: See the [Fetching Accounts tutoral](https://docs.bitbadges.io/for-developers/bitbadges-api/tutorials/fetching-accounts) 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`](https://docs.bitbadges.io/sdk/reference/classes/get-balance-by-address-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:484](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L484) Gets the balance of a specific token for a specific address #### Parameters ##### collectionId `string` ##### address `string` ##### payload? [`iGetBalanceByAddressPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-balance-by-address-payload) #### Returns `Promise`\<[`GetBalanceByAddressSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-balance-by-address-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-balance-by-address-specific-token-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:506](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L506) Gets the balance for an address at the current time. This is a streamlined version of getBalanceByAddress. #### Parameters ##### collectionId `string` ##### tokenId [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ##### address `string` ##### payload? [`iGetBalanceByAddressPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-balance-by-address-payload) ##### options? ###### time? [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Promise`\<[`GetBalanceByAddressSpecificTokenSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-balance-by-address-specific-token-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-claim-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1915](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1915) Get a claim by ID. #### Parameters ##### claimId `string` ##### payload? [`iGetClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload) #### Returns `Promise`\<[`GetClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-claim-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-claim-activity-for-user-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1594](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1594) Gets claim activity by type for a specific user. Specify the viewType to determine what claim activity to retrieve. #### Parameters ##### address `string` ##### payload [`iGetClaimActivityForUserPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-activity-for-user-payload) #### Returns `Promise`\<[`GetClaimActivityForUserSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-claim-activity-for-user-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-claim-attempts-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1437](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1437) Gets claim attempts. #### Parameters ##### claimId `string` ##### payload [`iGetClaimAttemptsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-attempts-payload) #### Returns `Promise`\<[`GetClaimAttemptsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-claim-attempts-success-response)\<`T`\>\> #### Remarks - **API Route**: `GET /api/v0/claims/:claimId/attempts` - **SDK Function Call**: `await BitBadgesApi.getClaimAttempts(claimId, payload);` *** ### getClaimAttemptStatus() > **getClaimAttemptStatus**(`claimAttemptId`): `Promise`\<[`GetClaimAttemptStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-claim-attempt-status-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:697](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L697) Gets the status of a claim attempt. #### Parameters ##### claimAttemptId `string` #### Returns `Promise`\<[`GetClaimAttemptStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-claim-attempt-status-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-claims-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1039](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1039) Gets the claim by ID. #### Parameters ##### payload [`iGetClaimsPayloadV1`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claims-payload-v1) #### Returns `Promise`\<[`GetClaimsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-claims-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1695](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1695) Gets a specific collection. #### Parameters ##### collectionId `string` ##### payload? [`iGetCollectionPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-collection-payload) #### Returns `Promise`\<[`GetCollectionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-amount-tracker-by-id-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2373](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2373) Gets a specific amount tracker by ID for a collection #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### trackerDetails [`iAmountTrackerIdDetails`](https://docs.bitbadges.io/sdk/reference/interfaces/i-amount-tracker-id-details)\<`T`\> #### Returns `Promise`\<[`GetCollectionAmountTrackerByIdSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-amount-tracker-by-id-success-response)\<`T`\>\> #### Remarks - **API Route**: `GET /api/v0/collection/amountTracker` - **SDK Function Call**: `await BitBadgesApi.getCollectionAmountTrackerById(...);` *** ### getCollectionAmountTrackers() > **getCollectionAmountTrackers**(`collectionId`, `payload`): `Promise`\<[`GetCollectionAmountTrackersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-amount-trackers-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1818](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1818) Gets amount trackers for a specific collection. #### Parameters ##### collectionId `string` ##### payload [`iGetCollectionAmountTrackersPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-collection-amount-trackers-payload) #### Returns `Promise`\<[`GetCollectionAmountTrackersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-amount-trackers-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-challenge-tracker-by-id-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2395](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2395) Gets a specific challenge tracker by ID for a collection #### Type Parameters ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### trackerDetails [`iChallengeTrackerIdDetails`](https://docs.bitbadges.io/sdk/reference/interfaces/i-challenge-tracker-id-details)\<`T`\> #### Returns `Promise`\<[`GetCollectionChallengeTrackerByIdSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-challenge-tracker-by-id-success-response)\<`T`\>\> #### Remarks - **API Route**: `GET /api/v0/collection/challengeTracker` - **SDK Function Call**: `await BitBadgesApi.getCollectionChallengeTrackerById(...);` *** ### getCollectionChallengeTrackers() > **getCollectionChallengeTrackers**(`collectionId`, `payload`): `Promise`\<[`GetCollectionChallengeTrackersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-challenge-trackers-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1782](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1782) Gets challenge trackers for a specific collection. #### Parameters ##### collectionId `string` ##### payload [`iGetCollectionChallengeTrackersPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-collection-challenge-trackers-payload) #### Returns `Promise`\<[`GetCollectionChallengeTrackersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-challenge-trackers-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-claims-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1890](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1890) Gets claims for a specific collection. #### Parameters ##### collectionId `string` #### Returns `Promise`\<[`GetCollectionClaimsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-claims-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-listings-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1854](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1854) Gets listings for a specific collection. #### Parameters ##### collectionId `string` ##### payload [`iGetCollectionListingsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-collection-listings-payload) #### Returns `Promise`\<[`GetCollectionListingsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-listings-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-owners-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1662](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1662) Gets owners for a specific collection. #### Parameters ##### collectionId `string` ##### payload [`iGetCollectionOwnersPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-collection-owners-payload) #### Returns `Promise`\<[`GetCollectionOwnersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-owners-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-collections-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:450](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L450) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-collections-payload) #### Returns `Promise`\<[`GetCollectionsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collections-success-response)\<`T`\>\> #### Remarks - **API Route**: `POST /api/v0/collections` - **Tutorial**: Refer to the [Fetching Collections tutorial](https://docs.bitbadges.io/for-developers/bitbadges-api/tutorials/fetching-collections) 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`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-transfer-activity-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1746](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1746) Gets transfer activity for a specific collection. #### Parameters ##### collectionId `string` ##### payload [`iGetCollectionTransferActivityPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-collection-transfer-activity-payload) #### Returns `Promise`\<[`GetCollectionTransferActivitySuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-collection-transfer-activity-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-developer-app-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2094](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2094) Get developer app by ID. #### Parameters ##### developerAppId `string` ##### payload? [`iGetDeveloperAppPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-developer-app-payload) #### Returns `Promise`\<[`GetDeveloperAppSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-developer-app-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-developer-apps-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2323](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2323) Get all developer apps for a user. #### Parameters ##### payload [`iGetDeveloperAppsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-developer-apps-payload) #### Returns `Promise`\<[`GetDeveloperAppsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-developer-apps-success-response)\<`T`\>\> #### Remarks - **API Route**: `POST /api/v0/developerApps` - **SDK Function Call**: `await BitBadgesApi.getDeveloperApp(payload);` *** ### getDynamicDataActivity() > **getDynamicDataActivity**(`payload`): `Promise`\<[`GetDynamicDataActivitySuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-activity-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1264](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1264) Get dynamic data store activity #### Parameters ##### payload [`iGetDynamicDataActivityPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-dynamic-data-activity-payload) #### Returns `Promise`\<[`GetDynamicDataActivitySuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-activity-success-response)\> #### Remarks - **API Route**: `GET /api/v0/dynamicStores/activity` - **SDK Function Call**: `await BitBadgesApi.getDynamicDataActivity(payload);` *** ### getDynamicDataStore() > **getDynamicDataStore**\<`Q`\>(`dynamicStoreId`, `payload?`): `Promise`\<[`GetDynamicDataStoreSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-store-success-response)\<`Q`, `T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1945](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1945) Get a dynamic data store by ID. #### Type Parameters ##### Q `Q` *extends* `"addresses"` #### Parameters ##### dynamicStoreId `string` ##### payload? [`iGetDynamicDataStorePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-dynamic-data-store-payload) #### Returns `Promise`\<[`GetDynamicDataStoreSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-store-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-stores-success-response)\<`Q`, `T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1284](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1284) Gets dynamic data stores. #### Type Parameters ##### Q `Q` *extends* `"addresses"` ##### NumberType `NumberType` #### Parameters ##### payload [`iGetDynamicDataStoresPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-dynamic-data-stores-payload) #### Returns `Promise`\<[`GetDynamicDataStoresSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-stores-success-response)\<`Q`, `T`\>\> #### Remarks - **API Route**: `POST /api/v0/dynamicStores/fetch` - **SDK Function Call**: `await BitBadgesApi.getDynamicDataStores(payload);` *** ### getDynamicDataStoreValue() > **getDynamicDataStoreValue**(`dynamicStoreId`, `payload?`): `Promise`\<[`GetDynamicDataStoreValueSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-store-value-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1973](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1973) Get a dynamic data store value by ID. #### Parameters ##### dynamicStoreId `string` ##### payload? [`iGetDynamicDataStoreValuePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-dynamic-data-store-value-payload) #### Returns `Promise`\<[`GetDynamicDataStoreValueSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-store-value-success-response)\> #### Remarks - **API Route**: `GET /api/v0/dynamicStore/:dynamicStoreId/:key` - **SDK Function Call**: `await BitBadgesApi.getDynamicDataStoreValue(dynamicStoreId, { ... });` *** ### getDynamicDataStoreValuesPaginated() > **getDynamicDataStoreValuesPaginated**\<`Q`\>(`dynamicStoreId`, `payload?`): `Promise`\<[`GetDynamicDataStoreValuesPaginatedSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-store-values-paginated-success-response)\<`Q`, `T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2001](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2001) Get a dynamic data store values paginated by ID. #### Type Parameters ##### Q `Q` *extends* `"addresses"` #### Parameters ##### dynamicStoreId `string` ##### payload? [`iGetDynamicDataStoreValuesPaginatedPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-dynamic-data-store-values-paginated-payload) #### Returns `Promise`\<[`GetDynamicDataStoreValuesPaginatedSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-dynamic-data-store-values-paginated-success-response)\<`Q`, `T`\>\> #### Remarks - **API Route**: `GET /api/v0/dynamicStore/:dynamicStoreId/values` - **SDK Function Call**: `await BitBadgesApi.getDynamicDataStoreValuesPaginated(dynamicStoreId, { ... });` *** ### getGatedContentForClaim() > **getGatedContentForClaim**(`claimId`, `payload?`): `Promise`\<[`GetGatedContentForClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-gated-content-for-claim-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1179](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1179) Get the gated content for a claim. #### Parameters ##### claimId `string` ##### payload? [`iGetGatedContentForClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-gated-content-for-claim-payload) #### Returns `Promise`\<[`GetGatedContentForClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-gated-content-for-claim-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-intents-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2707](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2707) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-intents-payload) #### Returns `Promise`\<[`GetIntentsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-intents-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-on-chain-dynamic-store-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2768](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2768) Get On-Chain Dynamic Store by ID #### Parameters ##### storeId `string` #### Returns `Promise`\<[`GetOnChainDynamicStoreSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-on-chain-dynamic-store-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-on-chain-dynamic-stores-by-creator-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2793](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2793) Get On-Chain Dynamic Stores by Creator #### Parameters ##### address `string` #### Returns `Promise`\<[`GetOnChainDynamicStoresByCreatorSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-on-chain-dynamic-stores-by-creator-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-on-chain-dynamic-store-value-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2818](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2818) Get On-Chain Dynamic Store Value #### Parameters ##### storeId `string` ##### address `string` #### Returns `Promise`\<[`GetOnChainDynamicStoreValueSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-on-chain-dynamic-store-value-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-on-chain-dynamic-store-values-paginated-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2846](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2846) Get On-Chain Dynamic Store Values (Paginated) #### Parameters ##### storeId `string` ##### payload? [`iGetOnChainDynamicStoreValuesPaginatedPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-on-chain-dynamic-store-values-paginated-payload) #### Returns `Promise`\<[`GetOnChainDynamicStoreValuesPaginatedSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-on-chain-dynamic-store-values-paginated-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-owners-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:467](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L467) Gets the owners for a specific token in a collection #### Parameters ##### collectionId `string` ##### tokenId [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ##### payload [`iGetOwnersPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-owners-payload) #### Returns `Promise`\<[`GetOwnersSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-owners-success-response)\<`T`\>\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-plugin-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2037](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2037) Get plugin by ID. #### Parameters ##### pluginId `string` ##### payload? [`iGetPluginPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-plugin-payload) #### Returns `Promise`\<[`GetPluginSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-plugin-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-plugins-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2119](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2119) Get all developer apps for a user. #### Parameters ##### payload [`iGetPluginsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-plugins-payload) #### Returns `Promise`\<[`GetPluginsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-plugins-success-response)\<`T`\>\> #### Remarks - **API Route**: `POST /api/v0/plugins/fetch` - **SDK Function Call**: `await BitBadgesApi.getPlugins(payload);` *** ### getPointsActivityForUser() > **getPointsActivityForUser**(`address`, `payload`): `Promise`\<[`GetPointsActivityForUserSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-points-activity-for-user-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1628](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1628) Gets points activity for a specific user. #### Parameters ##### address `string` ##### payload [`iGetPointsActivityForUserPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-points-activity-for-user-payload) #### Returns `Promise`\<[`GetPointsActivityForUserSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-points-activity-for-user-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/refresh-status-success-response)\<[`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type)\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1008](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1008) 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`](https://docs.bitbadges.io/sdk/reference/classes/refresh-status-success-response)\<[`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type)\>\> #### Remarks - **API Route**: `GET /api/v0/collection/:collectionId/refreshStatus` - **SDK Function Call**: `await BitBadgesApi.getRefreshStatus(payload);` *** ### getReservedClaimCodes() > **getReservedClaimCodes**(`claimId`, `address`, `payload`): `Promise`\<[`GetReservedClaimCodesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-reserved-claim-codes-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:658](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L658) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-reserved-claim-codes-payload) #### Returns `Promise`\<[`GetReservedClaimCodesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-reserved-claim-codes-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-search-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:419](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L419) Search collections, tokens, accounts based on a search value. #### Parameters ##### searchValue `string` ##### payload? [`iGetSearchPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-search-payload)\<[`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type)\> #### Returns `Promise`\<[`GetSearchSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-search-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-siwbb-requests-for-developer-app-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:903](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L903) Gets the SIWBB requests for a specific developer app. #### Parameters ##### payload [`iGetSIWBBRequestsForDeveloperAppPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-siwbb-requests-for-developer-app-payload) #### Returns `Promise`\<[`GetSIWBBRequestsForDeveloperAppSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-siwbb-requests-for-developer-app-success-response)\<`T`\>\> #### Remarks - **API Route**: `GET /api/v0/developerApps/siwbbRequests` - **SDK Function Call**: `await BitBadgesApi.getSIWBBRequestsForDeveloperApp(payload);` *** ### getSiwbbRequestsForUser() > **getSiwbbRequestsForUser**(`address`, `payload`): `Promise`\<[`GetSiwbbRequestsForUserSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-siwbb-requests-for-user-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1487](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1487) Gets Sign-In with BitBadges (SIWBB) requests (authentication requests) for a user. #### Parameters ##### address `string` ##### payload [`iGetSiwbbRequestsForUserPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-siwbb-requests-for-user-payload) #### Returns `Promise`\<[`GetSiwbbRequestsForUserSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-siwbb-requests-for-user-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-skip-assets-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2633](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2633) #### Parameters ##### payload? [`iGetSkipAssetsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-skip-assets-payload) #### Returns `Promise`\<[`GetSkipAssetsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-skip-assets-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-skip-balances-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2663](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2663) #### Parameters ##### payload [`iGetSkipBalancesPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-skip-balances-payload) #### Returns `Promise`\<[`GetSkipBalancesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-skip-balances-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-skip-chains-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2649](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2649) #### Parameters ##### payload? [`iGetSkipChainsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-skip-chains-payload) #### Returns `Promise`\<[`GetSkipChainsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-skip-chains-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-skip-tx-status-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2692](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2692) #### Parameters ##### payload [`iGetSkipTxStatusPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-skip-tx-status-payload) #### Returns `Promise`\<[`GetSkipTxStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-skip-tx-status-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-status-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:389](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L389) Gets the current status details about the blockchain / indexer (gas, block height, etc). #### Parameters ##### payload? [`iGetStatusPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-status-payload) #### Returns `Promise`\<[`GetStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-status-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-activities-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2423](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2423) Get Swap Activities #### Parameters ##### payload? [`iGetSwapActivitiesPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-swap-activities-payload) #### Returns `Promise`\<[`GetSwapActivitiesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-activities-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-assets-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2450](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2450) Get consolidated cross-chain assets (Skip:Go + CoinsRegistry + verified BitBadges asset metadata). #### Parameters ##### payload? [`iGetSwapAssetsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-swap-assets-payload) #### Returns `Promise`\<[`GetSwapAssetsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-assets-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-balances-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2502](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2502) Get consolidated cross-chain balances for one or more (chain, address) pairs. #### Parameters ##### payload [`iGetSwapBalancesPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-swap-balances-payload) #### Returns `Promise`\<[`GetSwapBalancesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-balances-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-chains-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2476](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2476) Get cross-chain chain registry (Skip:Go chains filtered to BitBadges-allowed chains). #### Parameters ##### payload? [`iGetSwapChainsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-swap-chains-payload) #### Returns `Promise`\<[`GetSwapChainsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-chains-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-status-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2593](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2593) Get the status of a tracked swap transaction. #### Parameters ##### payload [`iGetSwapStatusPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-swap-status-payload) #### Returns `Promise`\<[`GetSwapStatusSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-swap-status-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/get-token-activity-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:542](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L542) Gets the activity for a specific token in a collection #### Parameters ##### collectionId `string` ##### tokenId [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ##### payload [`iGetTokenActivityPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-token-activity-payload) #### Returns `Promise`\<[`GetTokenActivitySuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-token-activity-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-token-metadata-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1721](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1721) Gets current metadata for a specific token in a collection. #### Parameters ##### collectionId `string` ##### tokenId [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Returns `Promise`\<[`GetTokenMetadataSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-token-metadata-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-tokens-view-for-user-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1560](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1560) Gets tokens for a specific user. Specify the viewType to determine what tokens to retrieve. #### Parameters ##### address `string` ##### payload [`iGetTokensViewForUserPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-tokens-view-for-user-payload) #### Returns `Promise`\<[`GetTokensViewForUserSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-tokens-view-for-user-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-transfer-activity-for-user-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1523](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1523) Gets transfer activity for a specific user. #### Parameters ##### address `string` ##### payload [`iGetTransferActivityForUserPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-transfer-activity-for-user-payload) #### Returns `Promise`\<[`GetTransferActivityForUserSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-transfer-activity-for-user-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-user-balances-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:772](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L772) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-user-balances-payload) #### Returns `Promise`\<[`GetUserBalancesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-user-balances-success-response)\<`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`](https://docs.bitbadges.io/sdk/reference/classes/get-utility-page-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2063](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2063) Get utility page by ID. #### Parameters ##### utilityPageId `string` ##### payload? [`iGetUtilityPagePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-utility-page-payload) #### Returns `Promise`\<[`GetUtilityPageSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-utility-page-success-response)\<`T`\>\> #### Remarks - **API Route**: `GET /api/v0/utilityPage/:utilityPageId` - **SDK Function Call**: `await BitBadgesApi.getUtilityPage(utilityPageId, { ... });` #### Example ```ts ``` *** ### getUtilityPages() > **getUtilityPages**(`payload`): `Promise`\<[`GetUtilityPagesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-utility-pages-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1338](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1338) Gets utility pages. #### Parameters ##### payload [`iGetUtilityPagesPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-utility-pages-payload) #### Returns `Promise`\<[`GetUtilityPagesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/get-utility-pages-success-response)\<`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](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L95) #### Parameters ##### error `any` #### Returns `Promise`\<`void`\> #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`handleApiError`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#handleapierror) *** ### performBatchStoreAction() > **performBatchStoreAction**(`payload`): `Promise`\<[`BatchStoreActionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/batch-store-action-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1235](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1235) Performs multiple actions for a dynamicStore in batch. #### Parameters ##### payload [`iPerformStoreActionBatchWithBodyAuthPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-perform-store-action-batch-with-body-auth-payload) #### Returns `Promise`\<[`BatchStoreActionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/batch-store-action-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/perform-store-action-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1208](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1208) Performs an action for a dynamicStore. #### Parameters ##### payload [`iPerformStoreActionSingleWithBodyAuthPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-perform-store-action-single-with-body-auth-payload) #### Returns `Promise`\<[`PerformStoreActionSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/perform-store-action-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/refresh-metadata-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:565](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L565) 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`](https://docs.bitbadges.io/sdk/reference/interfaces/i-refresh-metadata-payload) #### Returns `Promise`\<[`RefreshMetadataSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/refresh-metadata-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/oauth-revoke-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1156](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1156) Revokes an access token for a user. #### Parameters ##### payload [`iOauthRevokePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-oauth-revoke-payload) #### Returns `Promise`\<[`OauthRevokeSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/oauth-revoke-success-response)\> #### Remarks - **API Route**: `POST /api/v0/siwbb/token/revoke` - **SDK Function Call**: `await BitBadgesApi.oauthRevoke(payload);` *** ### rotateSIWBBRequest() > **rotateSIWBBRequest**(`payload`): `Promise`\<[`RotateSIWBBRequestSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/rotate-siwbb-request-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:957](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L957) Rotates a SIWBB request. #### Parameters ##### payload [`iRotateSIWBBRequestPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-rotate-siwbb-request-payload) #### Returns `Promise`\<[`RotateSIWBBRequestSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/rotate-siwbb-request-success-response)\> #### Remarks - **API Route**: `POST /api/v0/siwbbRequest/rotate` - **SDK Function Call**: `await BitBadgesApi.rotateSIWBBRequest(payload);` *** ### searchClaims() > **searchClaims**(`payload`): `Promise`\<[`SearchClaimsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/search-claims-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1061](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1061) Searches for claims. #### Parameters ##### payload [`iSearchClaimsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-search-claims-payload) #### Returns `Promise`\<[`SearchClaimsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/search-claims-success-response)\<`T`\>\> #### Remarks - **API Route**: `GET /api/v0/claims/search` - **SDK Function Call**: `await BitBadgesApi.searchClaims(payload);` *** ### searchDeveloperApps() > **searchDeveloperApps**(`payload`): `Promise`\<[`SearchDeveloperAppsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/search-developer-apps-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2348](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2348) Searches for developer apps. #### Parameters ##### payload [`iSearchDeveloperAppsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-search-developer-apps-payload) #### Returns `Promise`\<[`SearchDeveloperAppsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/search-developer-apps-success-response)\<`T`\>\> #### Remarks - **API Route**: `GET /api/v0/developerApps/search` - **SDK Function Call**: `await BitBadgesApi.searchDeveloperApps(payload);` *** ### searchDynamicDataStores() > **searchDynamicDataStores**\<`Q`\>(`payload`): `Promise`\<[`SearchDynamicDataStoresSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/search-dynamic-data-stores-success-response)\<`Q`, `T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1311](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1311) Searches dynamic data stores. #### Type Parameters ##### Q `Q` *extends* `"addresses"` #### Parameters ##### payload [`iSearchDynamicDataStoresPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-search-dynamic-data-stores-payload) #### Returns `Promise`\<[`SearchDynamicDataStoresSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/search-dynamic-data-stores-success-response)\<`Q`, `T`\>\> #### Remarks - **API Route**: `GET /api/v0/dynamicStores/search` - **SDK Function Call**: `await BitBadgesApi.searchDynamicDataStores(payload);` *** ### searchUtilityPages() > **searchUtilityPages**(`payload`): `Promise`\<[`SearchUtilityPagesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/search-utility-pages-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1358](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1358) Searches for utility pages. #### Parameters ##### payload [`iSearchUtilityPagesPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-search-utility-pages-payload) #### Returns `Promise`\<[`SearchUtilityPagesSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/search-utility-pages-success-response)\<`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](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L85) #### Parameters ##### token `string` #### Returns `void` #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`setAccessToken`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#setaccesstoken) *** ### simulateClaim() > **simulateClaim**(`claimId`, `address`, `payload`): `Promise`\<[`SimulateClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/simulate-claim-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:622](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L622) Simulates a claim attempt. A success response means the claim is valid and can be completed. #### Parameters ##### claimId `string` ##### address `string` ##### payload [`iSimulateClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-simulate-claim-payload) #### Returns `Promise`\<[`SimulateClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/simulate-claim-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/simulate-tx-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:852](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L852) Simulates a transaction on the blockchain. #### Parameters ##### payload `string` \| [`BroadcastPostBody`](https://docs.bitbadges.io/sdk/reference/interfaces/broadcast-post-body) #### Returns `Promise`\<[`SimulateTxSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/simulate-tx-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/track-skip-tx-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2678](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2678) #### Parameters ##### payload [`iTrackSkipTxPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-track-skip-tx-payload) #### Returns `Promise`\<[`TrackSkipTxSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/track-skip-tx-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/track-swap-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2567](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2567) Register a broadcast tx with the cross-chain tracker. #### Parameters ##### payload [`iTrackSwapPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-track-swap-payload) #### Returns `Promise`\<[`TrackSwapSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/track-swap-success-response)\> #### 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](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/base.ts#L90) #### Returns `void` #### Inherited from [`BaseBitBadgesApi`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api).[`unsetAccessToken`](https://docs.bitbadges.io/sdk/reference/classes/base-bit-badges-api#unsetaccesstoken) *** ### updateClaims() > **updateClaims**(`payload`): `Promise`\<[`UpdateClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/update-claim-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1134](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1134) Update an claim. #### Parameters ##### payload [`iUpdateClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-update-claim-payload) #### Returns `Promise`\<[`UpdateClaimSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/update-claim-success-response)\> #### Remarks - **API Route**: `PUT /api/v0/claims` - **SDK Function Call**: `await BitBadgesApi.updateClaim(payload);` - **Authentication**: Must be signed in. *** ### updateDeveloperApp() > **updateDeveloperApp**(`payload`): `Promise`\<[`UpdateDeveloperAppSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/update-developer-app-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2219](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2219) Update an developer app. #### Parameters ##### payload [`iUpdateDeveloperAppPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-update-developer-app-payload) #### Returns `Promise`\<[`UpdateDeveloperAppSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/update-developer-app-success-response)\> #### 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`](https://docs.bitbadges.io/sdk/reference/classes/update-dynamic-data-store-success-response)\<`Q`, `T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2271](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2271) Updates a dynamic data bin. #### Type Parameters ##### Q `Q` *extends* `"addresses"` ##### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### payload [`iUpdateDynamicDataStorePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-update-dynamic-data-store-payload) #### Returns `Promise`\<[`UpdateDynamicDataStoreSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/update-dynamic-data-store-success-response)\<`Q`, `T`\>\> #### Remarks - **API Route**: `PUT /api/v0/dynamicStores` - **SDK Function Call**: `await BitBadgesApi.updateDynamicDataStore(payload);` *** ### updateUtilityPage() > **updateUtilityPage**(`payload`): `Promise`\<[`UpdateUtilityPageSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/update-utility-page-success-response)\<`T`\>\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:1398](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L1398) Updates a utility page. #### Parameters ##### payload [`iUpdateUtilityPagePayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-update-utility-page-payload)\<`T`\> #### Returns `Promise`\<[`UpdateUtilityPageSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/update-utility-page-success-response)\<`T`\>\> #### Remarks - **API Route**: `PUT /api/v0/utilityPages` - **SDK Function Call**: `await BitBadgesApi.updateUtilityPage(payload);` *** ### verifyOwnershipRequirements() > **verifyOwnershipRequirements**(`payload`): `Promise`\<[`GenericVerifyAssetsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/generic-verify-assets-success-response)\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts:2141](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesApi.ts#L2141) A generic route for verifying asset ownership requirements. Asset requirements support AND / OR / NOT logic. #### Parameters ##### payload [`iGenericVerifyAssetsPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-generic-verify-assets-payload) #### Returns `Promise`\<[`GenericVerifyAssetsSuccessResponse`](https://docs.bitbadges.io/sdk/reference/classes/generic-verify-assets-success-response)\> #### Remarks - **API Route**: `POST /api/v0/verifyOwnershipRequirements` - **SDK Function Call**: `await BitBadgesApi.verifyOwnershipRequirements(payload);`