API Reference

Main interface to HAPI servers and provides multiple dispatch for different use cases:

• hapi() - List available HAPI servers (get_servers)
• hapi(server) - Get catalog of datasets from a server (get_catalog)
• hapi(server, dataset) - Get parameter information for a dataset (get_parameters)
• hapi(server, dataset, parameters) - Get parameter information for specific parameters (get_parameters)
• hapi(server, dataset, tmin, tmax) - Get all data for a dataset in a time range (get_data)
• hapi(server, dataset, parameters, tmin, tmax) - Get specific parameter data in a time range (get_data)

get_data(server, dataset, parameters, tmin, tmax; format="csv")

Get data and metadata from a HAPI server for a given dataset and parameters within a time range [tmin, tmax].

Supported optional keyword arguments:

• format: Data format, default is "csv" (other options: "binary", "json").
• verbose: Verbosity level (passed to HTTP.get), default is 0 (other options: 1, 2).

get_data(path, tmin, tmax; kwargs...)

Get data and metadata using a path in the format "server/dataset/parameter".

An array-like object that represents a HAPI variable.

Fields

• data: The underlying data values (use parent(x) to access).
• time: The time axis (use times(x) to access).
• meta: The metadata (use meta(x) to access).

HAPIVariable(d, i)

Construct a HAPIVariable object from a JSON-parsed Dict d (containing parameters) at index i.

HAPIVariable(data, params, i)

Construct a HAPIVariable object from a JSON-parsed data and params at index i.

HAPIVariable(data, params, i)

Construct a HAPIVariable object from CSV.File data and params at index i.

A thin wrapper over NamedTuple for HAPI variables that shares the same time axis.

Server(id)

Get a HAPI server instance by its ID.

Examples

cdaweb = Server("CDAWeb") # same as HAPIClient.CDAWeb

get_data(server, dataset, parameters, tmin, tmax; format="csv")

Get data and metadata from a HAPI server for a given dataset and parameters within a time range [tmin, tmax].

Supported optional keyword arguments:

• format: Data format, default is "csv" (other options: "binary", "json").
• verbose: Verbosity level (passed to HTTP.get), default is 0 (other options: 1, 2).

get_data(path, tmin, tmax; kwargs...)

Get data and metadata using a path in the format "server/dataset/parameter".

Main interface to HAPI servers and provides multiple dispatch for different use cases:

• hapi() - List available HAPI servers (get_servers)
• hapi(server) - Get catalog of datasets from a server (get_catalog)
• hapi(server, dataset) - Get parameter information for a dataset (get_parameters)
• hapi(server, dataset, parameters) - Get parameter information for specific parameters (get_parameters)
• hapi(server, dataset, tmin, tmax) - Get all data for a dataset in a time range (get_data)
• hapi(server, dataset, parameters, tmin, tmax) - Get specific parameter data in a time range (get_data)

Parameter

Represents a HAPI parameter with validation according to the specification.

Required fields:

• name: String identifier for the parameter
• type: One of "string", "double", "integer", or "isotime"
• units: String, array of strings, or nothing for dimensionless quantities
• fill: String or nothing indicating no fill value

Type-specific requirements:

• For string and isotime types: must specify length
• For array parameters: must specify size

Optional fields:

• description: Brief description of the parameter
• label: Display label or array of labels
• size: Array dimensions for array parameters
• bins: Array parameter bin information
• stringType: For string parameters that represent URIs
• coordinateSystemName: Name of coordinate system for vector quantities
• vectorComponents: Component names for vector quantities

Default format for HAPI servers.

get_capabilities(server)

Get server capabilities.

get_catalog(server)

Get a list of datasets available from the server.

HAPI info response JSON structure: https://github.com/hapi-server/data-specification/blob/master/hapi-dev/HAPI-data-access-spec-dev.md#35-catalog

get_parameters(server, id, parameters)

Get a dictionary containing the HAPI info metadata for each parameter in the comma-separated string parameters.

get_parameters(server, id)

Get a dictionary containing the HAPI info metadata for all parameters in the id dataset. Returns a tuple of (info, parameters) where info is the full response and parameters is a Vector of Parameter objects.

HAPI info response JSON structure: https://github.com/hapi-server/data-specification/blob/master/hapi-dev/HAPI-data-access-spec-dev.md#36-info

get_servers()

Get a list of available HAPI server URLs from https://github.com/hapi-server/servers/raw/master/all.txt

is_time_parameter(param::Parameter)

Check if a parameter is a valid time parameter (first parameter in a dataset).

load_servers_from_json(; url=DEFAULT_SERVERS_JSON_URL, register=false)

Load HAPI servers from a JSON file at the specified URL.

Parse parameters into a Vector of Parameter objects and validate first parameter is time.