HAPI Server for INTERMAGNET datasets

This server supports the HAPI 3.1 API specification for delivery of time series data. The server responds to GET requests to the following HAPI endpoints:

• capabilities - list the API version and output options
• about - list the server ID, title and contact information
• catalog - list the datasets that are available ( total)
• info - list information about parameters in a dataset, e.g,:
• data - stream data for parameters in a dataset. Examples for first dataset:

Data set IDs for the INTERMAGNET HAPI server are composed of 4 parts: <iaga-code>/<publication-state>/<cadence>/<orientation> where:

• iaga-code is the IAGA code for the INTERMAGNET observatory
• publication-state is one of:
  • reported for raw data from the sensor
  • adjusted for data with provisional adjustments made
  • quasi-def for data within 5nT of their final values
  • definitive for final published data
  • best-avail for the best available from the above data types
• cadence is one of pt1m for minute data or pt1s for second data
• orientation is one of:
  • native for the orientation of the data as supplied by the data provider
  • xyzf for a Cartesian reference frame
  • hdzf for a Cylindrical reference frame
  • diff for a Spherical reference frame

Some institutes choose to embargo their data for a short time. Privileged user IDs can be set up to bypass the embargo for users who have made arrangements with data providers. Once provided, these user IDs can be used with http Basic authentication to bypass the embargo. If authentication fails, no information about the failure will be provided in the response and data will be provided with embargoes in place. Details of the embargo that is applied to each observatory can be seen at the observatory details page.

For more information about Intermagnet see the INTERMAGNET Technical Manual.
Contact: e_ginman@bgs.ac.uk