View Source

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 :
- https://data.kasi.re.kr/api/KMTNet/search?ra=84.0&dec=-70&rad=30&unit=arcmin&limit=10
- https://data.kasi.re.kr/api/MIRIS/search?ra=84.0&dec=-70.0

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://data.kasi.re.kr/api/data_collection/list/dataID(s))
Applicable data collections (case sensitive) : KMTNet, MIRIS, ~~KVN~~(not ready yet)
Request parameters : dataID(s)
Multiple dataIDs can be requested with pipe-delimited("|") string array
Response type : JSON
Examples :
- https://data.kasi.re.kr/api/MIRIS/list/MS1392658640|MS1392681902

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/doi?DOI=DOI_name)
Request parameters : DOI
Response type : JSON (DOI, facility, dataID)
Examples :
- https://data.kasi.re.kr/api/publication/doi?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.

♦ Retrieve publication information

HTTP GET request (URL: https://data.kasi.re.kr/api/publication/search?key1=value1&key2=value2&...)
Request parameters : facility, dataID
Response type : JSON (DOI, facility, dataID)
Examples :
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

facility

String

KMTNet

KVN

MIRIS

all

Select one of the data collections

dataID

String

Data identifier used in the publication

♦ 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	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

사용자가 주의해야할 사항이나 팁 또는 관련 정보를 알리기 위해 패널을 사용할 수 있습니다.

♦ Search by coordinates (RA & DEC)

♦ List metadata by dataID

♦ Search by publications (DOI)

♦ Retrieve publication information

♦ Register your publication

관련 문서