BitBadges
  • Overview
    • 👋BitBadges Overview
    • 🔨Getting Started
      • Creating
      • Exploring
    • 🔐How Do I Gate XYZ?
    • 🎒Tutorials
      • Create Your First Claim
      • Gate a URL
      • Create Proof of Purchase Badge w/ Zapier
    • 🎨Use Cases
    • 🧠Concepts
      • Multi-Chain Accounts
      • BitBadges Claims
      • Applications (Points, Tiers, Quests)
      • Sign In with BitBadges
      • Badges vs Lists
      • Protocols
      • Attestations
      • Badge Concepts
        • Manager
        • Total Supplys
        • Time-Dependent Ownership
        • Balances Types
        • Transferability
        • Standards
        • Aliases
    • 🔗Official Links
    • ⚖️BitBadges L1 vs Others
    • 🪙Launch Phases
    • Wallets and Sign Ins
      • 🧩Supported Wallets
      • 📱Alternate Sign Ins / Mobile
      • Approved Transactors
    • 🌴Ecosystem
      • MetaMask Snap
      • Browser Extensions
      • LinkedIn Certifications
      • Blockin
    • 🤝Brand Guidelines
    • ❓FAQ
  • ⌨️For Developers
    • 🚴‍♂️Getting Started
    • 👤Handling Addresses
    • 🧠Concepts
      • General
        • 🔢Big Numbers
        • 🔢Uint Ranges
        • 👥Accounts (Low-Level)
        • ⏳Timelines
        • 🖼️Metadata
        • 🕒Different Time Fields
        • ✍️Custom Data
        • ⚓Anchors
      • Balances / Transfers
        • 📊Balances
        • ➕Valid Badge IDs
        • 🪙Balance Types
        • 🤝Transferability / Approvals
        • ✅Approval Criteria
          • Overview
          • $BADGE Transfers
          • Override User Level Approvals
          • Ownership Requirements
          • Approval Trackers
          • Tallied Approval Amounts
          • Max Number of Transfers
          • Predetermined Balances
          • Requires
          • Merkle Challenges
          • ZK Proofs
          • Extending the Approval (Advanced)
      • 🔐Permissions
        • Overview
        • Action Permission
        • Timed Update Permission
        • Timed Update With Badge Ids Permission
        • Badge IDs Action Permission
        • Update Approval Permission
      • 📧Address Lists
      • 🗺️Maps / Protocols
      • 🗝️Attestations
        • Overview
        • Creating an Attestation
        • Custom Creation Links
        • Proofs vs Attestations
        • Deriving a Proof
        • Design Considerations
        • Verification / Presentations
        • Custom Schemes
          • WITNESS Proofs
      • 🖊️Standards
      • 🔓Archived Collections
      • 🕵️ZK / Privacy Preservation
    • 🧪Testnet Mode
    • 📚BitBadges API
      • API
      • Upgrading an API Key Tier
      • Routes
      • Typed SDK Types
      • Tutorials
        • Fetching Collections
        • Fetching Accounts
        • Fetching Balances
        • Fetching Lists
        • Getting Claims
        • Completing Claims
        • Managing Claims
      • Concepts
        • Native Chain Algorithm
        • Refresh / Claim Completion Queue
        • Designing for Compatibility
        • Limits / Restrictions
      • Use via Pipedream
    • ⚒️BitBadges JS / SDK
      • Overview
      • SDK Types
      • Common Snippets
        • Address Conversions
        • NumberType Conversions
        • Uint Ranges
        • Balances
        • Transfers
        • Address Lists
        • Badge Metadata
        • Approvals / Transferability
        • Off-Chain Balances
        • Timelines
        • Aliases
    • 🏗️Claims / Plugins
      • Overview
      • Utility Flows
      • Signed In vs Select Address
      • Concepts
        • Standard vs On-Demand
        • Completion Methods
        • Gating Badge Distribution
        • Claim Numbers
        • Success Logic
        • Claim Links (URLs)
      • Configuring Plugins
      • Universal Approach - Claim Codes
      • Implementing Custom Utility
      • Dynamic Stores
        • Overview
        • Creating a Store
        • Attaching a Store
        • Adding Data
      • BitBadges API & Claims
        • Fetching Claims
        • Verifying Claim Attempts w/ API
        • Complete Claims w/ BitBadges API
      • Receiving Attestations
      • Custom Plugins
        • Overview
        • Pre-Built Webhook Plugins
        • Creating a Custom Plugin
          • Do You Need a Custom Plugin?
          • Implement Your Plugin
            • Getting Started
            • Hook Types and Simulations
            • Design Considerations
            • Parameters
            • Configuration Test URI
            • User Inputs
            • API Handler
            • AI Prompts
            • Custom User Input Frontends (Advanced)
          • Managing Your Plugin
          • Testing Your Plugin
        • Created Plugins
          • Plugins Directory
          • Number of Uses
          • Signed in to BitBadges
          • Socials / Email Plugins
          • Codes
          • Password
          • Transfer Times
          • Whitelist
          • Halt
          • IP Restrictions
          • Geolocation
          • Discord Server
          • Twitch Follow / Subscription
          • GitHub Contributions
          • Min $BADGE
          • Ownership Requirements
        • Configuration Tools
      • Integrate with Zapier
        • Overview
        • Dynamic Store Zaps
        • Automatic Claim Tutorial
        • Post-Success Zaps
        • Automate Any Part of the Process
          • Google Forms
      • Integrate with Pipedream
        • Overview
        • Build Custom Plugins
        • Workflow Actions
          • Complete Claim
          • Get Claim Attempt Status
          • Get Claim Code by Idx
          • Add User to Dynamic Store
        • Workflow Triggers
          • Poll Claim Attempts
        • End to End Example
      • Tutorials
        • In-Site Guides
        • Get Integration User IDs
          • Get Discord User ID
          • Get Discord Server ID
          • X / Twitch / GitHub IDs
        • Payment Checking
        • Add Telegram Bot to Channel
    • 💾Self-Hosted Balances
      • Overview
      • Examples / Tutorials
        • Indexed
        • Non-Indexed
    • 🖱️Sign In with BitBadges
      • Overview
      • Alternative - P2P Verification
      • Setting Up an App
      • Connecting a Claim
      • Templates and Frameworks
        • Auth.js (Next Auth)
        • Auth0
        • ExpressJS
        • Discourse
      • What If I Need Wallets On App Side?
      • Authorization URL
        • Configuration
        • Generating the URL
      • Approaches
        • QR Codes
        • Redirect Callback
      • Verification
        • Verification Flow
        • Access Tokens
        • Offline Verification
        • Security Considerations
      • Blockin Docs
    • 🔃Create, Generate, and Sign Txs
      • Transaction Context
      • Generate Msg Contents
      • Signing - Cosmos
      • Signing - Ethereum
      • Signing - Solana
      • Signing - Bitcoin
      • Broadcast to a Node
      • Sign + Broadcast - bitbadges.io
    • ⛓️BitBadges Blockchain
      • Overview
      • Chain Details
      • REST API Docs - Node
      • Staking / Validators
      • Run a Node
        • Overview
        • Run a Mainnet Node
        • Run a Local Dev Node
        • Cosmovisor
      • Create a Smart Contract
    • 📩Cosmos SDK Msgs
      • x/anchor
        • MsgAddCustomData
      • x/badges
        • MsgCreateCollection
        • MsgUpdateCollection
        • MsgDeleteCollection
        • MsgCreateAddressLists
        • MsgTransferBadges
        • MsgUpdateUserApprovals
        • MsgUniversalUpdateCollection
      • x/wasmx
        • MsgStoreCodeCompat
        • MsgInstantiateContractCompat
        • MsgExecuteContractCompat
      • x/maps
        • MsgCreateMap
        • MsgUpdateMap
        • MsgDeleteMap
        • MsgSetValue
      • MsgSend
      • Cosmos Native Msgs
    • 👨‍💻Contributing
    • 🧑‍🏫Other References
Powered by GitBook
On this page
  1. For Developers
  2. BitBadges API

Tutorials

PreviousUpgrading an API Key TierNextFetching Collections

Last updated 11 months ago

⌨️
📚
Fetching Collections
Fetching Accounts
Fetching Balances
Fetching Lists
Getting Claims
Completing Claims
Managing Claims