The IXO Platform provides multiple APIs to interact with different components of the software services and data ecosystem. This guide covers the core APIs and how to get started using them.

Available APIs

Gateways

RPC and gRPC interfaces for querying & writing to the blockchain

Blocksync

Dynamic querying of indexed blockchain data using GraphQL

Data Matrix

Secure Matrix Server interface to private data rooms

Oracles

Interface with AI Oracles for automation and analytics

Authentication

All API requests require authentication using API keys. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URLs

Each API has its own base URL:

Response Format

Our APIs return responses in JSON format. A typical successful response looks like:

{
  "data": {
    "result": "success"
  }
}

Error Handling

The API uses conventional HTTP response codes:

  • 2xx - Success

  • 4xx - Client errors

  • 5xx - Server errors

Error responses include:

  • Error code

  • Human-readable message

  • Request ID for support

Rate Limiting

APIs are rate limited, depending on your plan and which API service you are using.

Rate limit headers are included in responses:

Integration.md
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

Next Steps

RPC Reference

Detailed documentation for the RPC API

GraphQL Guide

Learn how to construct GraphQL queries

Authentication

Detailed guide on authentication methods

Examples

Sample code and use cases for the various APIs

Was this page helpful?