CANDELS Query Services

This API allows users to request data from the CANDELS survey. For additional information, see z.MAST documentation.

GET /api/v0.1/candels/metadata/{catalog}.json

Return the hlsp candels metadata for a given catalog.

Return the hlsp candels metadata for a given catalog.

Parameters:

  • catalog (string, required) – Each survey and region has one or more catalogs. The list of available catalogs is available at the ‘/metadata.json’ endpoint for this survey, listed as ‘table’.

Status Codes:
GET /api/v0.1/candels/metadata.json

Return the hlsp candels metadata.

Return the hlsp candels metadata.

Status Codes:

  • 200 OK – dictionary of metadata keys

GET /api/v0.1/candels/count

Search for filtered candels and return count.

Search for filtered candels and return count.

Request Headers:

  • accept (string) –

Query Parameters:

  • ra – RA; must be between zero and 360.0

  • dec – Dec; must be between -90.0 and 90.0

  • radius (number) – Radius; must be between zero and 1.0 degrees

  • sr (number) – The radius for the cone search (alternative to radius)

  • columns (array) – A list of column names to include

  • sort_by (array) – A list of columns to sort by

  • pagesize (integer) – The number of records to return per page

  • catalog (string) – Each survey and region has one or more catalogs. The list of available catalogs is available at the ‘/metadata.json’ endpoint for this survey, listed as ‘table’.

  • flatten_response (boolean) – Request responses to return as a list of lists rather than a list of objects.

  • format – Format of the response (json/csv/xml/votable)

  • delimiter – Delimiter used in csv response

  • raw (boolean) – Request all responses to be in raw form. If false, the response will convert all items of long data type to a string. This is useful for languages with problems encoding long data types.

  • include_info (boolean) – Request responses to include column info. If true, the response will include the info key within the return object with available column information.

Status Codes:
POST /api/v0.1/candels/count

Search for filtered CANDELS and return count.

Search for filtered CANDELS and return count.

Request Headers:

  • accept (string) –

Query Parameters:

  • flatten_response (boolean) – Request responses to return as a list of lists rather than a list of objects.

  • format – Format of the response (json/csv/xml/votable)

  • delimiter – Delimiter used in csv response

  • raw (boolean) – Request all responses to be in raw form. If false, the response will convert all items of long data type to a string. This is useful for languages with problems encoding long data types.

  • include_info (boolean) – Request responses to include column info. If true, the response will include the info key within the return object with available column information.

Status Codes:
GET /api/v0.1/candels/

Search for filtered candels.

Search for filtered candels.

Request Headers:

  • accept (string) –

Query Parameters:

  • ra – RA; must be between zero and 360.0

  • dec – Dec; must be between -90.0 and 90.0

  • radius (number) – Radius; must be between zero and 1.0 degrees

  • sr (number) – The radius for the cone search (alternative to radius)

  • columns (array) – A list of column names to include

  • sort_by (array) – A list of columns to sort by

  • pagesize (integer) – The number of records to return per page

  • catalog (string) – Each survey and region has one or more catalogs. The list of available catalogs is available at the ‘/metadata.json’ endpoint for this survey, listed as ‘table’.

  • flatten_response (boolean) – Request responses to return as a list of lists rather than a list of objects.

  • format – Format of the response (json/csv/xml/votable)

  • delimiter – Delimiter used in csv response

  • raw (boolean) – Request all responses to be in raw form. If false, the response will convert all items of long data type to a string. This is useful for languages with problems encoding long data types.

  • include_info (boolean) – Request responses to include column info. If true, the response will include the info key within the return object with available column information.

Status Codes:
POST /api/v0.1/candels/

Search for filtered CANDELS.

Search for filtered CANDELS.

Request Headers:

  • accept (string) –

Query Parameters:

  • flatten_response (boolean) – Request responses to return as a list of lists rather than a list of objects.

  • format – Format of the response (json/csv/xml/votable)

  • delimiter – Delimiter used in csv response

  • raw (boolean) – Request all responses to be in raw form. If false, the response will convert all items of long data type to a string. This is useful for languages with problems encoding long data types.

  • include_info (boolean) – Request responses to include column info. If true, the response will include the info key within the return object with available column information.

Status Codes: