History on Demand
History on Demand (HoD) APIs provide access to global, historical weather data. Data scientists and developers can use the HoD APIs in Environmental Intelligence to fulfill their needs for historical weather data.
Benefits
- Get weather context
- Get historical weather context from APIs that provide data for gridded currents and agriculture.
- Access summarized data
- Access summarized historical data, such as high temperature trends in the morning, instead of having to process hourly data. Get minimum, maximum, or average values for seven local time dayparts.
Use cases
- A local government organization can calculate the maintenance costs of clearing snowfall to help with budgeting.
- A car wash company needs to predict temperatures, cloud cover, snowfall, and storms to manage labor staffing and plan monthly revenue. On sunny days, staff numbers are at a maximum, while during rain or snow, staffing is reduced.
Samples and tutorials
The IBM Environmental Intelligence GitHub repository contains samples and tutorials for each component. Samples are self-contained, working examples that provide a quick overview of Environmental Intelligence features. Tutorials, in contrast, provide end-to-end detailed instructions, explanations, and examples to help you learn and master Environmental Intelligence capabilities.
The IBM Environmental Intelligence GitHub repository is organized in an easy-to-consume way, so that you can quickly identify use-cases that you might be interested in leveraging.
- auth
- Contains the configuration files that are used to authenticate in the HoD samples and tutorials.
Update the secrets.ini file for the HoD component with the appropriate values, such as your API key, organization ID, and tenant ID.
- samples
- Contains the self-contained, standalone samples for the HoD component.
- tutorials
- Contains the end-to-end detailed tutorials for the HoD component.
Samples and tutorials are written in Jupyter Notebook and are documented as IPYNB files in each directory.
Related information
| I want to... | Link |
|---|---|
| See examples of applications that I can create based on the API. | HoD samples |
| Learn how to use the API and see example calls. | HoD tutorials |
| Learn about the queries that you can run with the HoD Direct API, see the available data sets, and review example calls. | HoD Direct developer guide |
| Dive deeper into the HoD Direct API and learn about data elements and definitions and data sets. | HoD Direct - Additional Information developer guide |
| See the data dictionary for the Historical Data for Analytical Tools API, understand how paging works, and review the details for the daily aggregation periods and CSV column titles. | Historical Data for Analytical Tools developer guide |
| Make my first HoD API call. | Make an API call in API Hub |