API Endpoints Overview¶
This section provides detailed documentation for all available HouMeerOver API endpoints, including request/response formats, authentication requirements, and practical implementation examples.
Getting Started with API Endpoints¶
Before using any API endpoints, ensure you have completed the OAuth2 Authentication setup to obtain valid access tokens.
Municipality Scoping¶
Important: All HouMeerOver API endpoints are scoped to a single municipality. When you create an OAuth2 application, it is associated with a specific municipality, and all API requests will only return data for that municipality. You cannot access data from other municipalities through the API.
This automatic scoping ensures:
- Data privacy: Each municipality can only access their own data
- Security: No risk of accessing unauthorized municipality data
- Simplified integration: No need to specify municipality filters in API requests
Available Endpoints¶
Current Production Endpoints¶
GET /api/v1/calculations¶
Retrieve completed energy subsidy calculations for your municipality.
- Purpose: Access calculation results for integration with municipal systems
- Authentication: Requires calculations:read scope
- Returns: List of calculations with subsidy amounts, addresses, and login codes
- Status: ✅ Available
POST /api/v1/calculations/export¶
Create and download bulk exports of calculation data.
- Purpose: Generate comprehensive data exports for reporting and analysis
- Authentication: Requires calculations:read scope
- Returns: Export UUID and status for tracking
- Status: ✅ Available
GET /api/v1/calculations/export/{uuid}¶
Check export status and download completed exports.
- Purpose: Monitor export progress and retrieve CSV files
- Authentication: Requires calculations:read scope
- Returns: Export status and CSV file download
- Status: ✅ Available
API Documentation¶
Interactive Swagger Documentation¶
The complete, up-to-date API reference is available in the interactive Swagger documentation:
Use the Swagger interface to:
- Explore all available endpoints
- Test API calls directly in your browser
- View detailed request/response schemas
- Understand authentication requirements
- See live examples and error responses
Ready to start using the API? Begin with the Calculations endpoint to retrieve your municipality's subsidy calculation data.