|
Size: 649
Comment:
|
Size: 2115
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 10: | Line 10: |
| a web document. The base url for all API calls is | a web document. The base url for all API calls is (including the question mark) |
| Line 14: | Line 14: |
| Following the url base, one can append a list of keywords to specify the type of command and options for that specific command. | |
| Line 15: | Line 16: |
| === Example === | === Simple Search for Features/Events in HER === To do a simple search for Features and Events in HER, one must append to the base url: |
| Line 17: | Line 20: |
| xxx | cmd=search&type=column |
| Line 19: | Line 22: |
In addition to the command (cmd), one must specify which event type to search for. For all event types, use ** {{{ cmd=search&type=column&event_type=** }}} For some but not all event types, use a comma delimited list of two-letter abbreviations (see http://www.lmsal.com/helio-informatics/hpkb/VOEvent_Spec.html for full list of event types). E.g. the following specifies that one wishes to search for active regions, flares and emerging flux regions: {{{ cmd=search&type=column&event_type=ar,fl,ef }}} One must also provide a time window using event_starttime and event_endtime {{{ cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00 }}} To get results in XML format, set ''cosec=1'' {{{ cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00&cosec=1 }}} http://www.lmsal.com/her/dev/search-hpkb/hek?cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00&cosec=1&event_region=all&event_coordsys=helioprojective&x1=-1200&x2=1200&y1=-1200&y2=1200 |
Heliophysics Events Knowledgebase API
Third party clients can communicate with the Heliophysics Events Knowledgebase (HER) via our web API. Usage of an API function amounts to using HTTP to fetch a web document. The base url for all API calls is (including the question mark)
http://www.lmsal.com/her/dev/search-hpkb/hek?
Following the url base, one can append a list of keywords to specify the type of command and options for that specific command.
Simple Search for Features/Events in HER
To do a simple search for Features and Events in HER, one must append to the base url:
cmd=search&type=column
In addition to the command (cmd), one must specify which event type to search for. For all event types, use **
cmd=search&type=column&event_type=**
For some but not all event types, use a comma delimited list of two-letter abbreviations (see http://www.lmsal.com/helio-informatics/hpkb/VOEvent_Spec.html for full list of event types). E.g. the following specifies that one wishes to search for active regions, flares and emerging flux regions:
cmd=search&type=column&event_type=ar,fl,ef
One must also provide a time window using event_starttime and event_endtime
cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00
To get results in XML format, set cosec=1
cmd=search&type=column&event_type=ar,fl,ef&&event_starttime=2007-04-29T00:00:00&event_endtime=2007-05-07T00:00:00&cosec=1
Display
xxx