Hi Energy AI API Documentation

{
  "deals": {
    "data": [
      {
        "id": "532",
        "type": "deal",
        "attributes": {
          "title": "NordVPN Deal",
          "country_list": ["us"],
          "exclusive": true,
          "deal_kind": "coupon",
          "deal_kind_label": "Coupon"
        }
      }
    ]
  },
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "per_page": 500,
    "total_count": null,
    "total_pages": null
  }
}

{
  "data": [
    {
      "id": 1,
      "attributes": {
        "name": "NordPass",
        "domain": "nordpass.com",
        "status": "approved",
        "country_list": ["us"],
        "vertical_list": ["security"]
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "per_page": 25,
    "total_count": 500,
    "total_pages": 20
  }
}

{
  "data": [
    {
      "id": 1,
      "attributes": {
        "name": "NordPass"
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "has_next_page": true,
    "next_cursor": "eyJpZCI6MTIzLCJjcmVhdGVkX2F0IjoiMjAyNi0wNC0wNlQxMjozMDowMFoifQ=="
  }
}

{
  "transactions": {
    "data": [
      {
        "id": "123",
        "type": "transaction",
        "attributes": {
          "transaction_date": "2026-04-06",
          "sale_amount": 100.0,
          "commission_amount": 10.0,
          "currency": "USD"
        }
      }
    ]
  },
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "per_page": 100,
    "total_count": null,
    "total_pages": null
  }
}

Start here when your agent needs to inspect the published tool catalog before making calls.

{
  "tools": [
    {
      "name": "list_reports",
      "description": "List accessible JSON reports backed by materialized views, including major aliases with guidance about when to use each report.",
      "parameters": {
        "type": "object",
        "properties": {}
      },
      "endpoint": "/api/v1/reports",
      "method": "GET"
    }
  ],
  "api_version": "v1",
  "base_url": "https://app.hienergy.ai",
  "authentication": {
    "type": "multi",
    "preferred_for_agents": "api_key",
    "preferred_header": "X-Api-Key",
    "fallback_for_oauth_apps": "oauth_bearer",
    "fallback_for_legacy_clients": "api_key_query_param"
  },
  "pagination": {
    "type": "mixed",
    "description": "Most v1 list endpoints return meta pagination. Advertisers also support explicit cursor compatibility when cursor is provided."
  },
  "idempotency": {
    "header": "Idempotency-Key",
    "description": "Include Idempotency-Key header for mutating requests"
  },
  "dry_run": {
    "parameter": "dry_run",
    "description": "Add ?dry_run=true to test requests without making changes"
  }
}

{
  "openapi": "3.0.3",
  "info": {
    "title": "Hi Energy AI API",
    "description": "Agent-friendly API for affiliate marketing data. AI agents should prefer X-Api-Key for authentication...",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://app.hienergy.ai/api/v1",
      "description": "Production server"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "OAuthBearer": []
    }
  ],
  "x-agentAuthentication": {
    "preferred": "ApiKeyAuth",
    "preferredHeader": "X-Api-Key",
    "fallback": ["OAuthBearer"],
    "legacy": "api_key query parameter"
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Key"
      },
      "OAuthBearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "Advertiser": { ... },
      "Transaction": { ... },
      "Deal": { ... },
      "ReportMetadata": { ... },
      "Error": { ... },
      "Pagination": { ... }
    }
  },
  "paths": {
    "/advertisers": { ... },
    "/transactions": { ... },
    "/deals": { ... },
    "/reports": { ... },
    "/tools": { ... }
  }
}

Every API response includes rate limit information in the headers:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789",
    "details": {
      "additional": "context information"
    }
  }
}