Helix Protocol Logo
Helix Protocol
GitHub

Developer SDK & API Integration

Integrate Helix Protocol into your applications using our comprehensive REST API and JavaScript SDK. This guide covers all available endpoints and SDK functions to help you get started quickly.

REST Endpoints

The Helix API provides RESTful endpoints for querying network data, node information, and epoch details. All endpoints return JSON responses and support standard HTTP methods.

GET    /epoch/current
GET    /epoch/report/{id}
GET    /node/{wallet}
GET    /proof/{wallet}/{epoch}
POST   /ping

Endpoint Details

  • GET /epoch/current - Returns the current epoch information including start time, end time, and active nodes
  • GET /epoch/report/{id} - Retrieves detailed report for a specific epoch by ID
  • GET /node/{wallet} - Fetches node status and metrics for a given wallet address
  • GET /proof/{wallet}/{epoch} - Returns cryptographic proof for reward claims
  • POST /ping - Health check endpoint for node connectivity

Helix SDK Functions (JavaScript)

The Helix JavaScript SDK provides a convenient wrapper around the REST API with built-in error handling, type safety, and automatic retries. Install it via npm:

npm install @helix/sdk

Core Functions

helix.connect(wallet);
helix.getNodeStatus(wallet);
helix.getRewards(wallet);
helix.claim(epochId, proof);
helix.getEpochData();

Function Reference

  • helix.connect(wallet) - Establishes connection to the Helix network using your wallet address
  • helix.getNodeStatus(wallet) - Retrieves current status, rank, and performance metrics for your node
  • helix.getRewards(wallet) - Fetches accumulated rewards and claim history
  • helix.claim(epochId, proof) - Claims rewards for a specific epoch using cryptographic proof
  • helix.getEpochData() - Returns comprehensive data about the current epoch

Authentication

All API requests require authentication using your wallet signature. The SDK handles this automatically when you call helix.connect(wallet). For direct REST API access, include your signed message in the Authorization header.

Rate Limits

The Helix API enforces rate limits to ensure fair usage:

  • 100 requests per minute for authenticated users
  • 10 requests per minute for unauthenticated requests
  • Burst allowance of 20 requests

Error Handling

The SDK automatically handles common errors and implements exponential backoff for retries. All errors include descriptive messages and error codes for debugging.