API reference

The field-by-field reference for every operation, with its parameters, request and response schemas and possible errors, is the OpenAPI document. Browse it in Swagger UI:

It opens on v3. The version switcher at the top lists the deprecated v1 and v2 as well; their operations say what replaces them.

Generate a client

Each major version is its own OpenAPI document, in JSON and in YAML. Download the v3 document to generate a client or import it into an API tool:

https://api.energi.ai/docs/v3-json
https://api.energi.ai/docs/v3-yaml

https://api.us.energi.ai/docs/v3-json
https://api.us.energi.ai/docs/v3-yaml

/docs-json and /docs-yaml redirect to the latest version’s document. Use the versioned address, as above, so a tool keeps getting v3 after a newer version ships.

When you generate a client:

• Operation ids are stable (listCompanies, createDataPoints, getCompanyEmissionsSummary, listPortfolios, getPortfolioEmissionsSummary), so generated method names don’t change from one release to the next.
• Values only the server chooses are open strings. Fields such as scope, a category code, meta.status or an error code are published as strings that list their known values in their description and in x-extensible-enum, not as closed enums, because new values can appear (see Conventions). Keep them as strings in your client. Request parameters, such as granularity, are closed enums.
• Unknown fields will appear over time. Configure your client to ignore fields it doesn’t know rather than fail on them.

Operations