HAPI: An API Standard for Accessing Heliophysics Time Series Data - Observatoire de Paris Access content directly
Journal Articles Journal of Geophysical Research Space Physics Year : 2021

HAPI: An API Standard for Accessing Heliophysics Time Series Data

Robert S. Weigel
  • Function : Author
Jon Vandegriff
  • Function : Author
Jeremy Faden
  • Function : Author
Todd King
  • Function : Author
D. Aaron Roberts
  • Function : Author
Bernard Harris
  • Function : Author
Robert Candey
  • Function : Author
Nand Lal
  • Function : Author
Scott Boardsen
  • Function : Author
Chris Lindholm
  • Function : Author
Doug Lindholm
  • Function : Author
Thomas Baltzer
  • Function : Author
Lawrence E. Brown
  • Function : Author
Eric W. Grimes
  • Function : Author
Benjamin Renard
  • Function : Author
Arnaud Masson
  • Function : Author
Beatriz Martinez
  • Function : Author

Abstract

Heliophysics data analysis often involves combining diverse science measurements, many of them captured as time series. Although there are now only a few commonly used data file formats, the diversity in mechanisms for automated access to and aggregation of such data holdings can make analysis that requires intercomparison of data from multiple data providers difficult. The Heliophysics Application Programmer's Interface (HAPI) is a recently developed standard for accessing distributed time series data to increase interoperability. The HAPI specification is based on the common elements of existing data services, and it standardizes the two main parts of a data service: the request interface and the response data structures. The interface is based on the REpresentational State Transfer (REST) or RESTful architecture style, and the HAPI specification defines five required REST endpoints. Data are returned via a streaming format that hides file boundaries; the metadata is detailed enough for the content to be scientifically useful, e.g., plotted with appropriate axes layout, units, and labels. Multiple mature HAPI-related open-source projects offer server-side implementation tools and client-side libraries for reading HAPI data in multiple languages (IDL, Java, MATLAB, and Python). Multiple data providers in the US and Europe have added HAPI access alongside their existing interfaces. Based on this experience, data can be served via HAPI with little or no information loss compared to similar existing web interfaces. Finally, HAPI has been recommended as a COSPAR standard for time series data delivery.

Keywords

Fichier principal
Vignette du fichier
JGR Space Physics - 2021 - Weigel - HAPI An API Standard for Accessing Heliophysics Time Series Data.pdf (205.69 Ko) Télécharger le fichier
Origin : Publisher files allowed on an open archive

Dates and versions

obspm-03600563 , version 1 (02-05-2023)

Licence

Copyright

Identifiers

Cite

Robert S. Weigel, Jon Vandegriff, Jeremy Faden, Todd King, D. Aaron Roberts, et al.. HAPI: An API Standard for Accessing Heliophysics Time Series Data. Journal of Geophysical Research Space Physics, 2021, 126, pp.2079-2089. ⟨10.1029/2021JA029534⟩. ⟨obspm-03600563⟩
61 View
31 Download

Altmetric

Share

Gmail Facebook X LinkedIn More