# HAPI

The Heliophysics Application Programming Interface (HAPI) is an extra interface to the VirES server, provided as a more interoperable alternative to the main VirES API. The capabilities are essentially a subset of VirES: access is more simplified but not all features are available (e.g. no auxiliary variables, no magnetic model handling).

Production server: https://vires.services/hapi/
Public test server: https://staging.viresdisc.vires.services/hapi/

- What is HAPI?
- Overview: https://hapi-server.org (find clients here)
- The spec and other dev: https://github.com/hapi-server/
- Tools using HAPI
- scripting clients:
- :heavy_check_mark: [hapiclient](https://github.com/hapi-server/client-python) (Python - available in VRE)
- [IDL](https://github.com/hapi-server/client-idl) & [MATLAB](https://github.com/hapi-server/client-matlab) & more
- Autoplot, (Py)SPEDAS etc. See http://hapi-server.org/
- Guides:
*:sun_with_face: Using HAPI* page in Swarm Notebooks:
https://notebooks.vires.services/notebooks/02h1_hapi
- Tools to test HAPI:
- Reference interface:
https://hapi-server.org/servers/
https://hapi-server.org/servers-dev
- Server verifier: https://hapi-server.org/verify/
- Quick plots: https://hapi-server.org/plot/
- Swarm implementation:
- Described at https://vires.services/hapi/
- Demonstrations:
- Using the verifier (it is quite an intense process and will take a while):
- https://hapi-server.org/verify/?url=https://vires.services/hapi
- https://hapi-server.org/verify/?url=https://staging.viresdisc.vires.services/hapi
- /plot:
:heavy_check_mark: https://hapi-server.org/plot/?server=https://vires.services/hapi/&id=SW_OPER_MAGA_LR_1B&parameters=B_NEC&usecache=true&format=png&dpi=72&time.min=2013-11-26T00:00:00.000Z&time.max=2013-11-26T23:59:59.999Z
:heavy_check_mark: https://hapi-server.org/plot/?server=https://vires.services/hapi/&id=SW_OPER_MAGA_HR_1B&parameters=B_NEC&usecache=true&format=png&dpi=72&time.min=2013-11-26T00:00:00.000Z&time.max=2013-11-26T00:10:00.000Z
- /plot with ViViz (gallery):
:heavy_check_mark: hapi-server.org/plot/?server=https://vires.services/hapi/&id=SW_OPER_MAGA_LR_1B&format=gallery
:heavy_check_mark: hapi-server.org/plot/?server=https://vires.services/hapi/&id=SW_OPER_MAGA_HR_1B&format=gallery (watch out for exceeding `x_maxTimeSelection`)