API Reference Overview¶
Welcome to the Emmi API Reference. This section provides detailed documentation for all available endpoints.
Base URL¶
Authentication¶
All API requests (except health checks) require authentication using an API key:
Available Endpoints¶
Public Endpoints¶
| Method | Endpoint | Description | Auth Required |
|---|---|---|---|
| GET | /api/v1 |
Service information | No |
| GET | api/v1/health |
Health check | No |
Analysis Endpoints¶
| Method | Endpoint | Description | Auth Required |
|---|---|---|---|
| POST | /api/v1/emissions-estimates |
Current or past-year oriented emissions modelling, based on entity financials. | Yes |
| POST | /api/v1/climate-risk |
Comprehensive Baseline Climate Risk modelling, across transition and physical risk, with current emissions projected across all future years. 10+ climate scenarios available. | Yes |
| POST | /api/v1/temperature-alignment |
Temperature alignment modelling based on emissions and financials. | Yes |
| POST | /api/v1/emissions-projections |
Future-oriented emissions modelling for targets (at face value) or forecasts using multiple past years of emissions (companies only). | Yes |
| POST | /api/v1/climate-risk-projections |
Comprehensive Projected Climate Risk modelling, across transition and physical risk, using targets or forecast based emissions in future years. 10+ climate scenarios available (companies only). | Yes |
| POST | /api/v1/temperature-alignment-projections |
Temperature alignment based on specified emissions pathways. | Yes |
| POST | /api/v1/company-ranking |
Company ranking – performance analysis within an industry or sector of company emissions data | Yes |
| GET | /api/v1/hazard-risk |
Acute climate hazard intensity and probability over multiple warming scenarios, for any lat-long. | Yes |
Supported Asset Types¶
The API supports four asset types, each with specific data requirements:
| Asset Type | Description |
|---|---|
equity |
Public and Private companies |
debt |
Public and Private debt |
infrastructure |
Long-lived assets with operational cash flows |
property |
Commercial real estate |
Batch Processing¶
All endpoints support batch processing. Submit multiple entities in a single request:
[
{
"entity_info": { "name": "Entity 1", ... },
"data": [ ... ]
},
{
"entity_info": { "name": "Entity 2", ... },
"data": [ ... ]
}
]
For detailed information on request size limits, batching recommendations, and timeout expectations, see Request Size Limits and Timeouts.
Rate Limiting¶
Usage limits are tailored to your specific use case and volume requirements. Contact our team to discuss your needs.
Versioning¶
The current API version is v1, included in the endpoint path (/api/v1/). Future versions will use different paths: