“GRESB Data Partners” and the API

The GRESB API is focused on linking the GRESB Portal to data collection tools. Currently, this is only available for the Real Estate Assessments.

 

The GRESB API, currently only available for the Real Estate Assessment, is meant for submitting quantitative data of the assessment. Data submitted through the API goes to the GRESB Asset Portal where a user can aggregate their asset-level data to the portfolio-level assessment. The aggregated data goes to the Performance Component of the assessment and covers the majority of the reporting requirements.

Use of the API is tied to a GRESB user account int he Portal, which provides access to the API endpoint. Partners signed up at all tiers (Global+, Global, Premier, and Partner) are eligible for an account. This is included in the membership fee. However, each submission via the API incurs a usage fee.

All Partners can access basic support documentation and the GRESB API GitHub environment and will receive regular updates about changes and new functionality to the API via the monthly Partner Newsletter. You must sign yourself up to receive this newsletter. A signup link is provided in the Partner onboarding email.

“GRESB Data Partners”

Partners signed up as Global+, Global, or Premier are eligible to be labeled (on their Partner profiles) and searchable (via the Partner Directory) as “GRESB Data Partners”. Such Partners must have a user with an active API account to receive this designation. These Partners are able to use the “GRESB Data Partner” logo and e-signature badge, as well as promote themselves as “GRESB Data Partners.”

Support

Getting started

Check out more detailed information below to see if this is right for you. And reach out to our business development team when you’re ready to sign up.

More information on the API

Connecting your application to the GRESB API normally takes around 1-2 weeks.

  • GRESB hosts its API documentation on a public GitHub repository. This document provides step-by-step instructions on how to set up the API connection. On the right hand side there are examples of requests a user can make. You can always post an issue or use the data files in the public repository when needed.

  • The majority of the effort lies in mapping data points. Mapping data points can be done by using the GRESB Asset Spreadsheet – which provides a nice visual aid. You can unhide the first row containing the variable names used in the API json requests. There is an exception for building certifications & energy ratings which are submitted per identifier instead (see the API documentation). Alternatively you can use the data dictionary in our GitHub repository. The GRESB Asset Spreadsheet also contains an ‘Instructions’ tab which provides more background information for the data points and can be helpful in understanding the context during the mapping exercise.

  • The GRESB asset level data needs to be of high quality. In order to ensure this, GRESB implemented numerous validation rules and outlier checks. Validation is hierarchical, meaning that a set of validation rules will only be shown when prerequisite data points are provided. A high-level overview of the validation rules can be found in the Asset Portal Validation Rules diagram.

  • An API application is tied to a GRESB user. As such you would need to create an account in order to authorize the application to make changes for this account and all its GRESB reporting entities. Subsequently, this user needs to be added to the entities of your client as an internal contributor in order to read and write data for this entity. A step-by-step guide can be found in our API documentation.

  • For testing purposes you can use our sandbox environment. This database is completely separated from our production environment. Once you’re ready to roll-out to production you can create a user in the GRESB Portal. Do note that the API endpoint uses a different base URL (https://api.gresb.com) than our production portal UI. This is because the API runs on a different server to separate the infrastructure and its traffic for performance reasons.

    In case the client requires a spreadsheet presentation of their data one can use the spreadsheet endpoint. This saves the effort of building your own spreadsheet parser. 

    When dealing with a large number of assets it is advised to use the batch operations. With the batch operations you can alter up to 5000 assets in one go. As GRESB applies throttling of traffic this can be required when dealing with large portfolios of assets.

    Every time you create an asset GRESB assigns an asset identifier. This identifier then needs to be used going forward to update the data for this asset. If no asset identifier is given, GRESB assumes it is a new asset and therefore creates a new entry. For mapping the GRESB identifier to your own internal identifier one can use the partners_id data field.

    Documentation regarding the Real Estate assessment can be found in our assessment documentation page. The Performance Component indicators (i.e. Energy) and Terminology appendix in the Reference Guide are excellent guidelines for understanding the wider scope of the submitted asset data. The Scoring Document contains the methodology for scoring and can help you understand the weighting of the performance indicator scores which sum up to 70% of the total score.

  • In addition to the base Partner fee, there is a fee associated with using the API, per entity submission.