> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ixo.world/llms.txt
> Use this file to discover all available pages before exploring further.

# Blockchain REST API

> HTTP/JSON gateway reference for IXO Protocol gRPC query services.

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

```http theme={"system"}
GET /ixo/entity/{id}
GET /ixo/claims/claims
GET /ixo/token/params
```

## Authentication and endpoints

Authentication requirements vary by deployment.

<CardGroup cols={2}>
  <Card title="Authentication matrix" href="/reference/authentication-matrix">
    Confirm required credentials and auth patterns by interface.
  </Card>

  <Card title="Networks and endpoints" href="/reference/networks-and-endpoints">
    Confirm endpoint mappings by network and environment.
  </Card>
</CardGroup>

## 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](/reference/authentication-matrix). For writes, you still sign transactions—REST is often query-only.

## Related references

<CardGroup cols={3}>
  <Card title="Blockchain RPC API" href="/api-reference/rpc-api">
    Use RPC endpoints for direct blockchain node interactions.
  </Card>

  <Card title="API authentication" href="/api-reference/authentication">
    Review authentication patterns used across IXO API interfaces.
  </Card>

  <Card title="Product and SDK map" href="/reference/product-and-sdk-map">
    Navigate IXO products, APIs, and SDK references.
  </Card>
</CardGroup>