API Reference

Note

API is currently in development


Github

/Catalog GET

Access metadata on datasets available in the repository.

Parameters: None

Returns: chunk-encoded data where each chunk is an array of metadata objects describing data available from the API.

The returned metadata objects have the following attributes:

variable(string)

The short name of the variable

longName(string)

The full name of the variable

unit(string)

The unit of measurement of the data

make(string)

Observation, Model or Assimilation

sensor(string)

The type of sensor used to collect the data

processLevel(string)

Near-Real-Time, Reprocessed or Forecast

temporalResolution(string)

The frequency of collection

spatialResolution(string)

The spatial domain of the data

comment(string)

Additional comment about the variables

datasetName(string)

The name of the dataset

dataSource(string)

Name of lab, project or organization where data originated

distributor(string)

Organization responsible for distributing the data

datasetDescription(string)

The full description of the dataset

datasetID(int)

Database linking ID

id(int)

Unique ID for variable

tableName(string)

The table storing this variable in the CMAP data repository

keywords(string)

A list of space-separated keywords describing the variable