3D-HST Query Services

This API allows users to request data from the 3D-HST survey. For additional information, see z.MAST documentation.

GET /api/v0.1/3dhst/metadata/{catalog}.json

Return the HLSP 3D HST metadata for a given catalog.

Return the HLSP 3D HST 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/3dhst/metadata.json

Return the HLSP 3D HST metadata.

Return the HLSP 3D HST metadata.

Status Codes:

  • 200 OK – dictionary of metadata keys

GET /api/v0.1/3dhst/count

Search for hlsp 3D HSTs and return count.

Search for hlsp 3D HSTs 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/3dhst/count

Search for HLSP 3D HSTs and return count.

Search for HLSP 3D HSTs 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/3dhst/

Search for hlsp 3D HST data using given filters

Search for hlsp 3D HST data using given filters

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/3dhst/

Search for HLSP 3D HST using filters on ra, dec etc.

Search for HLSP 3D HST using filters on ra, dec etc.

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: