API Documentation
RXD Glyph Explorer API
This documentation provides details on how to interact with the RXD Glyph Explorer API.
The base URL for all API endpoints is:
/apiSome endpoints require authentication with an API key. Include the API key in the request headers as
x-api-keyAvailable Endpoints
The RXD Glyph Explorer API provides the following main endpoints:
| Endpoint | Description | Authentication |
|---|---|---|
| Fetch and search glyphs | No |
| Fetch a specific glyph by ID | No |
| Fetch blockchain statistics | No |
| Fetch block headers | No |
| Fetch transaction outputs | No |
| Fetch contract deployments | No |
| Fetch a specific contract by ID | No |
| Control blockchain import process | Yes |
| Manage cache system | Yes |
| Get cache metrics | Yes |
Authentication
Some endpoints require authentication with an API key.
To authenticate, include the API key in the request headers:
{
"x-api-key": "your-api-key"
}
The API key can be obtained from the system administrator.
Error Responses
All API endpoints follow a consistent error response format.
When an error occurs, the API will return an appropriate HTTP status code along with a JSON response:
{
"error": "Error message describing what went wrong"
}
| Status Code | Description |
|---|---|
| 400 | Bad Request - The request was invalid or cannot be served |
| 401 | Unauthorized - Authentication is required or has failed |
| 404 | Not Found - The requested resource does not exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - Something went wrong on the server |