🚴‍♂️Getting Started

Need help? Join our Discord for support from the BitBadges team and community developers.

Need $BADGE credits? Contact us on Discord - we offer subsidized credits for developers during beta!

No-Code / In-Site Solutions Check out the Create tab or the developer portal first to see what all is possible. Most of the time, you can just do everything with no code directly in-site!

Video Tutorial Series Check out our three intro to development video tutorial courses (Intro to BitBadges, The BitBadges Token Standard, and Developing MultiChain Applications).

Quick Start Guide

1. Install the SDK and use the API:

npm i bitbadgesjs-sdk

import { BitBadgesAPI } from 'bitbadgesjs-sdk';

const api = new BitBadgesAPI({
  ...YOUR_CONFIG
});

await BitBadgesAPI.getCollections(...);

1. Try our interactive quickstart demo: BitBadges Quickstart. If that is what you need, clone it: BitBadges Quickstart Repository

   • Includes authentication, transactions, self-hosting, and API examples

   • Multiple flavors available (e.g., Tailwind CSS)

   • Open for community contributions!

Additional Resources:

• Auth.js/Next.js Template

Development Paths

1. Creating Badges, Lists, Claims, & Attestations

• Get Started: Use the Create tab on BitBadges web app

• Self-Hosted / Advanced Solutions:

  • Host your own off-chain balances or metadata

  • Control off-chain badge allocation via your server

  • Integrate with Web2 data (e.g., subscription status)

  • Learn more about balance types

  • Test and manage claims in the developer portal

  • Build custom claim plugins

🏗️Claims / Plugins

2. Creating a Custom App / Use Case?

• Use BitBadges API and SDK for data queries

• Use Sign In with BitBadges for multi-chain authentication / API scope authorizations

  • One interface, all chains!

• Create custom claims and check any criteria you want behind the scenes seamlessly!

  • Claim checks which means you can check criteria like badge ownership or anything from 7000+ integrations

  • Directly receive private attestation data or other sign in data

• Run custom indexers for specialized data needs

🖱️Sign In with BitBadges

3. Integration Options

• Integrate BitBadges Into Your App: Use our API/SDK

• Integrate Your Tool Into BitBadges:

  • Create custom claim plugins

  • Create badges, listings, address lists, anything else

  • Contact us for native integration options

4. Blockchain

Transaction Management Options:

• Recommended: Use the BitBadges web app Create tab

• Alternative Methods:

  1. Use our helper in-site broadcast tool. This even supports redirects with custom inputs!

  2. Generate transactions via SDK

  3. Use blockchain node CLI (BitBadges addresses only)

Other Options:

• Run a Node for direct blockchain interaction

• Create CosmWasm smart contracts

• Extend functionality with BitBadges SDK