API Update: Historical Revision Versions

Historical Data Versioning

We have added a new field to most historical data API's to indicate revision versions.

"revision_version"

To ensure our service always returns the best possible data for every location - on rare occasions - it is necessary to make changes to either calculated fields, or the underlying data (even when in a "final" state). In this case the "revision_version" field will indicate an updated version number.

revision_version: "MAJOR_VERSION.MINOR_VERSION" - Example: "1.0"

The minor version will update when:

• Improvements have been made to calculations of derived fields.
• Bug fixes or minor improvements have been made that may only impact specific locations or time frames.

The major version will update when:

• There are new historical dataset(s) added.
• Major updates to station/data source selection have been made.
• Changes or fixes have been made that impact all data returned by the API.

As a general practice we recommend querying again for past data to obtain these revisions using both "revision_status" field, AND "revision_version" to determine whether or not to replace data in any locally hosted database.

More information on this can be found on the following page: https://help.weatherbit.io/why-does-the-historical-data-change/

Historical Revision Version API

To make it easier to detect when a major or minor data revision has occurred, we have added an API that returns this version. As such there is no need to query a historical API directly.

https://api.weatherbit.io/v2.0/history/revision_version?key=YOUR_API_KEY

{
  "revision_version": "1.0"
}

Conclusion

We hope that our users find value in these updates. We are always looking for ways to improve our API. Feel free to reach out to support@weatherbit.io with any questions or concerns.