34. Getting Started with the API¶
In order to use the API, the user must be authenticated and must have authorisation to access the data.
Let's see how to use the API and what sequence of API calls can lead us to get data for analysis.
Once you open the above link the Swagger will open. Click on the 1️⃣ Authorize button, to open the authorisation form.
To authorize, please enter your Username and Password Once you have entered your credentials, click the Authorize button to complete the authorisation process.
Click on the close button or cross button to close the authorisation form.
Examples of Usage of the OSIRIS II API
Please note that the data in the examples provided below DO NOT reflect the actual data in TomorrowNow.
34.1 Accessing the OSIRIS II API¶
To use the API click on the Weather & Climate Data 1️⃣.
Weather & Climate Data API:
Click on the GET API it will show the parameters to enter to get the data. Click on the 1️⃣ Try it out button, to fill the detailed in the 2️⃣ available request parameters. After filling the details click on the 3️⃣ Execute button, to run the API.
Example of response:
Available format types
34.1.1 JSON¶
This type is only available for querying by single point.
34.1.2 CSV¶
The user can download the file to check the response
34.1.3 NETCDF¶
The user can download the file to check the response
To read/write the netcdf file user can refer to below link https://docs.xarray.dev/en/stable/user-guide/io.html#netcdf