###########################################
Exoplanet Atmosphere Observability Table
###########################################

.. contents:: Table of Contents
    :depth: 3

*******************
Catalog Overview
*******************

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

.. csv-table:: Catalog Tables and Additional Information
    :header: "Catalog", "Table/View", "Additional Information"

    "Observability", *observabilityView*, `EAOT observabilityView Fields`_

.. _EAOT observabilityView Fields: https://catalogs.mast.stsci.edu/eaot/observability-fields.html


*******************
Getting Started
*******************

Quick Start
===============
For more detailed information on using the API, continue below to :ref:`eaot-usage-label`.

Example 1: EAOT Search
-----------------------------------------

Load entire EAOT catalog

.. sourcecode:: http

    https://catalogs.mast.stsci.edu/api/v0.1/eaot/search.json

Click to try `Quick Start Example 1`_

.. _Quick Start Example 1: https://catalogs.mast.stsci.edu/api/v0.1/eaot/search.json

Example 2: EAOT with specific planet name
------------------------------------------------------

Search EAOT catalog where planet name is like "HAT"

.. sourcecode:: http

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

Click to try `Quick Start Example 2`_

.. _Quick Start Example 2: https://catalogs.mast.stsci.edu/api/v0.1/eaot/search.csv?planet_name.like=HAT*

Specify Output Columns
^^^^^^^^^^^^^^^^^^^^^^^^

.. sourcecode:: http

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

Click to try `New API Specify Columns Example`_

.. _New API Specify Columns Example: https://catalogs.mast.stsci.edu/api/v0.1/eaot/search.csv?columns=[planet_name,catalog_name,Rp,Mp]

.. _eaot-usage-label:

**********
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


.. sourcecode:: HTTP
    :caption: Base EAOT Path

    https://catalogs.mast.stsci.edu/api/v0.1/eaot/


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:

.. sourcecode:: HTTP
    :caption: Accessing the different catalogs

    /eaot/search.json?catalog_name=exoplanets.org
    /eaot/search.json?catalog_name=nexsci
    /eaot/search.json?catalog_name=toi


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

.. sourcecode:: HTTP
    :caption: CSV Count Example

    /eaot/search/count.csv


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

.. sourcecode:: HTTP
    :caption: Meta Data Request Example

    /eaot/search/metadata.json


General Searching
------------------------
Please read documentation for more detailed general search guidelines for our catalog services.
:doc:`general_catalog_service`


Formats
^^^^^^^^^^^^^
View :ref:`encoding-formats-label`

.. sourcecode:: HTTP
    :caption: EAOT JSON Format GET

    / Default
    GET /eaot/search

    / With Decorator
    GET /eaot/search.json

    / With Parameter
    GET /eaot/search/format=json

    / With Accept Header
    GET /eaot/search
    ACCEPT: application/json


Selecting Columns
^^^^^^^^^^^^^^^^^^^^^^
View :ref:`selecting-columns-label`

.. sourcecode:: HTTP
    :caption: EAOT planet mass (Mp), planet temperature (Tp) columns GET

    /eaot/search?columns=Mp&columns=Tp
    / note case insensitivity
    /eaot/search?columns=MP&columns=TP

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


Column Filtering
^^^^^^^^^^^^^^^^^^^^^
View :ref:`column-filtering-label`

.. sourcecode:: HTTP
    :caption: EAOT planet radius (Rp) greater than or equal to 1 POST

    /eaot/search
    Rp.gte=1


Sorting
^^^^^^^^^^^^^
View :ref:`sorting-label`

.. sourcecode:: HTTP
    :caption: EAOT Sort By orbital_period descending (DESC) and transit_duration ascending (ASC) POST

    /eaot/search
    sort_by=orbital_period.desc
    sort_by=transit_duration.asc



Paging
^^^^^^^^^^^^^
View :ref:`paging-label`

.. sourcecode:: HTTP
    :caption: EAOT POST Second Page of Page Size of 100

    /eaot/search
    pagesize=100
    page=2


**************************
EAOT API Services
**************************
.. openapi:httpdomain:: _static/swagger/eaot_openapi.json