Getting Started
Choose how you want to integrate with Gearbox Markets.
Integration Paths
| Path | Best For | Status |
|---|---|---|
| TypeScript (SDK) | Frontend apps, bots, analytics dashboards, backend services | Available |
| GraphQL | Querying indexed data, dashboards, lightweight integrations | Coming soon |
TypeScript SDK
The Gearbox SDK provides typed access to protocol state and operations. It wraps contract calls, handles encoding, and provides cached market data through a clean TypeScript interface.
| Component | Purpose |
|---|---|
GearboxSDK | Main entry point with attach() initialization |
marketRegister | Cached market data access |
addressProvider | Contract discovery wrapper |
| Plugins | Extended functionality (AccountsPlugin, AdaptersPlugin) |
| Services | Credit account operations and multicall helpers |
Prerequisites: Node.js 18+, basic familiarity with viem.