This document describes how to access the metadata DBs in KASI Science Data Archive via HTTP APIs.
♦ Search by coordinates (RA & DEC)
- HTTP GET request (URL: https://data.kasi.re.kr/api/data_collection/search?key1=value1&key2=value2&...)
- Applicable data collections (case sensitive) : KMTNet, MIRIS,
KVN(not ready yet) - Request parameters : RA, DEC, rad, unit, limit
- Response type : JSON
- Examples :
| Key | Value | Option | Default | Description |
|---|---|---|---|---|
| ra | Double | Right Ascension (J2000) of input coordinates in degrees | ||
| dec | Double | Declination (J2000) of input coordinates in degrees | ||
| rad | Double | 30 | Search radius around the given input coordinates. Result table will be presented by default with increasing distances from the input coordinate. | |
| unit | String | degree arcmin arcsec | arcmin | Unit of search radius |
| limit | Integer | 100 | Limit in number of rows returned |
...
♦ List metadata by dataID
- HTTP GET request (URL: https https://data.kasi.re.kr/api/data_collection/publication?doi=doiname/list/dataID(s))
- Applicable data collections (case sensitive) : KMTNet, KVN, MIRIS (case sensitive, MIRIS,
KVN(not ready yet) - Request parameters : dataID(s)
- Multiple dataIDs can be requested with pipe-delimited("|") string array
- Response type : JSON
- Examples :
| Key | Value | Option | Description |
|---|---|---|---|
| dataID | String (pipe-delimited) | Data identifier |
♦ Search by publications (DOI)
- HTTP GET request (URL: https://data.kasi.re.kr/api/publication/searchdoi?key1=value1&key2=value2&...DOI=DOI_name)
- Request parameters : DOI, facility, dataID
- Response type : JSON (DOI, facility, dataID)
- Examples :
- https://data.kasi.re.kr/api/MIRISpublication/publicationdoi?doiDOI=10.1000/xyz123
External API : https://api.altmetric.com/docs/call_doi.html
| Key | Value | Option | Default | Description |
|---|---|---|---|---|
| DOI | String | DOI (Digital Object Identifier) name (i.e., prefix+'/'+suffix, see DOI syntax). Partial string can be matched by regular expression method. |
♦ Retrieve publication information
- HTTP GET request (URL: https://apidata.kasi.altmetricre.comkr/v1api/doi/DOI)publication/search?key1=value1&key2=value2&...)
- Request parameters : facility, dataID
- Response type : JSON (DOI, facility, dataID)
- Examples :
fetch "title", "journal", "authors", "url" - External API : https://github.com/adsabs/adsabs-dev-api/blob/master/Search_API.ipynb
- base URL : https://api.adsabs.harvard.edu/v1/search/query?
- queries should include API access token (e.g., curl -H 'Authorization: Bearer <token>' 'https://api.adsabs.harvard.edu/v1/search/query?q=star')
- query parameters : q=doi:DOI_URL-encoded&fl=title,author,bibcode,citation_count,abstract
Additional link to the article information (ADS) : http://adsabs.harvard.edu/doi/DOI- Link to the article information (ADS) : https://ui.adsabs.harvard.edu/abs/bibcode
| Key | Value | Option | Default |
|---|
| Description |
|---|
DOI (Digital Object Identifier) name (i.e., prefix+'/'+suffix, see DOI syntax).
Partial string can be matched by regular expression method.
| facility | String | KMTNet KVN MIRIS | all | Select one of the data collections |
| dataID | String |
Data identifier used in the publication |
Link your publication to our data
♦ Register your publication
...
- HTTP POST request (URL: https://data.kasi.re.kr/api/register/request)
- Request parameters : name, email, DOI, facility, dataID, comment
- Response type : JSON document saved to publication DB collection
- Registered information should be verified by administrators before showing up in the API search results.
| Key | Value | OptionExample | Description |
|---|---|---|---|
| name | String | Your name | |
| String | E-mail address | ||
| DOI | String10.1000/xyz123 | DOI name of the publication to be registered | |
| facility | String | KMTNet KVN MIRIS | Select one of the data collections |
dataID | String Array | List of data identifiers used in the publication | |
| comment | String | Message to database managers |
...