{
"info": {
"name": "Registry API",
"description": "Public API collection for the Registry service. This API provides endpoints for monitoring devices, households, fuel usage, carbon credits, and various claims in the clean cooking ecosystem.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"auth": {
"type": "basic",
"basic": [
{
"key": "username",
"value": "{{username}}",
"type": "string"
},
{
"key": "password",
"value": "{{password}}",
"type": "string"
}
]
},
"item": [
{
"name": "Server Health",
"description": "Health check endpoint",
"item": [
{
"name": "Health Check",
"description": "Simple health check endpoint to verify server status",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/hello",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "hello"]
}
}
}
]
},
{
"name": "Credit Management",
"description": "Endpoints for managing carbon credits lifecycle",
"item": [
{
"name": "Get Issued Credits",
"description": "Retrieve issued carbon credits for a specific project and time period",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/credits/issued",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "credits", "issued"],
"query": [
{
"key": "project_id",
"value": "{{projectId}}",
"description": "Project ID to filter credits by",
"required": true
},
{
"key": "time_period",
"value": "{{timePeriod}}",
"description": "Time period to filter credits by (e.g. 2024-Q1)",
"required": true
}
]
}
}
},
{
"name": "Get Cancelled Credits",
"description": "Retrieve cancelled carbon credits",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/credits/cancelled",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "credits", "cancelled"]
}
}
},
{
"name": "Get Transferred Credits",
"description": "Retrieve transferred carbon credits",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/credits/transferred",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "credits", "transferred"]
}
}
},
{
"name": "Get Retired Credits",
"description": "Retrieve retired carbon credits",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/credits/retired",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "credits", "retired"]
}
}
}
]
},
{
"name": "Claims Management",
"description": "Endpoints for managing various claims",
"item": [
{
"name": "Get Fuel Delivery Claims",
"description": "Retrieve fuel delivery claims",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/claims/fuel-delivery",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "claims", "fuel-delivery"],
"query": [
{
"key": "project_id",
"value": "{{projectId}}",
"description": "Project ID to filter claims by",
"required": true
},
{
"key": "time_period",
"value": "{{timePeriod}}",
"description": "Time period to filter claims by",
"required": true
}
]
}
}
},
{
"name": "Get Fuel Purchase Claims",
"description": "Retrieve fuel purchase claims",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/claims/fuel-purchase",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "claims", "fuel-purchase"],
"query": [
{
"key": "project_id",
"value": "{{projectId}}",
"required": true
},
{
"key": "time_period",
"value": "{{timePeriod}}",
"required": true
}
]
}
}
},
{
"name": "Get Emission Reduction Claims",
"description": "Retrieve emission reduction claims",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/claims/emission-reduction",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "claims", "emission-reduction"],
"query": [
{
"key": "project_id",
"value": "{{projectId}}",
"required": true
},
{
"key": "time_period",
"value": "{{timePeriod}}",
"required": true
}
]
}
}
},
{
"name": "Get Household Onboarding Claims",
"description": "Retrieve household onboarding claims",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/claims/household-onboarding",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "claims", "household-onboarding"],
"query": [
{
"key": "project_id",
"value": "{{projectId}}",
"required": true
},
{
"key": "time_period",
"value": "{{timePeriod}}",
"required": true
}
]
}
}
}
]
},
{
"name": "Device & Household Monitoring",
"description": "Endpoints for monitoring devices and households",
"item": [
{
"name": "Get Device Status",
"description": "Retrieve status information for all registered devices",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/devices/status",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "devices", "status"]
}
}
},
{
"name": "Get Household Stats",
"description": "Retrieve statistics for monitored households",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/households/stats",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "households", "stats"]
}
}
},
{
"name": "Get Stove Stacking Data",
"description": "Retrieve stove stacking information",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/households/stove-stacking",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "households", "stove-stacking"]
}
}
}
]
},
{
"name": "Fuel Management",
"description": "Endpoints for fuel usage monitoring",
"item": [
{
"name": "Get Fuel Usage",
"description": "Retrieve fuel usage statistics",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}{{apiVersion}}/fuel/usage",
"host": ["{{baseUrl}}"],
"path": ["{{apiVersion}}", "fuel", "usage"]
}
}
}
]
}
],
"variable": [
{
"key": "baseUrl",
"value": "https://api.registry.example.com",
"type": "string",
"description": "Base URL for the Registry API"
},
{
"key": "apiVersion",
"value": "v1",
"type": "string",
"description": "API version"
},
{
"key": "projectId",
"value": "project-123",
"type": "string",
"description": "Example project ID for filtering"
},
{
"key": "timePeriod",
"value": "2024-Q1",
"type": "string",
"description": "Example time period for filtering (YYYY-Q#)"
},
{
"key": "username",
"value": "your-username",
"type": "string",
"description": "Your API username"
},
{
"key": "password",
"value": "your-password",
"type": "string",
"description": "Your API password"
}
]
}