Exoplanet Atmosphere Observability Table

Catalog Overview

The Exoplanet Atmosphere Observability Table (EAOT) provides data about exoplanets from exoplanets.org, NExSci, and TOIs.

Catalog Tables and Additional Information

Catalog

Table/View

Additional Information

Observability

observabilityView

EAOT observabilityView Fields

Getting Started

Quick Start

For more detailed information on using the API, continue below to Usage.

Example 2: EAOT with specific planet name

Search EAOT catalog where planet name is like “HAT”

GET https://catalogs.mast.stsci.edu/api/v0.1/eaot/search.csv?planet_name.like=HAT* HTTP/1.1

Click to try Quick Start Example 2

Specify Output Columns
GET https://catalogs.mast.stsci.edu/api/v0.1/eaot/search.csv?columns=[planet_name,catalog_name,Rp,Mp] HTTP/1.1

Click to try New API Specify Columns Example

Usage

Access

The EAOT API can be accessed using GET or POST requests. POST is recommended due to the potentially large request size.

Note Currently, the /metadata endpoint only supports GET

Note If duplicate parameters are present in the query string and request body of a POST, the request body will override behavior

Base EAOT Path
GET https://catalogs.mast.stsci.edu/api/v0.1/eaot/ HTTP/1.1

Selecting Catalogs

The EAOT API currently supports the querying of exoplanets.org, NEXSCI, and TOI. To access the different version of the HSC catalogs, indicate the version within the path:

Accessing the different catalogs
GET /eaot/search.json?catalog_name=exoplanets.org HTTP/1.1

GET /eaot/search.json?catalog_name=nexsci HTTP/1.1

GET /eaot/search.json?catalog_name=toi HTTP/1.1

Searching EAOT

Count

Counts may be returned based on a given query (search query creation details below)

To access counts, append the /count path

Example Count for EAOT

CSV Count Example
GET /eaot/search/count.csv HTTP/1.1

Meta Data

The /metadata path provides additional information of available columns for a given catalog. The additional information includes: column name, column data type, and column description.

Example Receive metadata for EAOT

Meta Data Request Example
GET /eaot/search/metadata.json HTTP/1.1

General Searching

Please read documentation for more detailed general search guidelines for our catalog services. Using MAST Catalogs

Formats

View Encoding Formats

Default

EAOT JSON Format GET
GET /eaot/search HTTP/1.1

With Decorator

GET /eaot/search.json HTTP/1.1

With Parameter

GET /eaot/search/format=json HTTP/1.1

With Accept Header

GET /eaot/search HTTP/1.1
Accept: application/json
Selecting Columns

View Selecting Columns

EAOT planet mass (Mp), planet temperature (Tp) columns GET
GET /eaot/search?columns=Mp&columns=Tp HTTP/1.1

note case insensitivity

GET /eaot/search?columns=MP&columns=TP HTTP/1.1

GET /eaot/search?columns=["Mp","Tp"] HTTP/1.1

GET /eaot/search?columns=[Mp,Tp] HTTP/1.1
Column Filtering

View Column Filtering

EAOT planet radius (Rp) greater than or equal to 1 POST
GET /eaot/search?Rp.gte=1 HTTP/1.1
Sorting

View Sorting

EAOT Sort By orbital_period descending (DESC) and transit_duration ascending (ASC) POST
GET /eaot/search?sort_by=orbital_period.desc&sort_by=transit_duration.asc HTTP/1.1
Paging

View Paging

EAOT POST Second Page of Page Size of 100
GET /eaot/search?pagesize=100&page=2 HTTP/1.1

EAOT API Services

GET /api/v0.1/eaot/search/metadata{additional_args}

Return column metadata

Return column metadata

Status Codes:
GET /api/v0.1/eaot/search{additional_args}

Subset of Exoplanet observability view based on filter criteria

Query view based on filter criteria

Query Parameters:

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

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

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

  • page (integer) – If using pagesize, the page number to return

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

  • format ({'string', 'null'}) – Format of the response (json/csv/xml/votable)

  • delimiter ({'string', 'null'}) – 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:
Request Headers:

  • accept

POST /api/v0.1/eaot/search{additional_args}

Post method for search requests

POST request for subset of Exoplanet observability view based on filter criteria

Query Parameters:

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

  • format ({'string', 'null'}) – Format of the response (json/csv/xml/votable)

  • delimiter ({'string', 'null'}) – 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:
Request Headers:

  • accept