Returns data for each star in the Hypatia database as well as its planets.
Multiple stars can be submitted at once.
Warning: input-field name changed in version 2.2.0:
The Hypatia Catalog has
a new star name-engine that is based on names available on
SIMBAD.
As a result,
the inputs had been simplified
to accept any combination of string names for a space-removed
and case-insensitive search; feel free to use any SIMBAD name to check availability in the Hypatia Catalog.
Since the Hypatia Catalog database does not check names that are available on SIMBAD in real-time,
star names are expired and rechecked from SIMBAD periodically.
Names will also be updated stochastically as new abundance data is made available.
- Inputs
-
name
A star name that is recognized by
SIMBAD
database. This does a case-insensitive search of all stars available in the Hypatia Catalog
using all known names from SIMBAD, NASA Exoplanet Archive (NEA),
and various other aliases found in the primary literature
for Hypatia Catalog's elemental abundances and stellar parameters.
- Outputs
-
status Returns "found" if the star is found and "not-found" if the star is not found.
name The preferred name for the star, in the order of these available: HIP, HD, 2MASS, Gaia DR2, WDS, other names.
Name fields: hip,hd,bd,dist,2mass,gaia_dr2,tyc,other_names
Stellar Properties fields: spec,vmag,bv,ra,dec,x,y,z,disk,u,v,w,teff,logg,2MASS,ra_proper_motion,dec_proper_motion,bmag
planets Returns null or an list objects, one for each planet hosted by the star. For each planet we get these variables:
name,p,p_min_err,p_max_err,m_p,m_p_min_err,m_p_max_err,e,e_min_err,e_max_err,a,a_min_err,a_max_err.
Changed in v2, see notes.
requested_name
This is the name used in the query; any URL safe characters have been converted to human-readable characters.
Any star name on SIMBAD can be used.
Spaces and letter case are ignored star names searches.
However, if you want to use spaces, substitute '%20' for the space, which is the
URL safe-version of the plus operator '+' to append the two components in the URL path.
For example, 'HIP 12345' should be 'HIP%2012345'.
Join multiple stars with '&' like so: 'HIP%2012345&2MASS%20J19154511-1623157&HIP%20113044'.
GET https://hypatiacatalog.com/hypatia/api/v2/star/?HIP12345&2MASSJ19154511-1623157&HIP113044
or with spaces, the same as above:
GET https://hypatiacatalog.com/hypatia/api/v2/star/?HIP%2012345&2MASSJ19154511-1623157&HIP%20113044
If the SIMBAD star name you want to use in not parseable into a URL safe string,
see the example below for how to use the 'name' parameter.
Python code:
import requests
params = {"name": ["HIP 12345","2MASS J19154511-1623157","HIP 113044"]}
entry = requests.get("https://hypatiacatalog.com/hypatia/api/v2/star", params=params)
print(entry.json())
For the stars names in this example:
HIP 12345 is not in Hypatia and will not be found
2MASS J19154511-1623157 will be found and has no planets, so far...
HIP 113044 will found and has one planet, so far...
Result:
[
{
"status": "not-found",
"hip": null,
"hd": null,
"bd": null,
"spec": null,
"vmag": null,
"bv": null,
"dist": null,
"ra": null,
"dec": null,
"x": null,
"y": null,
"z": null,
"disk": null,
"u": null,
"v": null,
"w": null,
"teff": null,
"logg": null,
"2MASS": null,
"ra_proper_motion": null,
"dec_proper_motion": null,
"bmag": null,
"planets": null,
"requested_name": "HIP 12345"
},
{
"status": "found",
"hip": null,
"hd": null,
"bd": null,
"spec": null,
"vmag": null,
"bv": null,
"dist": 303.76,
"ra": 288.937982083333,
"dec": -16.3877119444444,
"x": 94.579,
"y": -275.645,
"z": -85.702,
"disk": "N/A",
"u": null,
"v": null,
"w": null,
"teff": 5835.15,
"logg": 4.25,
"2MASS": null,
"ra_proper_motion": -1.275,
"dec_proper_motion": -26.6299,
"bmag": null,
"planets": null,
"requested_name": "2MASS J19154511-1623157",
"name": "TYC 6296-654-1",
"2mass": "2MASS J19154511-1623157",
"tyc": "TYC 6296-654-1",
"other_names": [
"2MASS J19154511-1623157",
"EPIC 219581534",
"GALAH 170828002201178",
"Gaia DR1 4087860502658323712",
"Gaia DR2 4087860506965490560",
"Gaia DR3 4087860506965490560",
"TIC 130278180",
"TYC 6296-654-1",
"[CWW2013] 71"
]
},
{
"status": "found",
"hip": "HIP 113044",
"hd": "HD 216435",
"bd": null,
"spec": "G0V",
"vmag": 6.04,
"bv": 0.621,
"dist": 33.032,
"ra": 343.40805125,
"dec": -48.5982841666667,
"x": 20.936,
"y": -6.238,
"z": -24.777,
"disk": "thin",
"u": -27,
"v": -21.3,
"w": -10.2,
"teff": 6047,
"logg": 4.16,
"2MASS": null,
"ra_proper_motion": 217.9429,
"dec_proper_motion": -81.0128,
"bmag": 6.66,
"planets": [
{
"name": "b",
"m_p": 1.26,
"m_p_min_err": -0.13,
"m_p_max_err": 0.13,
"p": 1311,
"p_min_err": -49,
"p_max_err": 49,
"e": 0.07,
"e_min_err": -0.078,
"e_max_err": 0.078,
"a": 2.56,
"a_min_err": -0.17,
"a_max_err": 0.17
}
],
"requested_name": "HIP 113044",
"name": "* tau01 Gru",
"2mass": "2MASS J22533792-4835539",
"tyc": "TYC 8450-1093-1",
"other_names": [
"* tau01 Gru",
"2MASS J22533792-4835539",
"AKARI-IRC-V1 J2253381-483554",
"CD-49 13988",
"CPC 0 20170",
"CPD-49 11672",
"GC 31913",
"GCRV 73592",
"GEN# +1.00216435",
"GJ 9802",
"Gaia DR2 6515731817739456256",
"Gaia DR3 6515731817739456256",
"HD 216435",
"HIC 113044",
"HIP 113044",
"HR 8700",
"IRAS 22507-4851",
"LTT 9249",
"N30 5037",
"NLTT 55141",
"PLX 5543",
"PLX 5543.00",
"PPM 328720",
"SAO 231343",
"SKY# 43488",
"SPOCS 987",
"TD1 29424",
"TIC 161314759",
"TYC 8450-1093-1",
"UBV 19602",
"UBV M 26682",
"uvby98 100216435"
]
}
]
Returns a list of compositions for a given element, star, and solar normalization,
and computes the median and mean value for that group.
More than one group can be supplied by submitting each group one after the other:
element, star, solar normalization, element, star, solar normalization, etc.
- Inputs
-
element
Name of the element, case-insensitive.
We encourage you to omit the trailing H used in dex notation,
although the element-name parser attempts
to remove this after parsing ionization states.
name Searches all names for a star (e.g. name=HIP 57).
Search is case-insensitive. Any SIMBAD star name can be used, not just the preferred name returned by Hypatia.
solarnorm
(Omit this input to use the Lodders et al. 2009 solar-normalization) Identifier for the solar normalization.
See GET solarnorm for solar normalization identifiers.
Note: There should be the same number of elements, stars, and (if included) solar normalizations.
If solar normalizations are omitted, Lodders et al. 2009 is assumed for all compositions.
- Outputs
-
mean
The mean value of all abundances for this star, element, and solar normalization.
max
The maximum value of all abundances for this star, element, and solar normalization.
min
The minimum value of all abundances for this star, element, and solar normalization.
plusminus
When two or more abundance values are present,
this is half of the absolute range of all values for this star, element, and solar normalization.
Otherwise, this is a representative error for the element.
std
When three or more abundance values are present,
this is the standard deviation of all abundances for this star, element, and solar normalization.
Otherwise, this is null.
name
The preferred name for the star in the Hypatia Catalog
median_value
The median value of all abundances for this star, element, and solar normalization.
This is always a single float value and is an average of the two middle
values if there is an even number of values.
all_names
All names for the star that are known in the Hypatia Catalog.
nea_name
The Hypatia Catalog cross-matches with the
NEA;
if this star is a known host of exoplanets, this is the name used in the NEA.
Otherwise, this is the string "unknown".
solarnorm
The preferred solar normalization name used by that Hypatia Catalog to return this data.
element
The preferred element name used by the Hypatia Catalog to return this data.
all_values
A list of objects with values referencing specific abundance catalog literature.
median A list of objects with the median values referencing specific abundance catalog literature.
One object for an odd number of values and two objects for an even number of values.
match_name
The name used in the Hypatia Catalog to match the star name in the query, lowercase with no spaces.
requested_name
The name used in the query; any URL safe charters have been converted to human-readable characters.
requested_element
The element used in the query.
Any star name on SIMBAD can be used.
Spaces and letter case are ignored star names searches.
However, if you want to use spaces, substitute '%20' for the space, which is the
URL safe-version of the plus operator '+' to append the two components in the URL path.
For example, 'HIP 32970' should be 'HIP%2032970'.
GET https://hypatiacatalog.com/hypatia/api/v2/composition?name=HIP32970&element=ca&solarnorm=asplund09
Python code:
import requests
params = {"name": ["HIP 32970"], "element": ["ca"], "solarnorm": ["asp05"]}
entry = requests.get("https://hypatiacatalog.com/hypatia/api/v2/composition", params=params)
print(entry.json())
Result:
[
{
"mean": 0.294,
"max": 0.33,
"min": 0.257,
"plusminus": 0.04,
"std": 0.0261,
"name": "HD 50499",
"median_value": 0.295,
"all_names": [
"2MASS J06520202-3354559",
"CD-33 3304",
"CPC 17 3013",
"CPD-33 1302",
"GC 9010",
"GEN# +1.00050499",
"GSC 07096-00565",
"Gaia DR1 5579783569778334464",
"Gaia DR2 5579783574073770112",
"Gaia DR3 5579783574073770112",
"HD 50499",
"HD 050499",
"HIC 32970",
"HIP 32970",
"PPM 283214",
"SAO 197294",
"SKY# 12155",
"SPOCS 325",
"TIC 53175558",
"TYC 7096-565-1",
"uvby98 100050499"
],
"nea_name": "HD 50499",
"solarnorm": "asplund09",
"element": "Ca",
"all_values": [
{
"value": 0.29,
"catalog": {
"author": "Brewer et al. (2016)",
"year": 2016,
"id": "brewer16_01_of_02_unique_20_04_2023",
"original_norm_id": "grevesse07"
}
},
{
"value": 0.257,
"catalog": {
"author": "Gonzalez et al. (2010b)",
"year": 2010,
"id": "gonzalez10b_01_of_02_unique_20_06_2020",
"original_norm_id": "asplund09"
}
},
{
"value": 0.3,
"catalog": {
"author": "Maldonado et al. (2015)",
"year": 2015,
"id": "maldonado15",
"original_norm_id": "maldonado15"
}
},
{
"value": 0.33,
"catalog": {
"author": "Maldonado et al. (2018)",
"year": 2018,
"id": "maldonado18",
"original_norm_id": "maldonado15"
}
}
],
"median": [
{
"value": 0.29,
"catalog": {
"author": "Brewer et al. (2016)",
"year": 2016,
"id": "brewer16_01_of_02_unique_20_04_2023",
"original_norm_id": "grevesse07"
}
},
{
"value": 0.3,
"catalog": {
"author": "Maldonado et al. (2015)",
"year": 2015,
"id": "maldonado15",
"original_norm_id": "maldonado15"
}
}
],
"match_name": "hip32970",
"requested_name": "HIP32970",
"requested_element": "ca",
"requested_solarnorm": "asplund09"
}
]
Note: If you are using the Python requests package, multiple sets of elements, stars and solar normalizations are defined using arrays like this:
params = {"name": [HIP 32970, HIP 32970], "element": ["fe","ca"], "solarnorm": ["asp05","asp05"]}
You may omit the solar normalization, in which case Lodders et al. 2009 is assumed:
params = {"name": [HIP 32970, HIP 32970],, "element": ["fe","ca"]}