Quick Start

The following guide will walk you through the general process of establishing an integration with Pearl’s Real Estate API. Pearl’s Real Estate API will allow you to:

1. Populate Data on High Performing Features into your Applications: Pearl collects a lot of data about homes and their high performing features and we make this data available for our partners in the real estate industry.
2. Prompt Your Users to Request a Pearl Certification: Whether a home has already been certified and needs a certification reissued, or the home is in need of its first Pearl Certification, Pearl makes it easy to prompt your users to request a certification.

Get Data About a Home’s High Performing Features

To fetch Pearl’s data around the high performing features of a home, you will need to use the search endpoint. The only data required for request is the home address. The response will be served back in RESO Common Format.

While Pearl has data on many homes throughout the United States, no two records are the same; some homes have a lot of data, some have a little data, and some have no data at all. When you send us an address, we will analyze the data that we have on a home and respond accordingly. Below our some descriptions of the various ways that we may respond.

Known - Certified

If Pearl has collected data on a property and certified it, we will send back all verified data in RESO Common Format. This will not include the files that make up the Pearl Certification Report (PDF/JPG files within Media group), but just the underlying data to be populated into the MLS.

Known - RESNET

If Pearl has collected data on a property (including RESNET specific data), but has not certified it, we will send back standard RESO Common Format object with all data omitted except for a GreenVerification object representing a Pearl Certification with a GreenVerificationRating of Not Certified and a GreenVerification object representing a RESNET HERS Rating. This should indicate that we likely have data on a property that can be certified, but it has not yet been approved and certified by our team.

Known - Not Certified

If Pearl has collected data on a property (not RESNET specific data), but has not certified it, we will send back standard RESO Common Format object with all data omitted except for a GreenVerification object representing a Pearl Certification with a GreenVerificationRating of Not Certified. This should indicate that we likely have data on a property that can be certified, but it has not yet been approved and certified by our team.

Unknown

If Pearl has not yet collected data on a property, we will send back a 404 error code to indicate that the property was not found within our certification system.