Repository navigation
Archive 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 |
Removes all cache files.
NasaExoplanetArchive.clear_cache()Call via MCP
astroquery_execute(
module_name="nea",
function_name="clear_cache",
params={},
)Parameters
No parameters.
Search for aliases for a given confirmed planet or planet host
NasaExoplanetArchive.query_aliases(object_name, *, cache=False)Call via MCP
astroquery_execute(
module_name="nea",
function_name="query_aliases",
params={"object_name": "<object_name>"},
)Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
object_name (required)
|
str | The name of a planet or star to regularize using the aliaslookup service. |
|
cache |
bool | False |
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
list — A list of aliases found for the object name. The default name will be listed first.
Queries the service and returns a table object.
NasaExoplanetArchive.query_criteria(*args, **kwargs)Call via MCP
astroquery_execute(
module_name="nea",
function_name="query_criteria",
params={},
)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
| Parameter | Type | Default | Description |
|---|---|---|---|
*args |
|||
**kwargs |
Returns
A Table object. —
References
.. [1] NASA Exoplanet Archive TAP Documentation .. [2] NASA Exoplanet Archive API Documentation
Search a table given a set of criteria or return the full table
NasaExoplanetArchive.query_criteria_async(table, get_query_payload=False, cache=None, **criteria)Call via MCP
astroquery_execute(
module_name="nea",
function_name="query_criteria_async",
params={"table": "<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
| Parameter | Type | Default | Description |
|---|---|---|---|
table (required)
|
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 | False |
Just return the dict of HTTP request parameters. Defaults to False. |
cache |
bool | None |
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 |
Returns
requests.Response — The HTTP response returned from the service.
References
.. [1] NASA Exoplanet Archive TAP Documentation .. [2] NASA Exoplanet Archive API Documentation
Queries the service and returns a table object.
NasaExoplanetArchive.query_object(*args, **kwargs)Call via MCP
astroquery_execute(
module_name="nea",
function_name="query_object",
params={},
)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
| Parameter | Type | Default | Description |
|---|---|---|---|
*args |
|||
**kwargs |
Returns
A Table object. —
References
.. [1] NASA Exoplanet Archive TAP Documentation .. [2] NASA Exoplanet Archive API Documentation
Search the tables of confirmed exoplanets for information about a planet or planet host
NasaExoplanetArchive.query_object_async(object_name, *, table='ps', get_query_payload=False, cache=None, regularize=True, **criteria)Call via MCP
astroquery_execute(
module_name="nea",
function_name="query_object_async",
params={"object_name": "<object_name>"},
)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
| Parameter | Type | Default | Description |
|---|---|---|---|
object_name (required)
|
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" or "pscomppars"] |
'ps' |
The table to query, must be one of the supported tables: "ps" or "pscomppars". Defaults to "ps". |
get_query_payload |
bool | False |
Just return the dict of HTTP request parameters. Defaults to False. |
cache |
bool | None |
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 | True |
If True, the aliastable will be used to regularize the target name. |
**criteria |
Returns
requests.Response — The HTTP response returned from the service.
References
.. [1] NASA Exoplanet Archive TAP Documentation .. [2] NASA Exoplanet Archive API Documentation
Queries the service and returns a table object.
NasaExoplanetArchive.query_region(*args, **kwargs)Call via MCP
astroquery_execute(
module_name="nea",
function_name="query_region",
params={},
)Filter a table using a cone search around specified coordinates
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
*args |
|||
**kwargs |
Returns
A Table object. —
References
.. [1] NASA Exoplanet Archive TAP Documentation .. [2] NASA Exoplanet Archive API Documentation
Filter a table using a cone search around specified coordinates
NasaExoplanetArchive.query_region_async(table, coordinates, radius, *, get_query_payload=False, cache=None, **criteria)Call via MCP
astroquery_execute(
module_name="nea",
function_name="query_region_async",
params={"table": "<table>", "coordinates": "<coordinates>", "radius": "<radius>"},
)Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
table (required)
|
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 (required)
|
str or coordinates
|
The coordinates around which to query. | |
radius (required)
|
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 | False |
Just return the dict of HTTP request parameters. Defaults to False. |
cache |
bool | None |
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 |
Returns
requests.Response — The HTTP response returned from the service.
References
.. [1] NASA Exoplanet Archive TAP Documentation .. [2] NASA Exoplanet Archive API Documentation
Resets the cache location to the default astropy cache
NasaExoplanetArchive.reset_cache_location()Call via MCP
astroquery_execute(
module_name="nea",
function_name="reset_cache_location",
params={},
)Parameters
No parameters.
Auto-generated from source docstrings on each release. Do not edit here — changes are overwritten.