Class BitBadgesApiRoutes

Exports static methods that return the routes for the BitBadges API. Append this to the base URL of the API to get the full URL.

Example

import { BitBadgesApiRoutes } from 'bitbadgesjs-sdk'
const url = `https://api.bitbadges.io${BitBadgesApiRoutes.GetStatusRoute()}`

Index

Constructors

constructor

Methods

AddApprovalDetailsToOffChainStorageRoute AddBalancesToOffChainStorageRoute AddReviewRoute AddToIpfsRoute BroadcastTxRoute CRUDAddressListsRoute CRUDAttestationProofRoute CRUDAttestationRoute CRUDClaimsRoute CRUDDeveloperAppRoute CRUDPluginRoute CRUDSIWBBRequestRoute CheckIfSignedInRoute CompleteClaimRoute DeleteReviewRoute ExchangeSIWBBAuthorizationCodesRoute FetchMetadataDirectlyRoute FilterBadgesInCollectionRoute FilterSuggestionsRoute GenerateAppleWalletPassRoute GenerateGoogleWalletPassRoute GenericVerifyAssetsRoute GenericVerifyRoute GetAccountsRoute GetActiveAuthorizationsRoute GetAddressListsRoute GetAttestationProofsRoute GetAttestationsRoute GetBadgeActivityRoute GetBadgeBalanceByAddressRoute GetBrowseCollectionsRoute GetClaimAlertsRoute GetClaimAttemptStatusRoute GetClaimsRoute GetCollectionsRoute GetDeveloperAppsRoute GetMapValuesRoute GetMapsRoute GetOwnersForBadgeRoute GetPluginRoute GetRefreshStatusRoute GetReservedClaimCodesRoute GetSIWBBRequestsForDeveloperAppRoute GetSignInChallengeRoute GetStatusRoute GetTokensFromFaucetRoute OauthRevokeRoute RefreshMetadataRoute RotateSIWBBRequestRoute SearchRoute SendClaimAlertRoute SignOutRoute SimulateClaimRoute SimulateTxRoute UpdateAccountInfoRoute VerifySignInRoute

Constructors

constructor

new BitBadgesApiRoutes(): BitBadgesApiRoutes
Returns BitBadgesApiRoutes

Methods

`Static` AddApprovalDetailsToOffChainStorageRoute

AddApprovalDetailsToOffChainStorageRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:51

`Static` AddBalancesToOffChainStorageRoute

AddBalancesToOffChainStorageRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:52

`Static` AddReviewRoute

AddReviewRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:41

`Static` AddToIpfsRoute

AddToIpfsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:50

`Static` BroadcastTxRoute

BroadcastTxRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:61

`Static` CRUDAddressListsRoute

CRUDAddressListsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:45

`Static` CRUDAttestationProofRoute

CRUDAttestationProofRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:81

`Static` CRUDAttestationRoute

CRUDAttestationRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:78

`Static` CRUDClaimsRoute

CRUDClaimsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:39

`Static` CRUDDeveloperAppRoute

CRUDDeveloperAppRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:84

`Static` CRUDPluginRoute

CRUDPluginRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:88

`Static` CRUDSIWBBRequestRoute

CRUDSIWBBRequestRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:70

`Static` CheckIfSignedInRoute

CheckIfSignedInRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:57

`Static` CompleteClaimRoute

CompleteClaimRoute(claimId, address): string
Parameters
- claimId: string
- address: string
Returns string
- Defined in src/api-indexer/requests/routes.ts:33

`Static` DeleteReviewRoute

DeleteReviewRoute(reviewId): string
Parameters
- reviewId: string
Returns string
- Defined in src/api-indexer/requests/routes.ts:42

`Static` ExchangeSIWBBAuthorizationCodesRoute

ExchangeSIWBBAuthorizationCodesRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:69

`Static` FetchMetadataDirectlyRoute

FetchMetadataDirectlyRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:63

`Static` FilterBadgesInCollectionRoute

FilterBadgesInCollectionRoute(collectionId): string
Parameters
- collectionId: NumberType
Returns string
- Defined in src/api-indexer/requests/routes.ts:28

`Static` FilterSuggestionsRoute

FilterSuggestionsRoute(collectionId): string
Parameters
- collectionId: NumberType
Returns string
- Defined in src/api-indexer/requests/routes.ts:29

`Static` GenerateAppleWalletPassRoute

GenerateAppleWalletPassRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:74

`Static` GenerateGoogleWalletPassRoute

GenerateGoogleWalletPassRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:75

`Static` GenericVerifyAssetsRoute

GenericVerifyAssetsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:31

`Static` GenericVerifyRoute

GenericVerifyRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:72

`Static` GetAccountsRoute

GetAccountsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:47

`Static` GetActiveAuthorizationsRoute

GetActiveAuthorizationsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:93

`Static` GetAddressListsRoute

GetAddressListsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:44

`Static` GetAttestationProofsRoute

GetAttestationProofsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:80

`Static` GetAttestationsRoute

GetAttestationsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:77

`Static` GetBadgeActivityRoute

GetBadgeActivityRoute(collectionId, badgeId): string
Parameters
- collectionId: NumberType
- badgeId: NumberType
Returns string
- Defined in src/api-indexer/requests/routes.ts:24

`Static` GetBadgeBalanceByAddressRoute

GetBadgeBalanceByAddressRoute(collectionId, cosmosAddress): string
Parameters
- collectionId: NumberType
- cosmosAddress: string
Returns string
- Defined in src/api-indexer/requests/routes.ts:22

`Static` GetBrowseCollectionsRoute

GetBrowseCollectionsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:59

`Static` GetClaimAlertsRoute

GetClaimAlertsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:67

`Static` GetClaimAttemptStatusRoute

GetClaimAttemptStatusRoute(claimAttemptId): string
Parameters
- claimAttemptId: string
Returns string
- Defined in src/api-indexer/requests/routes.ts:36

`Static` GetClaimsRoute

GetClaimsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:38

`Static` GetCollectionsRoute

GetCollectionsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:18

`Static` GetDeveloperAppsRoute

GetDeveloperAppsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:83

`Static` GetMapValuesRoute

GetMapValuesRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:91

`Static` GetMapsRoute

GetMapsRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:90

`Static` GetOwnersForBadgeRoute

GetOwnersForBadgeRoute(collectionId, badgeId): string
Parameters
- collectionId: NumberType
- badgeId: NumberType
Returns string
- Defined in src/api-indexer/requests/routes.ts:20

`Static` GetPluginRoute

GetPluginRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:87

`Static` GetRefreshStatusRoute

GetRefreshStatusRoute(collectionId): string
Parameters
- collectionId: NumberType
Returns string
- Defined in src/api-indexer/requests/routes.ts:27

`Static` GetReservedClaimCodesRoute

GetReservedClaimCodesRoute(claimId, address): string
Parameters
- claimId: string
- address: string
Returns string
- Defined in src/api-indexer/requests/routes.ts:35

`Static` GetSIWBBRequestsForDeveloperAppRoute

GetSIWBBRequestsForDeveloperAppRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:85

`Static` GetSignInChallengeRoute

GetSignInChallengeRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:54

`Static` GetStatusRoute

GetStatusRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:16

`Static` GetTokensFromFaucetRoute

GetTokensFromFaucetRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:64

`Static` OauthRevokeRoute

OauthRevokeRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:94

`Static` RefreshMetadataRoute

RefreshMetadataRoute(collectionId): string
Parameters
- collectionId: NumberType
Returns string
- Defined in src/api-indexer/requests/routes.ts:26

`Static` RotateSIWBBRequestRoute

RotateSIWBBRequestRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:71

`Static` SearchRoute

SearchRoute(searchValue): string
Parameters
- searchValue: string
Returns string
- Defined in src/api-indexer/requests/routes.ts:17

`Static` SendClaimAlertRoute

SendClaimAlertRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:66

`Static` SignOutRoute

SignOutRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:56

`Static` SimulateClaimRoute

SimulateClaimRoute(claimId, address): string
Parameters
- claimId: string
- address: string
Returns string
- Defined in src/api-indexer/requests/routes.ts:34

`Static` SimulateTxRoute

SimulateTxRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:62

`Static` UpdateAccountInfoRoute

UpdateAccountInfoRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:48

`Static` VerifySignInRoute

VerifySignInRoute(): string
Returns string
- Defined in src/api-indexer/requests/routes.ts:55

Class BitBadgesApiRoutes

Example

Index

Constructors

Methods

Constructors

constructor

Returns BitBadgesApiRoutes

Methods

Static AddApprovalDetailsToOffChainStorageRoute

Returns string

Static AddBalancesToOffChainStorageRoute

Returns string

Static AddReviewRoute

Returns string

Static AddToIpfsRoute

Returns string

Static BroadcastTxRoute

Returns string

Static CRUDAddressListsRoute

Returns string

Static CRUDAttestationProofRoute

Returns string

Static CRUDAttestationRoute

Returns string

Static CRUDClaimsRoute

Returns string

Static CRUDDeveloperAppRoute

Returns string

Static CRUDPluginRoute

Returns string

Static CRUDSIWBBRequestRoute

Returns string

Static CheckIfSignedInRoute

Returns string

Static CompleteClaimRoute

Parameters

Returns string

Static DeleteReviewRoute

Parameters

Returns string

Static ExchangeSIWBBAuthorizationCodesRoute

Returns string

Static FetchMetadataDirectlyRoute

Returns string

Static FilterBadgesInCollectionRoute

Parameters

Returns string

Static FilterSuggestionsRoute

Parameters

Returns string

Static GenerateAppleWalletPassRoute

Returns string

Static GenerateGoogleWalletPassRoute

Returns string

Static GenericVerifyAssetsRoute

Returns string

Static GenericVerifyRoute

Returns string

Static GetAccountsRoute

Returns string

Static GetActiveAuthorizationsRoute

Returns string

Static GetAddressListsRoute

Returns string

Static GetAttestationProofsRoute

Returns string

Static GetAttestationsRoute

Returns string

Static GetBadgeActivityRoute

Parameters

Returns string

Static GetBadgeBalanceByAddressRoute

Parameters

Returns string

Static GetBrowseCollectionsRoute

Returns string

Static GetClaimAlertsRoute

Returns string

Static GetClaimAttemptStatusRoute

`Static` AddApprovalDetailsToOffChainStorageRoute

`Static` AddBalancesToOffChainStorageRoute

`Static` AddReviewRoute

`Static` AddToIpfsRoute

`Static` BroadcastTxRoute

`Static` CRUDAddressListsRoute

`Static` CRUDAttestationProofRoute

`Static` CRUDAttestationRoute

`Static` CRUDClaimsRoute

`Static` CRUDDeveloperAppRoute

`Static` CRUDPluginRoute

`Static` CRUDSIWBBRequestRoute

`Static` CheckIfSignedInRoute

`Static` CompleteClaimRoute

`Static` DeleteReviewRoute

`Static` ExchangeSIWBBAuthorizationCodesRoute

`Static` FetchMetadataDirectlyRoute

`Static` FilterBadgesInCollectionRoute

`Static` FilterSuggestionsRoute

`Static` GenerateAppleWalletPassRoute

`Static` GenerateGoogleWalletPassRoute

`Static` GenericVerifyAssetsRoute

`Static` GenericVerifyRoute

`Static` GetAccountsRoute

`Static` GetActiveAuthorizationsRoute

`Static` GetAddressListsRoute

`Static` GetAttestationProofsRoute

`Static` GetAttestationsRoute

`Static` GetBadgeActivityRoute

`Static` GetBadgeBalanceByAddressRoute

`Static` GetBrowseCollectionsRoute

`Static` GetClaimAlertsRoute

`Static` GetClaimAttemptStatusRoute

`Static` GetClaimsRoute

`Static` GetCollectionsRoute

`Static` GetDeveloperAppsRoute

`Static` GetMapValuesRoute

`Static` GetMapsRoute

`Static` GetOwnersForBadgeRoute

`Static` GetPluginRoute

`Static` GetRefreshStatusRoute

`Static` GetReservedClaimCodesRoute

`Static` GetSIWBBRequestsForDeveloperAppRoute

`Static` GetSignInChallengeRoute

`Static` GetStatusRoute

`Static` GetTokensFromFaucetRoute

`Static` OauthRevokeRoute

`Static` RefreshMetadataRoute

`Static` RotateSIWBBRequestRoute

`Static` SearchRoute

`Static` SendClaimAlertRoute

`Static` SignOutRoute

`Static` SimulateClaimRoute

`Static` SimulateTxRoute

`Static` UpdateAccountInfoRoute

`Static` VerifySignInRoute