🔨Getting Started

BitBadges is proud to offer no-code / low-code flows for all our major services. Simply navigate to the Create tab in-site, and get started creating tokens, claims, address lists, explore listings, applications, and more!

Need help? Join our Discord for support from the BitBadges team and community developers.
Need BADGE? Contact us on Discord - get subsidized credits for developers during chaosnet!
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! 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!

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 https://bitbadges.io/create.

Quick Start - Tokens

📚Overview

Quick Start - Claims

🎁BitBadges Claims

Quick Start - API

📚BitBadges API ⚒️BitBadges JS / SDK

npm i bitbadgesjs-sdk

import { BitBadgesAPI } from 'bitbadgesjs-sdk';

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

await BitBadgesAPI.getCollection(...);

Quick Start - MCP Builder Tools (AI)

The BitBadges MCP server gives any AI assistant (Claude, Cursor, etc.) 30+ tools to build, audit, sign, and broadcast BitBadges transactions — no manual JSON required.

# Install globally
npm install -g bitbadges-builder-mcp

# Or run directly with npx
npx bitbadges-builder-mcp

Claude Desktop — add to claude_desktop_config.json:

{
  "mcpServers": {
    "bitbadges-builder": {
      "command": "npx",
      "args": ["-y", "bitbadges-builder-mcp"],
      "env": {
        "BITBADGES_API_KEY": "your-api-key"
      }
    }
  }
}

Claude Code:

claude mcp add bitbadges-builder -- npx -y bitbadges-builder-mcp

See the full MCP Builder Tools Reference for all tools, schemas, and workflows. For bot/agent guides, see AI Agents & Bots.

Developing with AI

Below, we provide some resources that may be helpful for developing with AI. If there is anything else we can do to make development easier, let us know!

Resource

Link

MCP Builder Tools

npm i -g bitbadges-builder-mcp — Reference

BitBadges SDK

npm i bitbadgesjs-sdk — Docs

AI Quickstarter Repo

github.com/BitBadges/bitbadges-quickstarter-ai

GitBook MCP

docs.bitbadges.io/~gitbook/mcp — searchDocumentation tool

API OpenAPI Spec

openapi.json