View Source

This document describes how to access the metadata DBs in KASI Science Data Archive via HTTP APIs (https://data.kasi.re.kr/api/).

1. Search by coordinates (RA & DEC)

HTTP GET request ( URL: https://data.kasi.re.kr/api/facility/search?key1=value1&key2=value2&... )
Applicable facilities (case sensitive) : KMTNet, KVN, MIRIS
Request parameters : RA, DEC, rad, unit, limit, (object, band, project, datatype)
Response type : JSON (full metadata)
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

Search results can be narrowed down by additional parameters below :

Key	Value	Description
object	String	Target name
band	String	Observing bandpass (e.g., filter, frequency)
project	String	Project/Proposal ID
datatype	String	Type of data (e.g., OBJECT, FLAT, ...)

2. Search by publications (DOI)

HTTP GET request ( URL: https://data.kasi.re.kr/api/publication/find?DOI=DOI_name)
Request parameters : DOI, facility(optional)
Response type : JSON (DOI, facility, dataID)
Examples :
- https://data.kasi.re.kr/api/publication/find?DOI=10.1093/pasj/psy070

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.

facility

String

KMTNet

KVN

MIRIS

all

Select one of the data collections

3. List metadata by dataID

HTTP GET request ( URL: https://data.kasi.re.kr/api/facility/list/dataID1|dataID2|dataID3... )
Applicable facilities (case sensitive) : KMTNet, KVN, MIRIS
Request parameters : dataID(s)
Multiple dataIDs can be requested with pipe-delimited("|") string array
Response type : JSON (full metadata)
Examples :
- https://data.kasi.re.kr/api/MIRIS/list/MS1392658640|MS1392681902
- https://data.kasi.re.kr/api/KMTNet/list/kmta.20160530.009476|kmta.20160530.009477

Key

Value

Option

Description

dataID

String

pipe-delimited string array for multiple dataIDs

(e.g., dataID1|dataID2|dataID3...)

Data identifier

4. Retrieve publication information

HTTP GET request ( URL: https://data.kasi.re.kr/api/publication/search?facility=value1&dataID=value2)
Request parameters : facility, dataID
Response type : JSON (DOI, facility, dataID)
Examples :
- https://data.kasi.re.kr/api/publication/search?facility=MIRIS&dataID=MS1421157411

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
Link to the article information (ADS) : https://ui.adsabs.harvard.edu/abs/bibcode

Key

Value

Option

Default

Description

facility

String

KMTNet

KVN

MIRIS

all

Select one of the data collections

dataID

String

Data identifier used in the publication

*Input string must match exactly with dataID in metadata databases.

(i.e., partial string match is not allowed)

5. Register your publication

HTTP POST request ( URL: https://data.kasi.re.kr/api/register/request )
Request : JSON body {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	Option	Description
name	String		Your name
email	String		E-mail address
DOI	String		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

Document written by chr@kasi.re.kr

1. Search by coordinates (RA & DEC)

2. Search by publications (DOI)

3. List metadata by dataID

4. Retrieve publication information

5. Register your publication

관련 문서