API Documentation

Multivariate Time Series Dataset for Space Weather ANalytics (SWAN)

API Repository

1) Web API

You can access the data directly through the Web API by sending the following requests:

MVTs Dataset

(JSON Format) Query links:

[1] An example of the address for searching MVTS with a harpnum. http://dmlab.cs.gsu.edu/dmlabapi/mvts/mvts_data/json/?harpnum=1090

[2] An example of the address for searching MVTS with a harpnum and a pair of intervals. http://dmlab.cs.gsu.edu/dmlabapi/mvts/mvts_data/json/?harpnum=1090&starttime=2011-11-20T17:12:00&endtime=2011-11-21T17:00:00

[3] An example of the address for searching MVTS with a harpnum, a pair of intervals, limit and offset. http://dmlab.cs.gsu.edu/dmlabapi/mvts/mvts_data/json/?harpnum=1090&starttime=2011-11-20T17:12:00&endtime=2011-11-21T17:00:00&limit=100&offset=10

[4] An example of the address for searching MVTS with a harpnum, a pair of intervals and multiple params.

2) Definitions of parameters in the request url

No.	Parameter	Description	Example	Requirements
1	harpnum	The number of a HARP.	e.g. 1090.	Mandatory
2	starttime	The start timestamp of a MVTS.	e.g. 2011-11-20T17:12:00.	Optional
3	endtime	The end timestamp of a MVTS.	e.g. 2011-11-21T17:00:00.	Optional
4	param	All available parameters of a MVTS.	TOTUSJH, TOTBSQ, TOTPOT, TOTUSJZ, ABSNJZH, SAVNCPP, USFLUX, TOTFZ, MEANPOT, EPSZ, MEANSHR, SHRGT45, MEANGAM, MEANGBT, MEANGBZ, MEANGBH, MEANJZH, TOTFY, MEANJZD, MEANALP, TOTFX, EPSY, EPSX, R_VALUE, CRVAL1, CRLN_OBS, CRLT_OBS, CRVAL2, HC_ANGLE, SPEI, LAT_MIN, LON_MIN, LAT_MAX, LON_MAX, QUALITY, BFLARE, BFLARE_LABEL, CFLARE, CFLARE_LABEL, MFLARE, MFLARE_LABEL, XFLARE, XFLARE_LABEL, BFLARE_LOC, BFLARE_LABEL_LOC, CFLARE_LOC, CFLARE_LABEL_LOC, MFLARE_LOC, MFLARE_LABEL_LOC, XFLARE_LOC, XFLARE_LABEL_LOC, XR_MAX, XR_QUAL, IS_TMFI.	Optional (0, 1 or 1+)
5	limit	It constrains the number of MVTS returned by a request url.	e.g. 100	Positive&Optional
6	offset	It specifies the number of MVTS to skip before starting to return results from the database.	e.g. 10	Positive&Optional

Authors

Cite This

DOI: https://doi.org/10.1038/s41597-020-0548-x

@article{angryk2020multivariate, doi = {10.1038/s41597-020-0548-x}, url = {https://doi.org/10.1038/s41597-020-0548-x}, year = {2020}, month = jul, volume = {7}, number = {1}, author = {Rafal A. Angryk and Petrus C. Martens and Berkay Aydin and Dustin Kempton and Sushant S. Mahajan and Sunitha Basodi and Azim Ahmadzadeh and Xumin Cai and Soukaina Filali Boubrahimi and Shah Muhammad Hamdi and Michael A. Schuh and Manolis K. Georgoulis}, title = {Multivariate time series dataset for space weather data analytics}, journal = {Scientific Data}}

Multivariate Time Series Dataset for Space Weather ANalytics (SWAN)

(JSON Format) Query links: