Request URL, parameters, and HTTP body

When making a request to Candid's APIs, please be aware of the following:

  • We will not make any changes to the published versions which would break the client side applications
  • We may add fields to our API return, but existing fields and structures will remain intact
  • If any other changes are needed to improve our API experience, we will do so in the next release cycle in the new versions

Response JSON Payload

When consuming the JSON payload, please be aware of the following:

  • We will not remove existing data fields from published versions
  • We will not change the names of the existing data fields from published versions
  • However, to improve our data quality, we will add, remove, rename, and restructure the data fields in the new versions
  • We recommend using JSON object names when accessing the values instead of object positions

Changelog

To keep up to date on changes to our APIs, please review our changelog for more information.