DvData Web Services

GET /api/v0.1/dvdata/info/?

Get metadata about the information returned in DV Data table queries.

Returns:

JSON DV metadata dictionary

Example request:

GET /api/v0.1/dvdata/info  HTTP/1.1
Host: exo.mast.stsci.edu

Example response:

HTTP/1.1 200 OK
Content-Length: 12694
Content-Type: text/json; charset=UTF-8

{"DV Data Table Description": [
    {"description": "unique Kepler target identifier",
     "colname": "KEPLERID",
     "datatype": "int"},
    {"description": "name of extension",
     "colname": "EXTNAME",
     "datatype": "varchar(10)"}, ...
Status Codes:
GET /api/v0.1/dvdata/([a-zA-Z0-9]+)/info/?

Get metadata about given Kepler ID and TCE.

If no TCE is supplied, TCE specific headers are ommitted from the response.

Parameters:
  • star_id (string) – The Kepler ID
  • tce (string) – The TCE (TCE_# or #)
  • list_tce (bool) – If this argument is present, include the list of TCEs
Returns:

JSON string of metadata

Example request:

GET /api/v0.1/dvdata/8394721/info/?tce=1&list_tce HTTP/1.1
Host: exo.mast.stsci.edu

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/json; charset=UTF-8

{"DV Data Header": {DATE_OBS: "2009-05-13 00:01:07.137000",
                    PRADIUS; 7.414486640355018,
                    ...},
 "DV Primary Header": {NEXTEND: 6,
                       OBJECT: "KIC 8394721",
                       AV: 0.398,
                       ...},
 "TCE": ["TCE_1", "TCE_3", "TCE_2", "TCE_4"] }
Status Codes:
GET /api/v0.1/dvdata/([a-zA-Z0-9]+)/tces/?

Get a list of TCEs associated with the given Kepler ID.

Parameters:
  • star_id (string) – The Kepler ID
Returns:

JSON string of the form {TCE: [TCE_1, TCE_2, ...]}

Example request:

GET /api/v0.1/dvdata/8394721/tces/ HTTP/1.1
Host: exo.mast.stsci.edu

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/json; charset=UTF-8

{"TCE": ["TCE_1", "TCE_3", "TCE_2", "TCE_4"]}
Status Codes:
GET /api/v0.1/dvdata/([a-zA-Z0-9]+)/table/?

Gets data table associated with a given kepler id and TCE. If no TCE is supplied, the data table for the first TCE is returned. This light curve has been median detrended, but no transits have been removed.

Parameters:
  • star_id (string) – The Kepler ID
  • tce (string) – The TCE (TCE_#)
Returns:

JSON string of the form {fields: [column names/types/descriptions], data: [data rows]}

Example request:

GET /api/v0.1/dvdata/8394721/table/?tce=2 HTTP/1.1
Host: exo.mast.stsci.edu

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/json; charset=UTF-8

{"fields":[{colname: "KEPLERID",
            datatype: "int",
            description: "unique Kepler target identifier"},
           ...],
 "data": [{'EXTNAME': 'TCE_2',
           'MODEL_WHITE': -0.02279440499842167,
           'PHASE': 8.375410079956055,
           'LC_INIT_ERR': 0.00019099553173873574,
           'LC_INIT': 0.0006834766245447099,
           'LC_WHITE': 2.559422492980957,
           'CADENCENO': 1105,
           'LC_DETREND': 0.0006834766245447099,
           'MODEL_INIT': 0.0,
           'TIMECORR': -0.0007000599289312959,
           'KEPLERID': 8394721,
           'TIME': 131.51169387994014},
          ...]}
Status Codes:
GET /api/v0.1/dvdata/([a-zA-Z0-9]+)/phaseplot/?

Returns a phased lightcurve plot of DV data for given Kepler ID and TCE. If no TCE is supplied TCE_1 is assumed, however this behavior will eventually change, and should not be depended on.

The columns use to make the plot are as follows:

  • LC_DETREND: Initial median detrended time series, used for the detrended light curve and binned light curve
  • MODEL_INIT: Model light curve, used for the transit model curve
  • PHASE: Phase using period and epoch
Parameters:
  • star_id (string) – The Kepler ID
  • tce (string) – The TCE (TCE_# or #)
  • splitphase (bool) – If this argument is present even and odd phases will be plotted seperately.
  • embed (bool) – If this argument is present the response will be a json object containing all necessary information to embed the plot in a webpage. If this argument is not present the HTML plot will be returned.
Returns:

JSON string of the form {fields: [column names/types/descriptions], data: [data rows]}

Example request:

GET /api/v0.1/dvdata/8394721/phaseplot/?tce=2&embed HTTP/1.1
Host: exo.mast.stsci.edu

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/json; charset=UTF-8

{resources: {js:   "\n<script type=\"text/ja...,
             css:"\n<style>\n /* BEGIN... },
 script: "\n<script type-\"text/ja...,
 div: "\n<div class=\"bk-root\"...}
}
Status Codes: