Skip to main content
The Blockchain REST API is the gateway surface for IXO Protocol query access over HTTP. It is a protocol interface, not an application service API.

​
Overview

  • Use this API when your client needs HTTP/JSON access to protocol queries.
  • Use the RPC API for direct node interaction patterns.
  • Use service APIs for IXO Blocksync, IXO Matrix, or Impact Hub Registry workflows.

​
Request model

  1. Client sends HTTP request.
  2. Gateway maps request to gRPC service methods.
  3. Gateway returns JSON response.

​
Example endpoint shapes

GET /ixo/entity/{id}
GET /ixo/claims/claims
GET /ixo/token/params

​
Authentication and endpoints

Authentication requirements vary by deployment.

Authentication matrix

Confirm required credentials and auth patterns by interface.

Networks and endpoints

Confirm endpoint mappings by network and environment.

​
Troubleshooting

  • 404 on REST paths — Gateway build or route prefix differs by deployment (/ixo/... vs legacy prefixes). Compare the served OpenAPI/Swagger document from your node operator.
  • 501 Not Implemented / empty responses — The mapped gRPC method may be disabled or not compiled into that binary.
  • CORS errors from browsers — Prefer server-side or mobile clients for protocol access; if you must call from a browser, use an operator-approved proxy.
  • 401/403 — Some deployments gate REST; align headers with Authentication matrix. For writes, you still sign transactions—REST is often query-only.

Blockchain RPC API

Use RPC endpoints for direct blockchain node interactions.

API authentication

Review authentication patterns used across IXO API interfaces.

Product and SDK map

Navigate IXO products, APIs, and SDK references.