Versions Compared

Old Version 1

changes.mady.by.user Richard A. Shaw

Saved on

compared with

New Version Current

changes.mady.by.user Brian McLean

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DraftMASTDATA and version 1.2

The catalog web service allows you to submit a query, both through an online form and programmatically. You can access the Guide Star Catalog(s) as well as a number of other catalogs available from MAST.

Excerpt
hiddentrue

Summary of access methods

Panel
borderColor#00617E
borderWidth2px
borderStylesolid
On this page...

Table of Contents
maxLevel2
indent24px

Web-forms

These web forms were built on a publicly accessible API, which you can use to perform your own queries.

API

The API endpoint is:  https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?Parameters

To perform a query, you'll need to fill in the Parameters with your desired search criteria.


Warning
titleQuotation Marks

Do not place quotes around any of the parameter values, or your query will fail. Additionally, the parameters are both case-insensitive and order-insensitive.

Note
titleRequired Parameters for each search type

At a minimum, you must create a query in the style of one of the four following:

Search Type

Required Parameters

Example (using optional parameter defaults :  CATALOG=GSC242, FORMAT=VOTABLE)
VO Cone SearchRA=ra(deg) &DEC=dec(deg) &SR=search radius(deg)
Code Block
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=83.633083&DEC=-22.0145&SR=0.01
Box SearchBBOX=raMin(deg), decMin(deg), raMax(deg), decMax(deg)
Code Block
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?bbox=10, 20, 10.5, 21
STCS Search

STCS=Space Time Coordinate System shape (CIRCLE or POLYGON)

Note that a STCS=CIRCLE is the same as a VO ConeSearch

Code Block
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?STCS=CIRCLE 83.633083 -22.0145 0.01
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?STCS=POLYGON 180.428742 -18.893042 180.455582 -18.906816 180.488081 -18.858382 180.461245 -18.84461 180.428742 -18.893042
ID SearchID=catID
Code Block
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?id=NBQI004317

You do not need to include these parameters in your search, but you can use them you further filter your results. Some options, like filename and format, alter the results returned to you.

Optional Parameters

Examples

CATALOG=code (Default if omitted is GSC242GSC30)

For clarity this is a recommended parameter. It WILL change as newer versions of GSC are released

Code Block
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?catalog=GSC11&bbox=10,20,10.5,21&format=csv
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?catalog=PS1dr1&ID=134410836341049171&format=HTML

EPOCH=yyyy.y (Updates ra/dec using proper motion and parallax IF AVAILABLE in catalog)


Code Block
original query: 
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=83.633083&DEC=-22.0145&SR=0.01&cat=GAIAdr3&format=html

query with updated coordinates:
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=83.633083&DEC=-22.0145&SR=0.01&cat=GAIAdr3&format=html&epoch=2030

FORMAT= VOTABLE(default) | HTML | KML | CSV | TSV | JSON | TEXT

Note: TEXT is only supported for GSC1, GSC2 and HLA catalogs for backwards compatibility with other services and is NOT recommended

Code Block
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?ra=10&dec=20&sr=0.05&format=html

FILENAME=outputname (directs output to file)

Code Block
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?ra=10&dec=20&sr=0.01&format=csv&filename=conesearch-result.csv

MAXOBJ=n (limits number of entries returned by brightest magnitude)


Code Block
original query:
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=83.633083&DEC=-22.0145&SR=0.02&format=html 
 
query limited to 10 objects: 
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=83.633083&DEC=-22.0145&SR=0.02&format=html&maxobj=10

MAGRANGE=bright,faint (limits number of entries returned by limits)

Code Block
original query: 
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=83.633083&DEC=-22.0145&SR=0.02&format=html 

query limited to specified magnitude range:
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=83.633083&DEC=-22.0145&SR=0.02&format=html&magrange=15.4,17.2

MINDET=n (minimum number of detections PanSTARRS only)

Code Block
https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=243.8675309&DEC=42.05&SR=.01&FORMAT=html&CAT=PS1dr1&MINDET=25&MAXOBJ=5