From time to time as we collect new data, we may add new properties (aka fields) to our API responses. We don’t consider the addition of new data properties to be a breaking change, so these may sometimes be mentioned in our API documentation, but sometimes not.

When using our API, it is recommended that your code builds-in appropriate logic and error checking to to not break when new data properties are introduced in the API responses, as well as handle situations where data properties are optional and may not always be returned in the response.

We do consider the removal of previously existing data properties a breaking change, and we will rarely remove them without first informing you of their deprecation via our CHANGELOG, and allowing ample time for you to update your code to stop using the deprecated data.

Did this answer your question?