Registry API
The IXO Registry Server provides an API interface for registry systems, to manage Mitigation Activity reporting for Carbon Credits and ITMOs.
High-Level Overview
The Registry API provides a robust interface for interacting with registry systems to monitor and report on mitigation activities. Designed for simplicity and integration, this API supports endpoints for household statistics, device monitoring, fuel usage metrics, carbon credit management, and various claims processing. It connects seamlessly with systems like blockchain registries, ensuring transparent, verifiable, and secure operations.
Core Components
Projects
Registration and tracking of mitigation efforts.
Households
Identification and monitoring of households.
Devices
Monitor cookstove devices and fuel sources.
Agents
Validation and management of registry participants.
Claims & Certificates
Digital reporting and verification of activities and outcomes.
Credits
Issuance and management of tokenized carbon credits.
API Endpoints Overview
The Registry API is organized into various functional groups:
- System Health: Verify server status and access the complete API documentation.
- Household Information: Retrieve statistics and stove stacking data.
- Device Monitoring: Get real-time status of connected devices.
- Fuel Management: Access fuel usage metrics.
- Carbon Credits: Manage issuance, cancellation, transfer, and retirement of credits.
- Claims Management: Process and retrieve various claims including fuel delivery, fuel purchase, emission reductions, and household onboarding.
API Environments
The Registry API is available in the following environments:
- Production: https://api.emerging.eco (currently not available)
- Staging: https://stage.api.emerging.eco (currently not available)
- Development: https://dev.api.emerging.eco
Developer Integration
For seamless integration, developers can use the following examples to interact with the Registry API. You can either run these cURL commands directly from your terminal or import the provided Postman collection into your Postman client.
cURL Command Examples
Postman Collection
Below is the JSON configuration for the Registry API Postman Collection. Import this collection into your Postman client to quickly access all the endpoints with pre-configured authentication and example queries.
This documentation offers a high-level overview and practical examples for integrating with the Registry API. For more technical details, refer to the OpenAPI specification linked in the header.
Was this page helpful?