Archive Gaia

ESA Gaia mission archive (astrometry, photometry, spectra).

• Module name: gaia
• Python class: astroquery.gaia.Gaia
• Functions: 40

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

Function	Summary
cone_search	Cone search sorted by distance (sync.)
cone_search_async	Cone search sorted by distance (async)
correct_table_units	Correct format in the units of the columns
cross_match	Performs a positional cross-match between the specified tables.
cross_match_basic	Performs a positional cross-match between the specified tables.
delete_user_table	Removes a user table
get_args_4_rename_table	Gaia.get_args_4_rename_table
get_current_column_values_for_update	Gaia.get_current_column_values_for_update
get_datalinks	Gets datalinks associated to the provided identifiers
get_new_column_values_for_update	Gaia.get_new_column_values_for_update
get_status_messages	Retrieve the messages to inform users about
get_table_update_arguments	Gaia.get_table_update_arguments
launch_job	Launches a synchronous job
launch_job_async	Launches an asynchronous job
list_async_jobs	Returns all the asynchronous jobs
load_async_job	Loads an asynchronous job
load_data	Loads the specified table
load_group	Load group with title being group_name
load_groups	Loads groups
load_shared_items	Loads shared items
load_table	Loads the table metadata, for the specified table. If the user is logged in, the table can refer to a
load_tables	Loads all public tables
load_user	Loads the specified user
login	Performs a login.
login_gui	Performs a login using a GUI dialog
logout	Performs a logout
query_object	Launches a synchronous cone search for the input search radius or the box on the sky, sorted by angular
query_object_async	Launches an asynchronous cone search for the input search radius or the box on the sky, sorted by angular
remove_jobs	Removes the specified jobs
rename_table	This method allows you to update the column names of a user table.
save_results	Saves job results
search_async_jobs	Searches for jobs applying the specified filter
share_group_add_user	Adds user to a group
share_group_create	Creates a group
share_group_delete	Deletes a group
share_group_delete_user	Deletes user from a group
share_table	Shares a table with a group
share_table_stop	Stop sharing a table
upload_table	Uploads a table to the user private space
upload_table_from_job	Creates a table to the user private space from a job

Functions

cone_search

Cone search sorted by distance (sync.)

Gaia.cone_search(coordinate, *, radius=None, table_name=None, ra_column_name='ra', dec_column_name='dec', output_file=None, output_format='votable_gzip', verbose=False, dump_to_file=False, columns=())

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="cone_search",
    params={"coordinate": "<coordinate>"},
)

TAP & TAP+

Parameters

Parameter	Type	Default	Description
coordinate (required)	str or astropy.coordinate, mandatory		coordinates center point
radius	str or astropy.units, mandatory	None	radius
table_name	str, optional, default main gaia table name doing the cone search against	None
ra_column_name	str, optional, default ra column in main gaia table	'ra'	ra column doing the cone search against
dec_column_name	str, optional, default dec column in main gaia table	'dec'	dec column doing the cone search against
output_file	str, optional, default None	None	file name where the results are saved if dump_to_file is True. If this parameter is not provided, the jobid is used instead
output_format	str, optional, default 'votable_gzip'	'votable_gzip'	results format. Available formats are: 'votable', 'votable_plain', 'fits', 'csv', 'ecsv' and 'json', default is 'votable'.
verbose	bool, optional, default 'False'	False	flag to display information about the process
dump_to_file	bool, optional, default 'False'	False	if True, the results are saved in a file instead of using memory
columns	list, optional, default ()	()	if empty, all columns will be selected

Returns

A Job object —

cone_search_async

Cone search sorted by distance (async)

Gaia.cone_search_async(coordinate, *, radius=None, table_name=None, ra_column_name='ra', dec_column_name='dec', background=False, output_file=None, output_format='votable_gzip', verbose=False, dump_to_file=False, columns=())

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="cone_search_async",
    params={"coordinate": "<coordinate>"},
)

TAP & TAP+

Parameters

Parameter	Type	Default	Description
coordinate (required)	str or astropy.coordinate, mandatory		coordinates center point
radius	str or astropy.units, mandatory	None	radius
table_name	str, optional, default main gaia table name doing the cone search against	None
ra_column_name	str, optional, default ra column in main gaia table	'ra'	ra column doing the cone search against
dec_column_name	str, optional, default dec column in main gaia table	'dec'	dec column doing the cone search against
background	bool, optional, default 'False'	False	when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available
output_file	str, optional, default None	None	file name where the results are saved if dump_to_file is True. If this parameter is not provided, the jobid is used instead
output_format	str, optional, default 'votable_gzip'	'votable_gzip'	results format. Available formats are: 'votable', 'votable_plain', 'fits', 'csv', 'ecsv' and 'json', default is 'votable'.
verbose	bool, optional, default 'False'	False	flag to display information about the process
dump_to_file	bool, optional, default 'False'	False	if True, the results are saved in a file instead of using memory
columns	list, optional, default ()	()	if empty, all columns will be selected

Returns

A Job object —

correct_table_units

Correct format in the units of the columns

Gaia.correct_table_units(table)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="correct_table_units",
    params={"table": "<table>"},
)

TAP & TAP+

Parameters

Parameter	Type	Default	Description
table (required)	Table, mandatory		change the format of the units in the columns of the input table: '.' by ' ' and "'" by ""

cross_match

Performs a positional cross-match between the specified tables.

Gaia.cross_match(*, full_qualified_table_name_a, full_qualified_table_name_b, results_table_name, radius=1.0, background=False, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="cross_match",
    params={"full_qualified_table_name_a": "<full_qualified_table_name_a>", "full_qualified_table_name_b": "<full_qualified_table_name_b>", "results_table_name": "<results_table_name>"},
)

The result is a join table (stored in the user storage area) with the identifies of both tables and the distance. TAP+ only

Parameters

Parameter	Type	Default	Description
full_qualified_table_name_a (required)	str, mandatory		a full qualified table name (i.e. schema name and table name)
full_qualified_table_name_b (required)	str, mandatory		a full qualified table name (i.e. schema name and table name)
results_table_name (required)	str, mandatory		a table name without schema. The schema is set to the user one
radius	float (arc. seconds), str or astropy.coordinate, optional, default 1.0	1.0	radius (valid range: 0.1-10.0). For an astropy.coordinate any angular unit is valid, but its value in arc sec must be contained within the valid range.
background	bool, optional, default 'False'	False	when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A Job object —

cross_match_basic

Performs a positional cross-match between the specified tables.

Gaia.cross_match_basic(*, table_a_full_qualified_name, table_a_column_ra, table_a_column_dec, table_b_full_qualified_name=None, table_b_column_ra='ra', table_b_column_dec='dec', results_name=None, radius=1.0, background=False, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="cross_match_basic",
    params={"table_a_full_qualified_name": "<table_a_full_qualified_name>", "table_a_column_ra": "<table_a_column_ra>", "table_a_column_dec": "<table_a_column_dec>"},
)

This method simples the execution of the method cross_match since it carries out the following steps in one step:

1. updates the user table metadata to flag the positional RA/Dec columns;
2. launches a positional cross-match as an asynchronous query;
3. returns all the columns from both tables plus the angular distance (deg) for the cross-matched sources.

The result is a join table with the identifies of both tables and the distance (degrees), that is returned without metadata units. If desired, units can be added using the Units package of Astropy as follows: results[‘separation’].unit = u.degree. To speed up the cross-match, pass the biggest table to the table_b_full_qualified_name parameter. TAP+ only

Parameters

Parameter	Type	Default	Description
table_a_full_qualified_name (required)	str, mandatory		a full qualified table name (i.e. schema name and table name)
table_a_column_ra (required)	str, mandatory		the ‘ra’ column in the table table_a_full_qualified_name
table_a_column_dec (required)	str, mandatory		the ‘dec’ column in the table table_a_full_qualified_name
table_b_full_qualified_name	str, optional, default MAIN_GAIA_TABLE	None	a full qualified table name (i.e. schema name and table name)
table_b_column_ra	str, optional, default MAIN_GAIA_TABLE_RA	'ra'	the ‘ra’ column in the table table_b_full_qualified_name
table_b_column_dec	str, default MAIN_GAIA_TABLE_DEC	'dec'	the ‘dec’ column in the table table_b_full_qualified_name
results_name	str, optional, default None	None	custom name defined by the user for the job that is going to be created
radius	float (arc. seconds), str or astropy.coordinate, optional, default 1.0	1.0	radius (valid range: 0.1-10.0). For an astropy.coordinate any angular unit is valid, but its value in arc sec must be contained within the valid range.
background	bool, optional, default 'False'	False	when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A Job object —

delete_user_table

Removes a user table

Gaia.delete_user_table(*, table_name=None, force_removal=False, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="delete_user_table",
    params={},
)

Parameters

Parameter	Type	Default	Description
table_name	str, required	None	table to be removed
force_removal	bool, optional, default 'False'	False	flag to indicate if removal should be forced
verbose	bool, optional, default 'False'	False	flag to display information about the process

get_args_4_rename_table

No description in upstream docstring.

Gaia.get_args_4_rename_table(table_name, new_table_name, new_column_names_dict={})

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="get_args_4_rename_table",
    params={"table_name": "<table_name>", "new_table_name": "<new_table_name>"},
)

Parameters

Parameter	Type	Default	Description
table_name (required)
new_table_name (required)
new_column_names_dict		{}

get_current_column_values_for_update

No description in upstream docstring.

Gaia.get_current_column_values_for_update(column)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="get_current_column_values_for_update",
    params={"column": "<column>"},
)

Parameters

Parameter	Type	Default	Description
column (required)

get_datalinks

Gets datalinks associated to the provided identifiers

Gaia.get_datalinks(ids, *, linking_parameter='SOURCE_ID', verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="get_datalinks",
    params={"ids": "<ids>"},
)

TAP+ only

Parameters

Parameter	Type	Default	Description
ids (required)	str, int, str list or int list, mandatory		list of identifiers
linking_parameter	str, optional, default SOURCE_ID, valid values: SOURCE_ID, TRANSIT_ID, IMAGE_ID	'SOURCE_ID'	By default, all the identifiers are considered as source_id SOURCE_ID: the identifiers are considered as source_id TRANSIT_ID: the identifiers are considered as transit_id IMAGE_ID: the identifiers are considered as sif_observation_id
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A table object —

Examples

Id formats.

-- Gaia.get_datalinks(iids=1104405489608579584) # single id as an int

-- Gaia.get_datalinks(ids='1104405489608579584, 1809140662896080256') # multiple ids as a str

-- Gaia.get_datalinks(ids=(1104405489608579584, 1809140662896080256)) # multiple ids as an int list

-- Gaia.get_datalinks(ids=('1104405489608579584','1809140662896080256')) # multiple ids as str list

-- Gaia.get_datalinks(ids='4295806720-38655544960') # range of ids as a str

-- Gaia.get_datalinks(ids='4295806720-38655544960, 549755818112-1275606125952') # multiple ranges of ids as
a str

-- Gaia.get_datalinks(ids=('4295806720-38655544960', '549755818112-1275606125952') # multiple ranges of ids
as a str list

-- Gaia.get_datalinks(ids='Gaia DR3 1104405489608579584') # single designator

-- Gaia.get_datalinks(ids='Gaia DR3 1104405489608579584, Gaia DR3 1809140662896080256') # multiple
designators as a str

-- Gaia.get_datalinks(ids=('Gaia DR3 1104405489608579584','Gaia DR3 1809140662896080256')) # multiple
designators as a str list

-- Gaia.get_datalinks(ids='Gaia DR3 4295806720-Gaia DR3 38655544960') # range of designators as a str

-- Gaia.get_datalinks(ids='Gaia DR3 4295806720-Gaia DR3 38655544960, Gaia DR3 549755818112-Gaia DR3
1275606125952') # multiple ranges of designators as a str

-- Gaia.get_datalinks(ids=('Gaia DR3 4295806720-Gaia DR3 38655544960', 'Gaia DR3 549755818112-Gaia DR3
1275606125952')) # multiple ranges of designators as a str list

-- Gaia.get_datalinks(ids='Gaia DR3 4295806720-Gaia DR3 38655544960, Gaia DR2 549755818112-Gaia DR2
1275606125952') # multiple ranges of designators with different releases as a str

-- Gaia.get_datalinks(ids=('Gaia DR3 4295806720-Gaia DR3 38655544960', 'Gaia DR2 549755818112-Gaia DR2
1275606125952')) # multiple ranges of designators with different releases as a str list

get_new_column_values_for_update

No description in upstream docstring.

Gaia.get_new_column_values_for_update(list_of_changes, column_name, c_flags, c_indexed, c_ucd, c_utype)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="get_new_column_values_for_update",
    params={"list_of_changes": "<list_of_changes>", "column_name": "<column_name>", "c_flags": "<c_flags>", "c_indexed": "<c_indexed>", "c_ucd": "<c_ucd>", "c_utype": "<c_utype>"},
)

Parameters

Parameter	Type	Default	Description
list_of_changes (required)
column_name (required)
c_flags (required)
c_indexed (required)
c_ucd (required)
c_utype (required)

get_status_messages

Retrieve the messages to inform users about

Gaia.get_status_messages()

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="get_status_messages",
    params={},
)

the status of Gaia TAP

Parameters

No parameters.

get_table_update_arguments

No description in upstream docstring.

Gaia.get_table_update_arguments(table_name, columns, list_of_changes)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="get_table_update_arguments",
    params={"table_name": "<table_name>", "columns": "<columns>", "list_of_changes": "<list_of_changes>"},
)

Parameters

Parameter	Type	Default	Description
table_name (required)
columns (required)
list_of_changes (required)

launch_job

Launches a synchronous job

Gaia.launch_job(query, *, name=None, output_file=None, output_format='votable_gzip', verbose=False, dump_to_file=False, upload_resource=None, upload_table_name=None)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="launch_job",
    params={"query": "<query>"},
)

Parameters

Parameter	Type	Default	Description
query (required)	str, mandatory		query to be executed
name	str, optional, default None	None	custom name defined by the user for the job that is going to be created
output_file	str, optional, default None	None	file name where the results are saved if dump_to_file is True. If this parameter is not provided, the jobid is used instead
output_format	str, optional, default 'votable_gzip'	'votable_gzip'	results format. Available formats are: 'votable_gzip', 'votable', 'votable_plain', 'fits', 'csv', 'ecsv' and 'json', default is 'votable_gzip'. Returned results for 'votable_gzip', 'ecsv' and 'fits' formats are compressed gzip files.
verbose	bool, optional, default 'False'	False	flag to display information about the process
dump_to_file	bool, optional, default 'False'	False	if True, the results are saved in a file instead of using memory
upload_resource	str, optional, default None	None	resource to be uploaded to UPLOAD_SCHEMA
upload_table_name	str, optional, default None	None	resource temporary table name associated to the uploaded resource. This argument is required if upload_resource is provided.

Returns

A Job object —

launch_job_async

Launches an asynchronous job

Gaia.launch_job_async(query, *, name=None, output_file=None, output_format='votable_gzip', verbose=False, dump_to_file=False, background=False, upload_resource=None, upload_table_name=None, autorun=True)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="launch_job_async",
    params={"query": "<query>"},
)

Parameters

Parameter	Type	Default	Description
query (required)	str, mandatory		query to be executed
name	str, optional, default None	None	custom name defined by the user for the job that is going to be created
output_file	str, optional, default None	None	file name where the results are saved if dump_to_file is True. If this parameter is not provided, the jobid is used instead
output_format	str, optional, default 'votable_gzip'	'votable_gzip'	results format. Available formats are: 'votable_gzip', 'votable', 'votable_plain', 'fits', 'csv' and 'json', default is 'votable_gzip'. Returned results for 'votable_gzip' 'ecsv' and 'fits' format are compressed gzip files.
verbose	bool, optional, default 'False'	False	flag to display information about the process
dump_to_file	bool, optional, default 'False'	False	if True, the results are saved in a file instead of using memory
background	bool, optional, default 'False'	False	when the job is executed in asynchronous mode, this flag specifies whether the execution will wait until results are available
upload_resource	str, optional, default None	None	resource to be uploaded to UPLOAD_SCHEMA
upload_table_name	str, optional, default None	None	resource temporary table name associated to the uploaded resource. This argument is required if upload_resource is provided.
autorun	boolean, optional, default True	True	if 'True', sets 'phase' parameter to 'RUN', so the framework can start the job.

Returns

A Job object —

list_async_jobs

Returns all the asynchronous jobs

Gaia.list_async_jobs(*, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="list_async_jobs",
    params={},
)

Parameters

Parameter	Type	Default	Description
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A list of Job objects —

load_async_job

Loads an asynchronous job

Gaia.load_async_job(*, jobid=None, name=None, verbose=False, load_results=True)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="load_async_job",
    params={},
)

Parameters

Parameter	Type	Default	Description
jobid	str, mandatory if no name is provided, default None	None	job identifier
name	str, mandatory if no jobid is provided, default None	None	job name
verbose	bool, optional, default 'False'	False	flag to display information about the process
load_results	bool, optional, default 'True'	True	load results associated to this job

Returns

A Job object —

load_data

Loads the specified table

Gaia.load_data(ids, *, data_release=None, data_structure='INDIVIDUAL', retrieval_type='ALL', linking_parameter='SOURCE_ID', valid_data=False, band=None, avoid_datatype_check=False, format='votable', dump_to_file=False, overwrite_output_file=False, verbose=False, output_file=None)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="load_data",
    params={"ids": "<ids>"},
)

TAP+ only

Parameters

Parameter	Type	Default	Description
ids (required)	str, int, str list or int list, mandatory		List of identifiers
data_release	str, optional, default None	None	Data release from which data should be taken. E.g. 'Gaia DR3'. By default, it takes the current default one.
data_structure	str, optional, default 'INDIVIDUAL'	'INDIVIDUAL'	It can be 'INDIVIDUAL' or 'RAW': 'INDIVIDUAL' means products are provided in separate files for each sourceId. All files are zipped in a single bundle, even if only one source/file is considered 'RAW' means products are provided following a Data Model similar to that used in the MDB, meaning in particular that parameters stored as arrays will remain as such. A single file is provided for the data of all sourceIds together, but in this case there will be always be one row per sourceId.
retrieval_type	str, optional, default ‘ALL’ to retrieve all data from the list of sources	'ALL'	Retrieval type identifier: For Gaia DR2, the only possible values is ['EPOCH_PHOTOMETRY'] For Gaia DR3, the possible values are ['EPOCH_PHOTOMETRY', 'RVS', 'XP_CONTINUOUS', 'XP_SAMPLED', 'MCMC_GSPPHOT', 'MCMC_MSC'] For Gaia DR4, the possible values will be ['EPOCH_PHOTOMETRY', 'MEAN_SPECTRUM_RVS', 'MCMC_GSP_PHOT', 'EPOCH_ASTROMETRY', 'EPOCH_SPECTRUM_RVS', 'EPOCH_ASTROMETRY_CROWDED_FIELD', 'EPOCH_PHOTOMETRY_CROWDED_FIELD', 'EPOCH_IMAGE', 'EPOCH_PHOTOMETRY_CCD', 'EPOCH_SPECTRUM_XP_SSO', 'EPOCH_SPECTRUM_XP_CROWDING', 'MEAN_SPECTRUM_XP', 'EPOCH_SPECTRUM_XP', 'CROWDED_FIELD_IMAGE', 'EPOCH_ASTROMETRY_BRIGHT', 'MEAN_SPECTRUM_XP_GRAVLENS', 'EPOCH_FLAGS_NSS', 'EPOCH_PARAMETERS_RVS_SINGLE', 'EPOCH_PARAMETERS_RVS_DOUBLE', 'EPOCH_FLAGS_VARI']. Note that for 'CROWDED_FIELD_IMAGE', only the format 'fits' can be used, and its image, in the principal header, will not be available in the returned dictionary. Set 'output_file' to retrieve all data: image + tables.
linking_parameter	str, optional, default SOURCE_ID, valid values: SOURCE_ID, TRANSIT_ID, IMAGE_ID	'SOURCE_ID'	By default, all the identifiers are considered as source_id SOURCE_ID: the identifiers are considered as source_id TRANSIT_ID: the identifiers are considered as transit_id IMAGE_ID: the identifiers are considered as sif_observation_id
valid_data	bool, optional, default False	False	By default, the epoch photometry service returns all available data, including data rows where flux is null and/or the rejected_by_photometry flag is set to True. In order to retrieve only valid data (data rows where flux is not null and/or the rejected_by_photometry flag is set to False) this request parameter should be included with valid_data=True.
band		None
avoid_datatype_check	boolean, optional, default False.	False	By default, this value will be set to False. If it is set to 'true' the Datalink items tags will not be checked.
format	str, optional, default 'votable'	'votable'	Loading format. Other available formats are 'csv', 'ecsv','votable_plain', 'json' and 'fits'
dump_to_file	boolean, optional, default False.	False	If it is true, a compressed directory named "datalink_output_<time_stamp>.zip" with all the DataLink files is made in the current working directory. The <time_stamp> format follows the ISO 8601 standard: "YYYYMMDD_HHMMSS.mmmmmm".
overwrite_output_file	boolean, optional, default False	False	To overwrite the output file ("datalink_output.zip") if it already exists.
verbose	bool, optional, default 'False'	False	Flag to display information about the process
output_file		None

Returns

A dictionary where the keys are the file names and its value is a list of astropy.table.table.Table objects —

load_group

Load group with title being group_name

Gaia.load_group(*, group_name=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="load_group",
    params={},
)

Parameters

Parameter	Type	Default	Description
group_name	str, required	None	group to be loaded
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A group with title being group_name —

load_groups

Loads groups

Gaia.load_groups(*, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="load_groups",
    params={},
)

Parameters

Parameter	Type	Default	Description
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A set of groups of a user —

load_shared_items

Loads shared items

Gaia.load_shared_items(*, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="load_shared_items",
    params={},
)

Parameters

Parameter	Type	Default	Description
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A set of shared items —

load_table

Loads the table metadata, for the specified table. If the user is logged in, the table can refer to a

Gaia.load_table(table, *, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="load_table",
    params={"table": "<table>"},
)

table in the user's private area.

Parameters

Parameter	Type	Default	Description
table (required)	str, mandatory		full qualified table name (i.e. schema name + table name)
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A TapTableMeta object —

load_tables

Loads all public tables

Gaia.load_tables(*, only_names=False, include_shared_tables=False, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="load_tables",
    params={},
)

Parameters

Parameter	Type	Default	Description
only_names	bool, TAP+ only, optional, default 'False'	False	True to load table names only
include_shared_tables	bool, TAP+, optional, default 'False'	False	True to include shared tables
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A list of table objects —

load_user

Loads the specified user

Gaia.load_user(user_id, *, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="load_user",
    params={"user_id": "<user_id>"},
)

TAP+ only

Parameters

Parameter	Type	Default	Description
user_id (required)	str, mandatory		user id to load
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A user —

login

Performs a login.

Gaia.login(*, user=None, password=None, credentials_file=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="login",
    params={},
)

User and password arguments can be used or a file that contains username and password (2 lines: one for username and the following one for the password). If no arguments are provided, a prompt asking for username and password will appear.

Parameters

Parameter	Type	Default	Description
user	str, default None	None	login name
password	str, default None	None	user password
credentials_file	str, default None	None	file containing user and password in two lines
verbose	bool, optional, default 'False'	False	flag to display information about the process

login_gui

Performs a login using a GUI dialog

Gaia.login_gui(*, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="login_gui",
    params={},
)

Parameters

Parameter	Type	Default	Description
verbose	bool, optional, default 'False'	False	flag to display information about the process

logout

Performs a logout

Gaia.logout(*, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="logout",
    params={},
)

Parameters

Parameter	Type	Default	Description
verbose	bool, optional, default 'False'	False	flag to display information about the process

query_object

Launches a synchronous cone search for the input search radius or the box on the sky, sorted by angular

Gaia.query_object(coordinate, *, radius=None, width=None, height=None, verbose=False, columns=())

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="query_object",
    params={"coordinate": "<coordinate>"},
)

separation TAP & TAP+

Parameters

Parameter	Type	Default	Description
coordinate (required)	str or astropy.coordinates, mandatory		coordinates center point
radius	str or astropy.units if no 'width'/'height' are provided	None	radius (deg)
width	str or astropy.units if no 'radius' is provided	None	box width
height	str or astropy.units if no 'radius' is provided	None	box height
verbose	bool, optional, default 'False'	False	flag to display information about the process
columns	list, optional, default ()	()	if empty, all columns will be selected

Returns

The job results (astropy.table). —

query_object_async

Launches an asynchronous cone search for the input search radius or the box on the sky, sorted by angular

Gaia.query_object_async(coordinate, *, radius=None, width=None, height=None, verbose=False, columns=())

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="query_object_async",
    params={"coordinate": "<coordinate>"},
)

separation TAP & TAP+

Parameters

Parameter	Type	Default	Description
coordinate (required)	str or astropy.coordinates, mandatory		coordinates center point
radius	str or astropy.units if no 'width'/'height' are provided	None	radius
width	str or astropy.units if no 'radius' is provided	None	box width
height	str or astropy.units if no 'radius' is provided	None	box height
verbose	bool, optional, default 'False'	False	flag to display information about the process
columns	list, optional, default ()	()	if empty, all columns will be selected

Returns

The job results (astropy.table). —

remove_jobs

Removes the specified jobs

Gaia.remove_jobs(jobs_list, *, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="remove_jobs",
    params={"jobs_list": "<jobs_list>"},
)

Parameters

Parameter	Type	Default	Description
jobs_list (required)	str, mandatory		jobs identifiers to be removed
verbose	bool, optional, default 'False'	False	flag to display information about the process

rename_table

This method allows you to update the column names of a user table.

Gaia.rename_table(*, table_name=None, new_table_name=None, new_column_names_dict=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="rename_table",
    params={},
)

Parameters

Parameter	Type	Default	Description
table_name	str, required	None	old name of the user's table
new_table_name	str, required	None	new name of the user's table
new_column_names_dict	dict str:str	None	dict with pairs "old_column1_name:new_column1_name"
verbose	bool, optional, default 'False'	False	flag to display information about the process

save_results

Saves job results

Gaia.save_results(job, *, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="save_results",
    params={"job": "<job>"},
)

Parameters

Parameter	Type	Default	Description
job (required)	Job, mandatory		job
verbose	bool, optional, default 'False'	False	flag to display information about the process

search_async_jobs

Searches for jobs applying the specified filter

Gaia.search_async_jobs(*, jobfilter=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="search_async_jobs",
    params={},
)

Parameters

Parameter	Type	Default	Description
jobfilter	JobFilter, optional, default None	None	job filter
verbose	bool, optional, default 'False'	False	flag to display information about the process

Returns

A list of Job objects —

share_group_add_user

Adds user to a group

Gaia.share_group_add_user(*, group_name=None, user_id=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="share_group_add_user",
    params={},
)

Parameters

Parameter	Type	Default	Description
group_name	str, required	None	group which user_id will be added in
user_id	str, required	None	user id to be added
verbose	bool, optional, default 'False'	False	flag to display information about the process

share_group_create

Creates a group

Gaia.share_group_create(*, group_name=None, description=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="share_group_create",
    params={},
)

Parameters

Parameter	Type	Default	Description
group_name	str, required	None	group to be created
description	str, required	None	description of the group
verbose	bool, optional, default 'False'	False	flag to display information about the process

share_group_delete

Deletes a group

Gaia.share_group_delete(*, group_name=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="share_group_delete",
    params={},
)

Parameters

Parameter	Type	Default	Description
group_name	str, required	None	group to be created
verbose	bool, optional, default 'False'	False	flag to display information about the process

share_group_delete_user

Deletes user from a group

Gaia.share_group_delete_user(*, group_name=None, user_id=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="share_group_delete_user",
    params={},
)

Parameters

Parameter	Type	Default	Description
group_name	str, required	None	group which user_id will be removed from
user_id	str, required	None	user id to be deleted
verbose	bool, optional, default 'False'	False	flag to display information about the process

share_table

Shares a table with a group

Gaia.share_table(*, group_name=None, table_name=None, description=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="share_table",
    params={},
)

Parameters

Parameter	Type	Default	Description
group_name	str, required	None	group in which table will be shared
table_name	str, required	None	table to be shared
description	str, required	None	description of the sharing
verbose	bool, optional, default 'False'	False	flag to display information about the process

share_table_stop

Stop sharing a table

Gaia.share_table_stop(*, group_name=None, table_name=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="share_table_stop",
    params={},
)

Parameters

Parameter	Type	Default	Description
group_name	str, required	None	group where the table is shared to
table_name	str, required	None	table to be stopped from being shared
verbose	bool, optional, default 'False'	False	flag to display information about the process

upload_table

Uploads a table to the user private space

Gaia.upload_table(*, upload_resource=None, table_name=None, table_description=None, format=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="upload_table",
    params={},
)

Parameters

Parameter	Type	Default	Description
upload_resource	object, mandatory	None	table to be uploaded: pyTable, file or URL.
table_name	str, required if uploadResource is provided, default None	None	resource temporary table name associated to the uploaded resource
table_description	str, optional, default None	None	table description
format	str, optional, default 'votable'	None	resource format. Only formats described in https://docs.astropy.org/en/stable/io/unified.html#built-in-table-readers-writers are accepted.
verbose	bool, optional, default 'False'	False	flag to display information about the process

upload_table_from_job

Creates a table to the user private space from a job

Gaia.upload_table_from_job(*, job=None, table_name=None, table_description=None, verbose=False)

Call via MCP

astroquery_execute(
    module_name="gaia",
    function_name="upload_table_from_job",
    params={},
)

Parameters

Parameter	Type	Default	Description
job	job, mandatory	None	job used to create a table. Could be a string with the jobid or a job itself
table_name	str, default 't'+jobid	None	resource temporary table name associated to the uploaded resource
table_description	str, optional, default None	None	table description
verbose	bool, optional, default 'False'	False	flag to display information about the process