# API

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

## Access

You must have an [EC3 account](https://docs.buildingtransparency.org/getting-started#create-an-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](https://www.buildingtransparency.org/api-terms-of-service/).

{% hint style="info" icon="triangle-exclamation" %}
Private accounts with generic email domains are not allowed API access for security reasons. You must have at least a [Professional account](https://docs.buildingtransparency.org/ec3/getting-started) with a business email to access the API.
{% endhint %}

## Documentation

API documentation is available in the settings menu of EC3 under [API & Integrations](https://buildingtransparency.org/ec3/manage-apps).

<figure><img src="https://3092112806-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPDhVD99RBnS0Qy4HvVPO%2Fuploads%2FuCv7HDCNcvADZUVzma2H%2FAPI%20location.png?alt=media&#x26;token=c535d459-21a7-47f9-ab70-595ab564280a" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3092112806-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPDhVD99RBnS0Qy4HvVPO%2Fuploads%2F2bALQVA6aNI3paL7iVYD%2FAPI%20location%202.png?alt=media&#x26;token=0c34ea8b-961d-4b8f-b0e3-2457038da8dc" alt=""><figcaption></figcaption></figure>

## Rate Limits / 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 and/or you plan to use our API for commercial production applications, you can reach out to <support@buildingtransparency.org> to get paid API access. Paid API access comes with unlimited tokens except for the burst protection limit of:

* 100 tokens per minute

### 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.

<figure><img src="https://3092112806-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPDhVD99RBnS0Qy4HvVPO%2Fuploads%2FfJ6ecjG9tsFzoRxXmE7w%2Fimage.png?alt=media&#x26;token=2ad57663-7725-492d-ba1e-24f44a3a4485" alt=""><figcaption><p>Example inline attribution in BuiltCold</p></figcaption></figure>

<figure><img src="https://3092112806-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPDhVD99RBnS0Qy4HvVPO%2Fuploads%2FPnDznsT6f9DYCQgHQU1S%2Fimage.png?alt=media&#x26;token=87735406-044b-4b1a-9649-e18000fa91ee" alt=""><figcaption><p>Example inline attribution in Transparency Catalog</p></figcaption></figure>

### 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.

<figure><img src="https://3092112806-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPDhVD99RBnS0Qy4HvVPO%2Fuploads%2F5PXMYy3R4aI7mojuBdZO%2Fimage.png?alt=media&#x26;token=a4c93a1b-7d03-4818-b488-145f0fd7b2a8" alt=""><figcaption><p>Example BuiltCold email to users</p></figcaption></figure>

### 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.

<figure><img src="https://3092112806-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPDhVD99RBnS0Qy4HvVPO%2Fuploads%2FVGTBjD8HnS2ZaZliUm8X%2Fimage.png?alt=media&#x26;token=db3d7a43-8c27-40b4-bbd0-4abae320b392" alt=""><figcaption><p>Example EPIC documentation</p></figcaption></figure>
