Author: Kristin

We’re notifying all Bridge API users in advance of important changes to the API. The UAT environment is available now and data consumers are strongly encouraged to test against it to prepare.

These system-wide changes outlined below will prepare Bridge API MLS datasets for RESO Data Dictionary 2.0 certification. Data consumers can also expect to see several field and enumeration changes to individual datasets over the next several months to bring those datasets better in line with the Data Dictionary 2.0 standard. 

For most of the field name changes between Data Dictionary versions 1.x and 2.0, Bridge API will support both old and new field names simultaneously for the next several months at minimum. However, each data provider (each MLS) may decide whether or not to include those in their outgoing payloads. 

What’s changing?

1. The $top operator will be modified to match the OData specification. 
   • Bridge API previously treated $top as the page size, whereas OData specifies that $top is meant to be the total collection size. In other words, $top is meant to be the total number of records returned once you have consumed every page. 
   • Clients may specify a given page size by utilizing the maxpagesize header. The current default is 10 with a maximum value of 200.
2. Our nextLink logic will be modified to allow for replication of any number of records.
3. $expand queries will now have a default maximum of 10 results, unless otherwise specified with a $top operator within the $expand parameter (e.g., $expand=Listings($top=20)). 
4. Some resource names will be changing.
   • A correction will be made to the Lookup resource; it is inconsistently reported as Lookups in some places and the plural `s` will be removed.
   • Teams will be renamed to Team.
   • Fields/Resource will be renamed to ResourceName. (This change is specific to the Fields metadata; it already shows correctly as ResourceName in the /Fields payload.)
5. All requests will now have a default sort order if not otherwise indicated in the request. 
   • Default Sort: ascending 
   • Default OrderBy: BridgeModificationTimestamp (primary), primary key (secondary)

When?

These changes will be released into production on November 19, 2024.

There is also a UAT environment with the new format available now, see below.

How can I prepare?

Please test against https://uat.bridgedataoutput.com/api/v2/ to confirm that your ingestion processes are compatible before we switch over in production on November 19, 2024.

We encourage you to test against UAT as soon as possible. If you encounter any new behaviors that are inconsistent with the changes listed above, or if you encounter unexpected blockers while integrating with these changes, please contact support@bridgeinteractive.com with “UAT feedback” in the subject line so that our team can review and assist.

On August 6, 2024, Bridge API will be adding new per-minute “burst” rate limits alongside our existing hourly rate limits. These are intended to prevent short-term burst traffic from degrading the performance of the system for other users and are based on the existing rate limits.

These new burst rate limits will allow for 1/15 of an application’s hourly traffic limit per minute. Similar to our existing rate limits, our responses will include headers that communicate the number of requests allowed, number of requests remaining in the current time period, and when the current rate limit time period will reset. These headers are Burst-RateLimit-Limit, Burst-RateLimit-Remaining, and Burst-RateLimit-Reset, respectively.

Additional information will be found in our documentation upon release: bridgedataoutput.com/docs/

In order to better meet the latest OData specification and support RESO certification, we’re rolling out a small change to collections in the Bridge API. This will impact both the RESO Web API and “classic” Bridge API.

Previously, users may have seen null collections in cases where the field was unavailable from the upstream data provider. Going forward, instead of null values, Bridge API will return empty arrays: []

This will roll out incrementally across records and datasets as listing data is naturally reprocessed from upstream servers; users can expect to see both styles until all data is reimported.