API reference

Reference for the IXO Protocol gateways and the IXO service APIs: what each one is for, plus the shared pages on errors, pagination and versioning.

This section is the reference for the interfaces your code calls: the two gateways to the IXO Protocol, and the services that run beside the chain. Each page covers one interface: its scope, how to reach it, example shapes and what goes wrong.

It does not explain protocol concepts and does not list hosts. For the hosts and chain ids of each network, use Networks and endpoints. To choose between the interfaces, start at the comparison table in Choose an API.

The interfaces

APIKindUse it to
Blockchain RPC APIIXO Protocol gatewaySend transactions and query chain state directly on a node
Blockchain REST APIIXO Protocol gatewayQuery IXO Protocol modules over HTTP and JSON, through the gateway over gRPC
IXO Blocksync GraphQL APIService APIQuery indexed chain data through IXO Blocksync
Matrix state bot APIService APIRead and manage state and ACL events in IXO Matrix rooms
Registry APIService APICall Impact Hub Registry service workflows
USSD gateway APIService APIAccept input from telecom gateways and return USSD responses

Boundary between protocol and services

  • IXO Protocol APIs: rpc-api and grpc-gateway-api.
  • Service APIs: blocksync-graphql-api, matrix-state-bot-api, and registry-api.
  • Protocol concepts and module behaviour belong in the protocol documentation, such as IXO Protocol, not on these pages.

Shared references

PageWhat it covers
AuthenticationAuthentication schemes compared by API
ErrorsStatus codes, the error body and rate-limit headers
PaginationCursor arguments for large result sets
Versioning and deprecationHow versions are named and how a retirement is announced
Networks and endpointsHosts and chain ids for each network
Authentication matrixAuthentication requirements and literals by interface
Product and SDK mapIXO products, APIs and SDK references

Next steps