NASA Exoplanet Archive

Confirmed exoplanets, host stars and mission data.

  • Module name: nea

  • Python class: astroquery.ipac.nexsci.nasa_exoplanet_archive.NasaExoplanetArchive

  • Functions: 9

Call any function below with the astroquery_execute MCP tool. Descriptions are taken from the upstream astroquery/astropy docstrings.

Function

Summary

clear_cache

Removes all cache files.

query_aliases

Search for aliases for a given confirmed planet or planet host

query_criteria

Queries the service and returns a table object.

query_criteria_async

Search a table given a set of criteria or return the full table

query_object

Queries the service and returns a table object.

query_object_async

Search the tables of confirmed exoplanets for information about a planet or planet host

query_region

Queries the service and returns a table object.

query_region_async

Filter a table using a cone search around specified coordinates

reset_cache_location

Resets the cache location to the default astropy cache

Functions

clear_cache

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="clear_cache",
    params={},
)
NasaExoplanetArchiveClass.clear_cache()

Removes all cache files.

query_aliases

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="query_aliases",
    params={"object_name": "<object_name>"},
)
NasaExoplanetArchiveClass.query_aliases(object_name, *, cache=False)

Search for aliases for a given confirmed planet or planet host

Parameters:

  • object_name (str) – The name of a planet or star to regularize using the aliaslookup service.

  • cache (bool, optional) – Should the request result be cached? This can be useful for large repeated queries, but since the data in the archive is updated regularly, this defaults to False.

Returns:

response – A list of aliases found for the object name. The default name will be listed first.

Return type:

list

query_criteria

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="query_criteria",
    params={},
)
NasaExoplanetArchiveClass.query_criteria(*args, **kwargs)

Queries the service and returns a table object.

Search a table given a set of criteria or return the full table

The syntax for these queries is described on the Exoplanet Archive TAP[1]_ API[2]_ documentation pages. In particular, the most commonly used criteria will be select and where.

Parameters:

  • table (str) – The name of the table to query. A list of the tables on the Exoplanet Archive can be found on the documentation pages [1]_, [2]_.

  • get_query_payload (bool, optional) – Just return the dict of HTTP request parameters. Defaults to False.

  • cache (bool, optional) – Should the request result be cached? This can be useful for large repeated queries, but since the data in the archive is updated regularly, this defaults to False.

  • **criteria – The filtering criteria to apply. These are described in detail in the archive documentation [1]_, [2]_ but some examples include select="*" to return all columns of the queried table or where=pl_name='K2-18 b' to filter a specific column.

References

Returns:

table

Return type:

A `~astropy.table.Table object.`

query_criteria_async

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="query_criteria_async",
    params={"table": "<table>"},
)
NasaExoplanetArchiveClass.query_criteria_async(table, get_query_payload=False, cache=None, **criteria)

Search a table given a set of criteria or return the full table

The syntax for these queries is described on the Exoplanet Archive TAP[1]_ API[2]_ documentation pages. In particular, the most commonly used criteria will be select and where.

Parameters:

  • table (str) – The name of the table to query. A list of the tables on the Exoplanet Archive can be found on the documentation pages [1]_, [2]_.

  • get_query_payload (bool, optional) – Just return the dict of HTTP request parameters. Defaults to False.

  • cache (bool, optional) – Should the request result be cached? This can be useful for large repeated queries, but since the data in the archive is updated regularly, this defaults to False.

  • **criteria – The filtering criteria to apply. These are described in detail in the archive documentation [1]_, [2]_ but some examples include select="*" to return all columns of the queried table or where=pl_name='K2-18 b' to filter a specific column.

Returns:

response – The HTTP response returned from the service.

Return type:

requests.Response

References

query_object

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="query_object",
    params={},
)
NasaExoplanetArchiveClass.query_object(*args, **kwargs)

Queries the service and returns a table object.

Search the tables of confirmed exoplanets for information about a planet or planet host

The tables available to this query are the following (more information can be found on the archive’s documentation pages [1]_):

  • ps: This table compiles parameters derived from a multiple published references on separate rows, each row containing self-consistent values from one reference.

  • pscomppars: This table compiles all parameters of confirmed exoplanets from multiple, published references in one row (not all self-consistent) per object.

Parameters:

  • object_name (str) – The name of the planet or star. If regularize is True, an attempt will be made to regularize this name using the aliastable table. Defaults to True.

  • table ([````”ps”:py:class:`` or :py:class:``”pscomppars”:py:class:`]`, optional) – The table to query, must be one of the supported tables: "ps" or "pscomppars". Defaults to "ps".

  • get_query_payload (bool, optional) – Just return the dict of HTTP request parameters. Defaults to False.

  • cache (bool, optional) – Should the request result be cached? This can be useful for large repeated queries, but since the data in the archive is updated regularly, this defaults to False.

  • regularize (bool, optional) – If True, the aliastable will be used to regularize the target name.

  • **criteria – Any other filtering criteria to apply. Values provided using the where keyword will be ignored.

References

Returns:

table

Return type:

A `~astropy.table.Table object.`

query_object_async

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="query_object_async",
    params={"object_name": "<object_name>"},
)
NasaExoplanetArchiveClass.query_object_async(object_name, *, table='ps', get_query_payload=False, cache=None, regularize=True, **criteria)

Search the tables of confirmed exoplanets for information about a planet or planet host

The tables available to this query are the following (more information can be found on the archive’s documentation pages [1]_):

  • ps: This table compiles parameters derived from a multiple published references on separate rows, each row containing self-consistent values from one reference.

  • pscomppars: This table compiles all parameters of confirmed exoplanets from multiple, published references in one row (not all self-consistent) per object.

Parameters:

  • object_name (str) – The name of the planet or star. If regularize is True, an attempt will be made to regularize this name using the aliastable table. Defaults to True.

  • table ([````”ps”:py:class:`` or :py:class:``”pscomppars”:py:class:`]`, optional) – The table to query, must be one of the supported tables: "ps" or "pscomppars". Defaults to "ps".

  • get_query_payload (bool, optional) – Just return the dict of HTTP request parameters. Defaults to False.

  • cache (bool, optional) – Should the request result be cached? This can be useful for large repeated queries, but since the data in the archive is updated regularly, this defaults to False.

  • regularize (bool, optional) – If True, the aliastable will be used to regularize the target name.

  • **criteria – Any other filtering criteria to apply. Values provided using the where keyword will be ignored.

Returns:

response – The HTTP response returned from the service.

Return type:

requests.Response

References

query_region

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="query_region",
    params={},
)
NasaExoplanetArchiveClass.query_region(*args, **kwargs)

Queries the service and returns a table object.

Filter a table using a cone search around specified coordinates

Parameters:

  • table (str) – The name of the table to query. A list of the tables on the Exoplanet Archive can be found on the documentation pages [1]_, [2]_.

  • coordinates (str or coordinates) – The coordinates around which to query.

  • radius (str or Quantity) – The radius of the cone search. Assumed to be have units of degrees if not provided as a Quantity.

  • get_query_payload (bool, optional) – Just return the dict of HTTP request parameters. Defaults to False.

  • cache (bool, optional) – Should the request result be cached? This can be useful for large repeated queries, but since the data in the archive is updated regularly, this defaults to False.

  • **criteria – Any other filtering criteria to apply. These are described in detail in the archive documentation [1]_,[2]_ but some examples include select="*" to return all columns of the queried table or where=pl_name='K2-18 b' to filter a specific column.

References

Returns:

table

Return type:

A `~astropy.table.Table object.`

query_region_async

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="query_region_async",
    params={"table": "<table>", "coordinates": "<coordinates>", "radius": "<radius>"},
)
NasaExoplanetArchiveClass.query_region_async(table, coordinates, radius, *, get_query_payload=False, cache=None, **criteria)

Filter a table using a cone search around specified coordinates

Parameters:

  • table (str) – The name of the table to query. A list of the tables on the Exoplanet Archive can be found on the documentation pages [1]_, [2]_.

  • coordinates (str or coordinates) – The coordinates around which to query.

  • radius (str or Quantity) – The radius of the cone search. Assumed to be have units of degrees if not provided as a Quantity.

  • get_query_payload (bool, optional) – Just return the dict of HTTP request parameters. Defaults to False.

  • cache (bool, optional) – Should the request result be cached? This can be useful for large repeated queries, but since the data in the archive is updated regularly, this defaults to False.

  • **criteria – Any other filtering criteria to apply. These are described in detail in the archive documentation [1]_,[2]_ but some examples include select="*" to return all columns of the queried table or where=pl_name='K2-18 b' to filter a specific column.

Returns:

response – The HTTP response returned from the service.

Return type:

requests.Response

References

reset_cache_location

Call via MCP

astroquery_execute(
    module_name="nea",
    function_name="reset_cache_location",
    params={},
)
NasaExoplanetArchiveClass.reset_cache_location()

Resets the cache location to the default astropy cache