API Documentation

Comprehensive API reference for integrating Helix Analytics into your applications.

Endpoints

GET/api/flow

Flow Analysis API

Analyze token flow patterns and calculate Flow Index

Parameters

tokenrequiredstring

Token contract address (0x...)

Example

Request

GET /api/flow?token=0xA0b86a33E6417c5F8d35cA78c8294ba20F8e2a6D

Response

{
  "flowIndex": 75.42,
  "whaleMoves": [
    {
      "transactionHash": "0x123...",
      "from": "0xabc...",
      "to": "0xdef...", 
      "value": "1000000.000000",
      "timestamp": 1640995200
    }
  ],
  "metadata": {
    "tokenSymbol": "USDC",
    "transfersCount": 1250,
    "totalVolume": "50000000.00"
  }
}

Getting Started

Authentication

Currently, our APIs are public and don't require authentication. Rate limiting may apply.

Base URL

https://your-domain.com

Response Format

All responses are in JSON format with consistent error handling.

Status Codes

200Success

400Bad Request

500Server Error