Machine-to-Machine REST API
Secure, versioned REST API for energy calculation submission and retrieval.
Overview
The Greenfield Energy Explorer Public API provides programmatic access to wind simulation calculations through a secure, authenticated REST interface designed for automated systems and integrations.
Secure Authentication
API key-based authentication with per-tenant isolation
Rate Limited
Built-in rate limiting to ensure fair usage and system stability
Versioned
URL-based versioning for backward compatibility
API Documentation
Interactive API documentation and testing interface is available through Swagger UI.
Getting Started
- Obtain API Key - Contact your administrator to provision an API key for your tenant
- Review Documentation - Explore the Swagger UI for available endpoints and request formats
- Authenticate - Include your API key in the
X-API-Keyheader on all requests - Submit Calculations - Use the versioned endpoints (e.g.,
/api/v1/calculations/wind-simulation)
API Versions
| Version | Status | Base Path |
|---|---|---|
| v1 | Current | /api/v1 |
Key Endpoints
-
POST/api/v1/calculations/validateValidate calculation input -
POST/api/v1/calculations/wind-simulationSubmit wind simulation calculation -
GET/api/v1/calculationsList calculations with pagination -
GET/api/v1/calculations/{id}/statusGet calculation status -
GET/api/v1/calculations/{id}/resultsDownload calculation results