API

EPD, PCR, building project, and other data available in EC3 is also accessible via API.

Access

You must have an EC3 account in order to access the API. The information that is accessible to users via the API corresponds to the user permissions in EC3. All API users must follow the API Terms of Service.

Documentation

API documentation is available in the settings menu of EC3 under API & Integrations.

Throttling

Our API has default throttling rules to prevent misuse and overloading of the service. The system uses a combination of 1) token cost structure for performing various requests and 2) time-period token usage limits (shown below).

Token Limits

• 45 tokens per minute

• 400 tokens per hour

• 2,000 tokens per day

• 10,000 tokens per month

If your use case requires higher token limits, you can reach out to [email protected]

Token Costs

Each API endpoint has an associated token cost that is deducted from your usage limits when called. More resource-intensive operations have higher token costs. The table below shows the token cost for each endpoint:

Endpoint	API	Tokens Cost
Get Project Details	EC3	0.5
Get Project View Details	EC3	3.0
EPD Details	EC3	1.0
Get Category Defaults	EC3	0.05
API Version	EC3	0.01
Download EPD	EC3	0.01
Material Filter Query	EC3	0.01
Get Category Details	EC3	0.05
Calculate EPD Statistics	EC3	0.01
Industry EPD Details	EC3	0.2
OpenEPD Declaration List	OpenEPD	1.0
Get OpenEPD	OpenEPD	1.0
Create Declaration List	OpenEPD	1.0
Get Declaration List	OpenEPD	1.0
Get Material List	OpenEPD	1.0
Get Statistics	OpenEPD	1.0

Attribution

As the Terms of Use say, we request that you display any attribution to BT's work and data when using the API for third party platforms. The following are some samples of how this can be done.

Inline links to EC3

If you are showing individual EC3 data directly in a search and list fashion, please provide direct links back to the original source in EC3. This can be either in the list view as shown in the example below, or on the detailed view of the individual datapoint.

Example inline attribution in BuiltCold

Example inline attribution in Transparency Catalog

Customer communication

If you are communicating with customers about data originating from EC3, please acknowledge Building Transparency and EC3 in the email referencing our data.

Example BuiltCold email to users

Documentation

If EC3 data is not provided directly but is used to develop other data, it is sufficient to attribute Building Transparency and EC3 in your tool’s documentation or user guide.

Example EPIC documentation