Skip to main content

API Overview

TODO: Complete API Reference & Authentication Documentation​

Getting started with EigenWatch APIs.

Required Sections​

  • Available APIs

    • REST API for queries
    • WebSocket API for subscriptions
    • Oracle contract ABI & address
    • SDK availability (Python, JavaScript, Go?)

  • Authentication

    • API key generation & management
    • Rate limiting (requests/second, requests/month)
    • Quota tiers (free, paid, enterprise)
    • Authentication headers / bearer tokens

  • Base URLs & Endpoints

    • Production endpoint
    • Testnet endpoint
    • API versioning strategy
    • Deprecation policy

  • Error Handling

    • HTTP status codes
    • Error response format
    • Common errors (rate limit, not found, etc.)
    • Retrying failed requests

  • Response Format

    • JSON schema
    • Timestamp format (UTC)
    • Address format (checksummed, lowercase?)
    • Number representation (strings vs numbers)

  • Pagination & Filtering

    • How to paginate large result sets
    • Common filter parameters
    • Sort options
    • Limit/offset vs cursor-based

  • SDKs & Client Libraries

    • Available SDKs
    • Installation & setup
    • Example usage
    • Contributing to SDKs

  • Rate Limits

    • Per-tier rate limits
    • Burst allowance
    • Quota reset timing
    • Monitoring usage

  • Data Freshness

    • How often is data updated?
    • Guarantees on data age
    • Eventual consistency model (if applicable)

Examples​

  • Making first API request
  • Querying risk score for specific operator
  • Subscribing to operator updates

Endpoints (High-Level)​

Status: NOT STARTED — Requires API specification & backend design