Lightcurve Web Services

GET /api/v0.1/dvdata/{mission}/info/

DV Data table metadata

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

Parameters:

mission (string, required) – The mission (tess/kepler)

Status Codes:

JSON DV metadata dictionary

HTTP/1.1 200 OK
Content-Type: application/json

{
  "DV Data Table Description": [
    {
      "description": "unique Kepler target identifier",
      "colname": "KEPLERID",
      "datatype": "int"
    },
    {
      "description": "name of extension",
      "colname": "EXTNAME",
      "datatype": "varchar(10)"
    }
  ]
}

422 Unprocessable Entity – Validation Error

GET /api/v0.1/dvdata/{mission}/{star_id}/info/

Kepler/TESS ID and TCE metadata.

Get metadata about given Kepler/TESS ID and TCE. If no TCE is supplied, TCE specific headers are omitted from the response.

Parameters:

mission (string, required) – The mission (tess/kepler)
star_id (string, required) – The TESS/Kepler ID

Query Parameters:

list_tce – Flag to include list of TCEs
tce – The TCE (TCE_# or #)
sector – The TESS sector identifier (eg, s0001-s0001 or # for a single sector)

Status Codes:

200 OK –

JSON string of Kepler/TESS ID and TCE metadata

HTTP/1.1 200 OK
Content-Type: application/json

{
  "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"
  ]
}

400 Bad Request – Missing sector in TESS request
422 Unprocessable Entity – Validation Error

GET /api/v0.1/dvdata/{mission}/{star_id}/tces/

Kepler/TESS ID associated TCEs.

Get a list of TCEs associated with the given Kepler/TESS ID.TESS TCEs will include the sector information as well.

Parameters:

mission (string, required) – The mission (tess/kepler)
star_id (string, required) – The TESS/Kepler ID

Status Codes:

200 OK – JSON string of TCEs for Kepler or TESS.
422 Unprocessable Entity – Validation Error

GET /api/v0.1/dvdata/{mission}/{star_id}/table

TESS/Kepler ID and TCE associated table data

Gets data table associated with a given tess/kepler id and TCE.For Kepler, 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.For TESS, both TCE and Sector are required. You can use the /tces endpoint to check the available data.

Parameters:

mission (string, required) – The mission (tess/kepler)
star_id (string, required) – The TESS/Kepler ID

Query Parameters:

tce – The TCE (TCE_# or #)
sector – The TESS sector identifier (eg, s0001-s0001 or # for a single sector)

Status Codes:

200 OK –

JSON string containing data associated with tess/kepler id and TCE

HTTP/1.1 200 OK
Content-Type: application/json

{
  "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
    }
  ]
}

400 Bad Request – Bad Request: Missing sector/tce in TESS call. Use /tces call to get options
422 Unprocessable Entity – Validation Error

GET /api/v0.1/dvdata/{mission}/{star_id}/phaseplot/

DV Data phased lightcurve plot

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 eventuallychange, and should not be depended on.For TESS, both TCE and Sector are required. You can use the /tces endpoint to check the available data.

Parameters:

mission (string, required) – The mission (tess/kepler)
star_id (string, required) – The Kepler/TESS ID

Query Parameters:

embed – If this flag 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.
splitphase – If this flag argument is present even and odd phases will be plotted separately
tce – The TCE (TCE_# or #)
sector – The TESS sector identifier (eg, s0001-s0001 or # for a single sector)

Status Codes:

200 OK –

Phased lightcurve plot

HTTP/1.1 200 OK
Content-Type: text/html

<!DOCTYPE html> <html lang='en'>...

400 Bad Request – Bad Request: Missing sector/tce in TESS call. Use /tces call to get options
422 Unprocessable Entity – Validation Error