Skip to content

Archive VizieR

github-actions[bot] edited this page Sep 28, 2026 · 1 revision

CDS service giving access to published astronomical catalogs and data tables.

  • Module name: vizier
  • Python class: astroquery.vizier.Vizier
  • Functions: 12

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.
find_catalogs Search Vizier for catalogs based on a set of keywords, e.g. author name
get_catalog_metadata Get a VizieR's catalog metadata.
get_catalogs Queries the service and returns a table object.
get_catalogs_async Query the Vizier service for a specific catalog
query_constraints Queries the service and returns a table object.
query_constraints_async Send a query to Vizier in which you specify constraints with
query_object Queries the service and returns a table object.
query_object_async Serves the same purpose as query_object but only
query_region Queries the service and returns a table object.
query_region_async Serves the same purpose as query_region but only
reset_cache_location Resets the cache location to the default astropy cache

Functions

clear_cache

Removes all cache files.

Vizier.clear_cache()

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="clear_cache",
    params={},
)

Parameters

No parameters.

find_catalogs

Search Vizier for catalogs based on a set of keywords, e.g. author name

Vizier.find_catalogs(keywords, *, include_obsolete=False, verbose=False, max_catalogs=None, return_type='votable')

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="find_catalogs",
    params={"keywords": "<keywords>"},
)

Parameters

Parameter Type Default Description
keywords (required) list or string List of keywords, or space-separated set of keywords. From Vizier: "names or words of title of catalog. The words are and'ed, i.e. only the catalogues characterized by all the words are selected."
include_obsolete bool False If set to True, catalogs marked obsolete will also be returned.
verbose False
max_catalogs int or None None The maximum number of catalogs to return. If None, all catalogs will be returned.
return_type 'votable'

Returns

dict — Dictionary of the "Resource" name and the VOTable resource object. "Resources" are generally publications; one publication may contain many tables.

Examples

>>> from astroquery.vizier import Vizier
>>> catalog_list = Vizier.find_catalogs('Mars')
>>> for k, v in catalog_list.items():
...     print(k, ":", v.description)
J/A+A/572/A104 : Astrometric obs. of Phobos and Deimos in 1971 (Robert+, 2014)
J/A+A/488/361 : Mars Express astrometric observations of Phobos (Willner+, 2008)
J/A+A/603/A55 : WISE/NEOWISE Mars-crossing asteroids (Ali-Lagoa+, 2017)
J/A+A/545/A144 : Astrometric observations of Deimos (Pasewaldt+, 2012)
...

get_catalog_metadata

Get a VizieR's catalog metadata.

Vizier.get_catalog_metadata(*, catalog=None, get_query_payload=False)

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="get_catalog_metadata",
    params={},
)

Parameters

Parameter Type Default Description
catalog str None The catalog identifier. It usually looks like 'III/55' for big surveys or 'J/ApJ/811/67' for catalogs linked to a published paper. When this parameter is not provided, the function looks for the metadata of the catalog property of the Vizier class instance (catalog).
get_query_payload bool False When True, returns the dict of HTTP request parameters. This does not execute the search for metadata.

Returns

Table — A table with the following columns:

  • title
  • authors
  • abstract (the abstract of the article, modified to explain the data more specifically)
  • origin_article (the bibcode of the associated article)
  • webpage (a link to VizieR, contains more information about the catalog)
  • created (date of creation of the catalog in VizieR)
  • updated (date of the last modification applied to the entry, this is often metadata, with no appearance in the history tap on the webpage but sometimes also data erratum, which will appear in the history tab)
  • waveband
  • doi (the catalog doi when it exists)

Examples

>>> from astroquery.vizier import Vizier
>>> Vizier(catalog="I/324").get_catalog_metadata()
<Table length=1>
               title                        authors         ... waveband  doi
               object                        object         ...  object  object
----------------------------------- ----------------------- ... -------- ------
The Initial Gaia Source List (IGSL) Smart R.L.; Nicastro L. ...              --

>>> from astroquery.vizier import Vizier
>>> Vizier.get_catalog_metadata(catalog="J/ApJS/173/185")
<Table length=1>
                  title                    ...              doi
                  object                   ...              object
------------------------------------------ ... --------------------------------
GALEX ultraviolet atlas of nearby galaxies ... doi:10.26093/cds/vizier.21730185

get_catalogs

Queries the service and returns a table object.

Vizier.get_catalogs(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="get_catalogs",
    params={},
)

Query the Vizier service for a specific catalog

Parameters

Parameter Type Default Description
*args
**kwargs

Returns

A Table object. —

get_catalogs_async

Query the Vizier service for a specific catalog

Vizier.get_catalogs_async(catalog, *, verbose=False, return_type='votable', get_query_payload=False)

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="get_catalogs_async",
    params={"catalog": "<catalog>"},
)

Parameters

Parameter Type Default Description
catalog (required) str, Resource, or list The catalog(s) that will be retrieved
verbose False
return_type 'votable'
get_query_payload False

Returns

Response — Returned if asynchronous method used

query_constraints

Queries the service and returns a table object.

Vizier.query_constraints(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="query_constraints",
    params={},
)

Send a query to Vizier in which you specify constraints with keyword/value pairs.

See the vizier constraints page for details.

Parameters

Parameter Type Default Description
*args
**kwargs dict Any key/value pairs besides "catalog" will be parsed as additional column filters.

Returns

A Table object. —

Examples

>>> from astroquery.vizier import Vizier
>>> # note that glon/glat constraints here *must* be floats
>>> result = Vizier(row_limit=3).query_constraints(catalog='J/ApJ/723/492/table1',
...                                   GLON='>49.0 & <51.0', GLAT='<0.0')
>>> result[result.keys()[0]].pprint()
    GRSMC      GLON   GLAT   VLSR   DelV  ... alpha  Note RD09 _RA.icrs _DE.icrs
               deg    deg   km / s km / s ...                    deg      deg
------------- ------ ------ ------ ------ ... ------ ---- ---- -------- --------
G049.49-00.41  49.49  -0.41  56.90   9.12 ...   0.73    i RD09 290.9536  14.4992
G049.39-00.26  49.39  -0.26  50.94   3.51 ...   0.16    i RD09 290.7682  14.4819
G049.44-00.06  49.44  -0.06  62.00   3.67 ...   0.17    i RD09 290.6104  14.6203

query_constraints_async

Send a query to Vizier in which you specify constraints with

Vizier.query_constraints_async(*, catalog=None, return_type='votable', cache=True, get_query_payload=False, **kwargs)

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="query_constraints_async",
    params={},
)

keyword/value pairs.

See the vizier constraints page for details.

Parameters

Parameter Type Default Description
catalog str or list None The catalog(s) which must be searched for this identifier. If not specified, all matching catalogs will be searched.
return_type 'votable'
cache bool True Defaults to True. If set overrides global caching behavior. See astroquery_cache.
get_query_payload False
**kwargs dict Any key/value pairs besides "catalog" will be parsed as additional column filters.

Returns

requests.Response — The response of the HTTP request.

Examples

>>> from astroquery.vizier import Vizier
>>> # note that glon/glat constraints here *must* be floats
>>> result = Vizier(row_limit=3).query_constraints(catalog='J/ApJ/723/492/table1',
...                                   GLON='>49.0 & <51.0', GLAT='<0.0')
>>> result[result.keys()[0]].pprint()
    GRSMC      GLON   GLAT   VLSR   DelV  ... alpha  Note RD09 _RA.icrs _DE.icrs
               deg    deg   km / s km / s ...                    deg      deg
------------- ------ ------ ------ ------ ... ------ ---- ---- -------- --------
G049.49-00.41  49.49  -0.41  56.90   9.12 ...   0.73    i RD09 290.9536  14.4992
G049.39-00.26  49.39  -0.26  50.94   3.51 ...   0.16    i RD09 290.7682  14.4819
G049.44-00.06  49.44  -0.06  62.00   3.67 ...   0.17    i RD09 290.6104  14.6203

query_object

Queries the service and returns a table object.

Vizier.query_object(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="query_object",
    params={},
)

Serves the same purpose as query_object but only returns the HTTP response rather than the parsed result.

Parameters

Parameter Type Default Description
*args
**kwargs

Returns

A Table object. —

query_object_async

Serves the same purpose as query_object but only

Vizier.query_object_async(object_name, *, catalog=None, radius=None, coordinate_frame=None, get_query_payload=False, return_type='votable', cache=True)

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="query_object_async",
    params={"object_name": "<object_name>"},
)

returns the HTTP response rather than the parsed result.

Parameters

Parameter Type Default Description
object_name (required) str The name of the identifier.
catalog str or list None The catalog(s) which must be searched for this identifier. If not specified, all matching catalogs will be searched.
radius Quantity or None None A degree-equivalent radius (optional).
coordinate_frame None
get_query_payload False
return_type 'votable'
cache bool True Defaults to True. If set overrides global caching behavior. See astroquery_cache.

Returns

Response — The response of the HTTP request.

query_region

Queries the service and returns a table object.

Vizier.query_region(*args, **kwargs)

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="query_region",
    params={},
)

Serves the same purpose as query_region but only returns the HTTP response rather than the parsed result.

At least one of radius or width must be specified.

Parameters

Parameter Type Default Description
*args
**kwargs

Returns

A Table object. —

query_region_async

Serves the same purpose as query_region but only

Vizier.query_region_async(coordinates, *, radius=None, inner_radius=None, width=None, height=None, catalog=None, get_query_payload=False, cache=True, return_type='votable', column_filters={}, frame='fk5')

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="query_region_async",
    params={"coordinates": "<coordinates>"},
)

returns the HTTP response rather than the parsed result.

At least one of radius or width must be specified.

Parameters

Parameter Type Default Description
coordinates (required) str, astropy.coordinates object, or Table The target around which to search. It may be specified as a string in which case it is resolved using online services or as the appropriate astropy.coordinates object. ICRS coordinates may also be entered as a string. If a table is used, each of its rows will be queried, as long as it contains two columns named _RAJ2000 and _DEJ2000 with proper angular units.
radius convertible to Angle None The radius of the circular region to query.
inner_radius convertible to Angle None When set in addition to radius, the queried region becomes annular, with outer radius radius and inner radius inner_radius.
width convertible to Angle None The width of the square region to query.
height convertible to Angle None When set in addition to width, the queried region becomes rectangular, with the specified width and height.
catalog str or list None The catalog(s) which must be searched for this identifier. If not specified, all matching catalogs will be searched.
get_query_payload False
cache bool True Defaults to True. If set overrides global caching behavior. See astroquery_cache.
return_type 'votable'
column_filters dict {} Constraints on columns of the result. The dictionary contains the column name as keys, and the constraints as values.
frame str 'fk5' The frame to use for the request. It should be 'fk5', 'icrs', or 'galactic'. This choice influences the the orientation of box requests.

Returns

requests.Response — The response of the HTTP request.

reset_cache_location

Resets the cache location to the default astropy cache

Vizier.reset_cache_location()

Call via MCP

astroquery_execute(
    module_name="vizier",
    function_name="reset_cache_location",
    params={},
)

Parameters

No parameters.

Clone this wiki locally