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 or the first to see what all is possible. Most of the time, you can just do everything with no code directly in-site! No need for any direct integration. Let us handle everything!
Get creative. You can gate URLs, Discords, and integrate with many of your favorite tools without a single line of code!
Video Tutorial Series Check out our three intro to development video tutorial courses (, , and ).

Explore First, Read Later

We strongly recommend, if you have not already, to explore the claim tester and other creation options in-site. Many of your questions should be answered by the interface and is much easier to understand than a bunch of long text here in this documentation. Just go explore and experiment first.

Most of your setup and management (and oftentimes all) will be done directly in-site via the developer portal or Create tab. Get started at .

Gate Any Service In 2 Steps

Any service can be gated by ANY criteria simply in just 2 steps.

Authenticate - We recommend Sign In with BitBadges but it could be any approach

Verify Claim Success - Check the user satisfies a BitBadges claim (via post-success hooks, API, many ways!)

Claims are the universal connectors. Claim criteria can be anything from a payment to badge ownership to Discord servers. Implement it any way you want (including custom logic) at !

Quick Start - Claims

This includes documentation everything from custom plugins to Zapier to dynamic stores and mroe

Quick Start - API

npm i bitbadgesjs-sdk

import { BitBadgesAPI } from 'bitbadgesjs-sdk';

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

await BitBadgesAPI.getCollection(...);

PreviousFAQ NextHandling Addresses

Last updated 1 month ago

Explore First, Read Later

Most of your setup and management (and oftentimes all) will be done directly in-site via the developer portal or Create tab. Get started at .

Gate Any Service In 2 Steps

Any service can be gated by ANY criteria simply in just 2 steps.

Authenticate - We recommend Sign In with BitBadges but it could be any approach

Verify Claim Success - Check the user satisfies a BitBadges claim (via post-success hooks, API, many ways!)

Claims are the universal connectors. Claim criteria can be anything from a payment to badge ownership to Discord servers. Implement it any way you want (including custom logic) at !

Quick Start - API

📚BitBadges API

⚒️BitBadges JS / SDK

🖱️Sign In with BitBadges

npm i bitbadgesjs-sdk

import { BitBadgesAPI } from 'bitbadgesjs-sdk';

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

await BitBadgesAPI.getCollection(...);

Try our interactive quickstart demo: . If that is what you need, clone it: . Or, see out .