Version 3.7
Released on 2023-07-06
This product can also be used via a Web API (application programming interface) for programmatically accessing the data by requesting specific URL-encoded parameters. The list of mandatory and optional variables for this specific product are included in tables 1 and 2 below:
Table 1: Mandatory parameters for API access to SPS forecast.
|
Variable |
Values required for this product |
|
pc |
S501 |
|
psc |
a |
|
component |
latest | archive |
Table 2: Optional parameters that can be set to refine the query.
|
Variable |
Values |
|
dts_start |
yyyy-MM-ddTHH:mm:ssZ |
|
dts_end
|
yyyy-MM-ddTHH:mm:ssZ |
To access the latest data, the "component" parameter in the API URL should be set to "latest" (component=latest). The URL is as follows: https://swesnet.asu.cas.cz/prod/API/index.php?component=latest&pc=S501&psc=a
returns the latest ASU CAS flare forecast in XML format.
To access the archived data, the "component" parameter in the API URL should be set to "archive" (component=archive). The URL is as follows: https://swesnet.asu.cas.cz/prod/API/index.php?component=archive&pc=S501&psc=a
returns the archived solar flare forecasts in XML.
In order to select a specific time range, the two parameters "dts_start" and "dts_end" need to be added, using the format yyyy-MM-ddTHH:mm:ssZ
For example, the URL: https://swesnet.asu.cas.cz/prod/API/index.php?component=archive&pc=S501&psc=a&dts_start=2022-12-01T00:00:00Z&dts_end=2022-12-15T23:59:59Z returns an XML structure containing a list of all of the forecasts available from 01-15 December 2022.
The XML output format is widely used and has been developed in a collaboration with CCMC (Community Coordinated Modelling Centre, NASA).
The archive is queryable back to January 2022.