CityCatalyst Global API

General Description

This document covers the global API for CityCatalyst. The API responds with emission data in JSON format with the following top-level information:

• success: a Boolean value. False if there was an error. Typically, true if HTTP status code is 2xx or 3xx.
• message: a string; when success is false, will give an explanation of the error.
• data: if success is true, this is the data.

The subsector identifiers ONLY work for v7 of the GPC inventory. If we need other versions, we'll need to expand this API.

API Documentation

Our API documentation is generated using Swagger and can be accessed through the following links:

• Development Environment: Swagger Docs - Dev
• Production Environment: Swagger Docs - Prod

Please visit the respective links for detailed information about the endpoints, request/response models, and authentication methods.