[ About | Resources | DONKI ]
DONKI webservice API
List of all DONKI webservice calls that users can make to obtain information from DONKI's database:
Coronal Mass Ejection (CME):
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/CME?startDate=yyyy-MM-dd&endDate=yyyy-MM-ddstartDate: default to 30 days prior to current UTC date
endDate: default to current UTC date
return JSON object:
activityID, startTime, sourceLocation, activeRegionNum, instruments, cmeAnalyses, linkedEvents[(list of) activityID], note, catalog
example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/CME?startDate=2017-01-03&endDate=2017-01-03
[{"activityID":"2017-01-03T03:12:00-CME-001","startTime":"2017-01-03T03:12Z","sourceLocation":"","activeRegionNum":null,"instruments":[{"displayName":"SOHO: LASCO/C2"},{"displayName":"SOHO: LASCO/C3"}],"cmeAnalyses":[{"time21_5":"2017-01-03T13:08Z","latitude":-10.0,"longitude":-105.0,"halfAngle":20.0,"speed":645.0,"type":"C","isMostAccurate":true,"note":"Measured using SOHO LASCO C3 imagery.","levelOfData":0,"enlilList":[{"modelCompletionTime":"2017-01-03T21:57Z","au":2.0,"estimatedShockArrivalTime":null,"estimatedDuration":null,"rmin_re":null,"kp_18":null,"kp_90":null,"kp_135":null,"kp_180":null,"isEarthGB":false,"impactList":[{"isGlancingBlow":false,"location":"Spitzer","arrivalTime":"2017-01-06T07:31Z"},{"isGlancingBlow":true,"location":"Mars","arrivalTime":"2017-01-07T06:00Z"},{"isGlancingBlow":true,"location":"STEREO A","arrivalTime":"2017-01-06T00:00Z"}],"cmeIDs":["2017-01-03T03:12:00-CME-001"]}]},{"time21_5":"2017-01-03T18:39Z","latitude":-12.0,"longitude":-110.0,"halfAngle":13.0,"speed":270.0,"type":"S","isMostAccurate":false,"note":"","levelOfData":0,"enlilList":null}],"linkedEvents":null,"note":"The CME has two stages, the first starting at 03:12Z and the second at 06:00Z. The second stage merges with the first stage and that is what is measured. The source is a small off limb eruption in the SE of SDO AIA 171 between 01:55Z and 02:43Z.","catalog":"SWRC_CATALOG"}]
Coronal Mass Ejection (CME) Analysis:
JSON example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/CMEAnalysis?startDate=2016-09-01&endDate=2016-09-30&mostAccurateOnly=true&speed=500&halfAngle=30&catalog=ALL
startDate: default 30 days prior to current UTC time
endDate: default to current UTC time
mostAccurateOnly: default is set to true
completeEntryOnly: default is set to true
speed (lower limit): default is set to 0
halfAngle (lower limit): default is set to 0
catalog: default is set to ALL (choices: ALL, SWRC_CATALOG, JANG_ET_AL_CATALOG)
keyword: default is set to NONE (example choices: swpc_annex)
JSON object returned:
[{"time21_5":"2016-09-06T14:18Z","latitude":-20.0,"longitude":120.0,"halfAngle":31.0,"speed":674.0,"type":"C","isMostAccurate":true,"associatedCMEID":"2016-09-06T08:54:00-CME-001","note":"","catalog":"SWRC_CATALOG"},{"time21_5":"2016-09-15T04:24Z","latitude":-18.0,"longitude":-122.0,"halfAngle":43.0,"speed":722.0,"type":"C","isMostAccurate":true,"associatedCMEID":"2016-09-14T23:36:00-CME-001","note":"Measured with swpc_cat using C3 and STA Cor2 imagery.","catalog":"SWRC_CATALOG"}]
TEXT example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/CMEAnalysis.txt?startDate=2016-09-01&endDate=2016-09-30&mostAccurateOnly=true&speed=500&halfAngle=30
startDate: default 30 days prior to current UTC time
endDate: default to current UTC time
mostAccurateOnly: default is set to true
completeEntryOnly: default is set to true
speed (lower limit): default is set to 0
halfAngle (lower limit): default is set to 0
catalog: default is set to ALL (choices: ALL, SWRC_CATALOG, JANG_ET_AL_CATALOG)
keyword: default is set to NONE (example choices: swpc_annex)
TEXT output:
2016-09-06T14:18Z lat=-20.0 lon=120.0 rad=31.0 vel=674.0 #2016-09-06T08:54:00-CME-001
2016-09-15T04:24Z lat=-18.0 lon=-122.0 rad=43.0 vel=722.0 #2016-09-14T23:36:00-CME-001
Geomagnetic Storm (GST):
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/GST?startDate=yyyy-MM-dd&endDate=yyyy-MM-ddstartDate: default to 30 days prior to current UTC date
endDate: default to current UTC date
return JSON object:
gstID, startTime, allKpIndex[(list of) observedTime, KpIndex, source], linkedEvents[(list of) activityID]
example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/GST?startDate=2016-01-01&endDate=2016-01-30
[{"gstID":"2016-01-21T03:00:00-GST-001","startTime":"2016-01-21T03:00Z","allKpIndex":[{"observedTime":"2016-01-21T06:00Z","kpIndex":6,"source":"NOAA"}],"linkedEvents":[{"activityID":"2016-01-15T00:00:00-CME-001"},{"activityID":"2016-01-21T10:00:00-HSS-001"}]}]
Interplanetary Shock (IPS):
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/IPS?startDate=yyyy-MM-dd&endDate=yyyy-MM-dd&location=LOCATION&catalog=CATALOGstartDate: default to 30 days prior to current UTC date
endDate: default to current UTC date
location: default to ALL (choices: Earth, MESSENGER, STEREO A, STEREO B)
catalog: default to ALL (choices: SWRC_CATALOG, WINSLOW_MESSENGER_ICME_CATALOG)
return JSON object:
catalog, activityID, location, eventTime, instruments[(list of) displayName]
example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/IPS?startDate=2016-01-01&endDate=2016-01-30
[{"catalog":"SWRC_CATALOG","activityID":"2016-01-09T18:00:00-IPS-001","location":"STEREO A","eventTime":"2016-01-09T18:00Z","instruments":[{"displayName":"STEREO A: IMPACT"},{"displayName":"STEREO A: PLASTIC"}]},{"catalog":"SWRC_CATALOG","activityID":"2016-01-18T21:00:00-IPS-001","location":"Earth","eventTime":"2016-01-18T21:00Z","instruments":[{"displayName":"ACE: MAG"},{"displayName":"ACE: SWEPAM"}]},{"catalog":"SWRC_CATALOG","activityID":"2016-01-21T00:48:00-IPS-001","location":"Earth","eventTime":"2016-01-21T00:48Z","instruments":[{"displayName":"ACE: MAG"},{"displayName":"ACE: SWEPAM"}]}]
Solar Flare (FLR):
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/FLR?startDate=yyyy-MM-dd&endDate=yyyy-MM-ddstartDate: default to 30 days prior to current UTC date
endDate: default to current UTC date
return JSON object:
flrID, instruments[(list of) displayName], begineTime, peakTime, endTime, classType, sourceLocation, activeRegionNum, linkedEvents[(list of) activityID]
example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/FLR?startDate=2016-01-01&endDate=2016-01-30
[{"flrID":"2016-01-01T23:00:00-FLR-001","instruments":[{"displayName":"GOES15: SEM/XRS 1.0-8.0"}],"beginTime":"2016-01-01T23:00Z","peakTime":"2015-01-02T00:10Z","endTime":null,"classType":"M2.3","sourceLocation":"S21W73","activeRegionNum":12473,"linkedEvents":[{"activityID":"2016-01-01T23:12:00-CME-001"},{"activityID":"2016-01-02T02:48:00-SEP-001"},{"activityID":"2016-01-02T04:30:00-SEP-001"}]},{"flrID":"2016-01-28T11:48:00-FLR-001","instruments":[{"displayName":"GOES15: SEM/XRS 1.0-8.0"}],"beginTime":"2016-01-28T11:48Z","peakTime":"2016-01-28T12:02Z","endTime":"2016-01-28T12:56Z","classType":"C9.6","sourceLocation":"N03W47","activeRegionNum":12488,"linkedEvents":[{"activityID":"2016-01-28T12:24:00-CME-001"}]}]
Solar Energetic Particle (SEP):
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/SEP?startDate=yyyy-MM-dd&endDate=yyyy-MM-ddstartDate: default to 30 days prior to current UTC date
endDate: default to current UTC date
return JSON object:
sepID, eventTime, instruments[(list of) displayName], linkedEvents[(list of) activityID]
example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/SEP?startDate=2016-01-01&endDate=2016-01-30
[{"sepID":"2016-01-02T02:48:00-SEP-001","eventTime":"2016-01-02T02:48Z","instruments":[{"displayName":"SOHO: COSTEP 15.8-39.8 MeV"}],"linkedEvents":[{"activityID":"2016-01-01T23:00:00-FLR-001"},{"activityID":"2016-01-01T23:12:00-CME-001"}]},{"sepID":"2016-01-02T04:30:00-SEP-001","eventTime":"2016-01-02T04:30Z","instruments":[{"displayName":"GOES13: SEM/EPS >10 MeV"}],"linkedEvents":[{"activityID":"2016-01-01T23:00:00-FLR-001"},{"activityID":"2016-01-01T23:12:00-CME-001"}]}]
Magnetopause Crossing (MPC):
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/MPC?startDate=yyyy-MM-dd&endDate=yyyy-MM-ddstartDate: default to 30 days prior to current UTC date
endDate: default to current UTC date
return JSON object:
mpcID, eventTime, instruments[(list of) displayName], linkedEvents[(list of) activityID]
example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/MPC?startDate=2016-01-01&endDate=2016-03-31
[{"mpcID":"2016-03-06T16:32:00-MPC-001","eventTime":"2016-03-06T16:32Z","instruments":[{"displayName":"MODEL: SWMF"}],"linkedEvents":[{"activityID":"2016-03-06T04:30:00-IPS-001"},{"activityID":"2016-03-06T09:00:00-HSS-001"},{"activityID":"2016-03-06T18:00:00-GST-001"}]},{"mpcID":"2016-03-11T13:00:00-MPC-001","eventTime":"2016-03-11T13:00Z","instruments":[{"displayName":"MODEL: SWMF"}],"linkedEvents":[{"activityID":"2016-03-11T04:21:00-IPS-001"},{"activityID":"2016-03-11T12:00:00-GST-001"}]}]
Radiation Belt Enhancement (RBE):
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/RBE?startDate=yyyy-MM-dd&endDate=yyyy-MM-ddstartDate: default to 30 days prior to current UTC date
endDate: default to current UTC date
return JSON object:
rbeID, eventTime, instruments[(list of) displayName], linkedEvents[(list of) activityID]
example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/RBE?startDate=2016-01-01&endDate=2016-01-31
[{"rbeID":"2016-01-02T12:25:00-RBE-001","eventTime":"2016-01-02T12:25Z","instruments":[{"displayName":"GOES13: SEM/EPS >0.8 MeV"}],"linkedEvents":[{"activityID":"2015-12-28T12:39:00-CME-001"}]},{"rbeID":"2016-01-24T15:05:00-RBE-001","eventTime":"2016-01-24T15:05Z","instruments":[{"displayName":"GOES13: SEM/EPS >0.8 MeV"}],"linkedEvents":[{"activityID":"2016-01-21T10:00:00-HSS-001"}]}]
Hight Speed Stream (HSS):
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/HSS?startDate=yyyy-MM-dd&endDate=yyyy-MM-ddstartDate: default to 30 days prior to current UTC date
endDate: default to current UTC date
return JSON object:
hssID, eventTime, instruments[(list of) displayName], linkedEvents[(list of) activityID]
example:
https://kauai.ccmc.gsfc.nasa.gov/DONKI/WS/get/RBE?startDate=2016-01-01&endDate=2016-01-31
[{"hssID":"2016-01-11T12:00:00-HSS-001","eventTime":"2016-01-11T12:00Z","instruments":[{"displayName":"ACE: SWEPAM"},{"displayName":"ACE: MAG"}],"linkedEvents":null},{"hssID":"2016-01-21T10:00:00-HSS-001","eventTime":"2016-01-21T10:00Z","instruments":[{"displayName":"ACE: SWEPAM"},{"displayName":"ACE: MAG"}],"linkedEvents":[{"activityID":"2016-01-21T03:00:00-GST-001"},{"activityID":"2016-01-24T15:05:00-RBE-001"}]}]
WSA+EnlilSimulation:
startDate: default to 7 days prior to current UTC date
endDate: default to current UTC date
JSON Object returned:
simulationID
modelCompletionTime
au
cmeInputs (list of): cmeStartTime, latitude, longitude, speed, halfAngel, time21_5, cmeid
estimatedShockArrivalTime
estimatedDuration
rmin_re
kp_18
kp_90
kp_135
kp_180
isEarthGB
impactList (list of): isGlancingBlow, location, arrivalTime
ipsList (list of):activityID, location, eventTime, instruments
[{"simulationID":"WSA-ENLIL/10003/1","modelCompletionTime":"2016-01-06T02:34Z","au":2.0,"cmeInputs":[{"cmeStartTime":"2016-01-05T04:36Z","latitude":-21.0,"longitude":105.0,"speed":530.0,"halfAngle":19.0,"time21_5":"2016-01-05T04:36Z","ipsList":[],"cmeid":"2016-01-05T04:36:00-CME-001"}],"estimatedShockArrivalTime":null,"estimatedDuration":null,"rmin_re":null,"kp_18":null,"kp_90":null,"kp_135":null,"kp_180":null,"isEarthGB":false,"impactList":null},{"simulationID":"WSA-ENLIL/10005/1","modelCompletionTime":"2016-01-06T18:34Z","au":2.0,"cmeInputs":[{"cmeStartTime":"2016-01-06T14:24Z","latitude":-7.0,"longitude":138.0,"speed":940.0,"halfAngle":45.0,"time21_5":"2016-01-06T17:59Z","ipsList":[{"catalog":null,"activityID":"2016-01-09T18:00:00-IPS-001","location":"STEREO A","eventTime":"2016-01-09T18:00Z","instruments":[{"displayName":"STEREO A: IMPACT"},{"displayName":"STEREO A: PLASTIC"}]}],"cmeid":"2016-01-06T14:24:00-CME-001"}],"estimatedShockArrivalTime":null,"estimatedDuration":null,"rmin_re":null,"kp_18":null,"kp_90":null,"kp_135":null,"kp_180":null,"isEarthGB":false,"impactList":[{"isGlancingBlow":false,"location":"STEREO B","arrivalTime":"2016-01-08T22:56Z"},{"isGlancingBlow":true,"location":"STEREO A","arrivalTime":"2016-01-09T08:00Z"}]}]
Notifications:
parameters:
'startDate' and 'endDate' are in format 'yyyy-MM-dd' UT
'type' could be: all, FLR, SEP, CME, IPS, MPC, GST, RBE, report
Note:
'startDate' if left out would default to 7 days prior to the current UT date
'endDate' if left out would default to current UT date
'type' if left out would default to 'all'
The request date range is limit to 30 days. If the request range is greater than 30 days, it would limit your request range to (endDate-30) to endDate.
Return JSON objects (list of notification objects):
example:
{"messageType":"FLR", "messageID":"20140508-AL-002", "messageURL":"https://kauai.ccmc.gsfc.nasa.gov/DONKI/view/Alert/5432/1", "messageIssueTime":"2014-05-08T12:43Z", "messageBody":"## NASA Goddard Space Flight Center, Space Weather Research Center ( SWRC )\n## Message Type: Space Weather Notification - M5.2 Flare\n##\n## Message Issue Date: 2014-05-08T12:43:04Z\n## Message ID: 20140508-AL-002\n##\n## Disclaimer: NOAA's Space Weather Prediction Center (http://swpc.noaa.gov) is the United States Government official source for space weather forecasts. This \"Experimental Research Information\" consists of preliminary NASA research products and should be interpreted and used accordingly.\n\n\n## Summary:\n\nSignificant flare detected by GOES.\n\nFlare start time: 2014-05-08T09:20Z. \n\nFlare peak time: 2014-05-08T10:07Z.\n\nFlare intensity: M5.2 class.\n\nSource region: N05E55 (Active Region 12056) (based on SDO imagery).\n\nIncreased energetic proton fluxes possible. Updates on this event will be provided when available.\n\nActivity ID: 2014-05-08T09:20:00-FLR-001.\n\n## Notes: \n\n\n\n"}