Any data that can be retrieved from the database using the primary html interface can also be accessed as a json formatted file. The most up-to-date API can be accessed at kronos.uchicago.edu/snax/urlQuery, although we recommend using the permanent reference at kronos.uchicago.edu/snax/urlQuery/v1.0/json.php to reduce risk of future incompatability. This access uses the same GET queries as the main html page, with the addition of an "output" formatting variable.
The following parameters can be used to specify data retrieved using the API:-
output:
String specifying what information to display for each entry corresponding returned by the search. Separate keywords with a comma, for a list of keywords see the export keyword help. The default value is 'name,dateObserved,instrument,age,lum'. -
objid:
Exact name of object, e.g. 'SN 2005kd'. -
name:
String included in object name, e.g. '2005'. Also accepts boolean keywords "AND" "OR" "NOT", e.g. '2005 AND 2006'. -
typeid:
Exact name of supernova type, e.g. 'IIn'. -
type:
String included in type, e.g. 'n'. -
galaxyid:
Exact galaxy identifier string, e.g. 'NGC 5457'. We don't store all alternate names, so a galaxy search will only return an entry if the query uses a catalog identifier we have stored. -
galaxy:
String included in galaxy identifier, e.g. '5457'. -
instrumentid:
Exact name of instrument used in observation. Because some specifics may be inconsistent, such as "Chandra" vs. "Chandra ACIS-S", the "instrument" search parameter may be useful more often. -
instrument:
String contained in the instrument name, e.g. "Chandra". -
fluxMin:
Lower bound on measured flux, in 10-13 erg cm-2 s-1 . -
fluxMax:
Upper bound on flux, in 10-13 erg cm-2 s-1 -
fluxEnergyLMin:
Lower bound on the lower value of the measurement's energy range, in KeV. For example, if this variable is set to '1', then nothing calculated for .3-8 KeV will be returned, although measurements at 2-8 KeV will show up. -
fluxEnergyLMax:
Upper bound on the lower value of energy range. -
fluxEnergyHMin:
Upper bound on the upper value of energy range. -
fluxEnergyHMax:
Upper bound on the upper value of energy range. -
lumMin:
Lower bound of luminosity, in 1037 erg s-1 . -
lumMax:
Upper bound of luminosity, in 1037 erg s-1 . -
ageMin:
Lower bound of time since explosion, in days. -
ageMax:
Upper bound of time since explosion, in days. -
dateMin:
Supernova exploded after this date, in mm/dd/yy. -
dateMax:
Supernova exploded before this date, in mm/dd/yy.
Some examples:
- Get the observation date, time since explosion, and luminosities for SN 2005kd: kronos.uchicago.edu/snax/urlQuery/v1.0/json.php?output=dateExploded,age,lum&name=2005kd