Skip to content
HeartBadge docs

TypeScript SDK

Live

The official TypeScript client for the HeartBadge APIs.

The TypeScript SDK (@heartbadge/sdk) wraps every public API with typed methods, handles request signing automatically, and provides helpers for webhook verification.

This page is being written.

The structure is fixed. The prose is being drafted from the source material and reviewed by HeartChain Labs before publication. If you need this information urgently, email docs@heartbadge.com .

What this page will cover

  • Installation
  • Initializing the client with operator credentials
  • Method catalog: badges, rewards, gifts, webhooks
  • Webhook signature verification helper
  • Error types and handling
  • TypeScript version requirements