API Documentation

  • API Overview: RESTful API, Real-Time Data Streams.

  • Authentication and Authorization: API Keys and Access Control.

  • Rate Limits: Ensuring Fair Usage.

  • Error Codes: Troubleshooting and Debugging.

  • Endpoint Documentation (Comprehensive, with Examples):

    • Market Data:

      • GET /markets: List all active markets.

      • GET /markets/{marketId}: Get details for a specific market.

      • GET /markets/{marketId}/history: Get historical price data.

      • GET /markets/{marketId}/orderbook: Get the current order book (liquidity bins).

    • Trading:

      • POST /orders: Place a new order (market or limit).

      • GET /orders/{orderId}: Get order status.

      • DELETE /orders/{orderId}: Cancel an order.

      • GET /trades: Get recent trades.

    • Liquidity Provision:

      • POST /liquidity: Provide liquidity to a market.

      • GET /liquidity/{positionId}: Get liquidity position details.

      • DELETE /liquidity/{positionId}: Remove liquidity.

    • Governance:

      • GET /proposals: List active governance proposals.

      • GET /proposals/{proposalId}: Get details for a specific proposal.

      • POST /proposals: Submit a new proposal (requires authentication).

      • POST /votes: Cast a vote (requires authentication).

    • AI Agent Data:

      • GET /agents: List all AI agents.

      • GET /agents/{agentId}: Get details for a specific agent.

      • GET /agents/{agentId}/sentiment: Get the agent's current sentiment score.

      • GET /agents/{agentId}/narratives: Get the narratives the agent is tracking.

  • Each endpoint should have detailed descriptions of parameters, request bodies, response formats, and example requests/responses.

Last updated