Overview
Welcome to the BrightMLS developer portal for our RESO Web API. You will find all the information you should need to facilitate integrating the BrightMLS real estate data into your platform, including property, agent, office data and more.
BrightMLS Web API conforms to the RESO Web API Core 1.0 transport standard.
Overview
The BrightMLS RESO API is available at the following endpoint:
A test endpoint is also available which is the initial version provided to you to determine if this solution works for your company:
Data Dictionary
The BrightMLS RESO Web API utilizes the RESO v1.7 data dictionary specification. Find more information on this standard here.
Additionally, BrightMLS provides some data fields specific to Bright which can be discovered within the Metadata. A full Bright Data Dictionary is coming soon.
Authentication
Access to our RESO Web API is performed via OAuth 2 and requires a valid client id and client secret. These credentials are provided to you during the onboarding process with Bright, including a test and final production version once you are ready to proceed and your application has been authorized.
For details on the authentication process, please read the Authentication page.
Parameters
You can view details on common endpoint parameters here.
Metadata
You can access the metadata at the following endpoint:
The following paramaters are also available for the $metadata endpoint:
| Parameter | Description |
|---|---|
| $format=xml | Return the metadata in XML format |
| $format=json | Return the metadata in JSON format |
| $metadataType=enum | Request enumeration metadata |
| $metadataType=lookup | Request lookup metadata |
Lookups
You can query lookups and related lookups using the /Lookup and /RelatedLookup endpoint:
Example: