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.
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.
Quotation 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.
Required 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 Search | RA=ra(deg) &DEC=dec(deg) &SR=search radius(deg) | https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=83.633083&DEC=-22.0145&SR=0.01 |
| Box Search | BBOX=raMin(deg), decMin(deg), raMax(deg), decMax(deg) | 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 | 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 Search | ID=catID | 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 GSC30) For clarity this is a recommended parameter. It WILL change as newer versions of GSC are released | 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) | 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 | https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?ra=10&dec=20&sr=0.05&format=html |
FILENAME=outputname (directs output to file) | 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) | 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) | 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) | https://gsss.stsci.edu/webservices/vo/CatalogSearch.aspx?RA=243.8675309&DEC=42.05&SR=.01&FORMAT=html&CAT=PS1dr1&MINDET=25&MAXOBJ=5 |