CORIOLIX has been developed to make it easier for humans to interact with the underway sensor systems aboard research vessels. For machine-to-machine communication we publish data and metadata from our backend database through a REST API that makes it easy for external applications, programs and software packages (R, Matlab, etc.) to access data. Note that we also provide access to the same data via an ERDDAP server.

This page provides a list of available API endpoint qualifiers and some example API queries (URLs).

REST API Base URL (BASE_URL) for this CORIOLIX website
https://coriolix.sikuliaq.alaska.edu/api/

REST API Description (Swagger UI)
BASE_URL/schema/swagger-ui/

METADATA

ALL METADATA OPTIONS
To view all available REST API metadata endpoints:
BASE_URL

SENSOR METADATA
To retrieve metadata for a sensor:
BASE_URL/sensor/?sensor_id=metsta146582&format=json

PARAMETER METADATA
To retrieve metadata for all parameters of a sensor:
BASE_URL/parameter/?sensor_id=metsta146582&format=json
To retrieve metadata for a specific parameter:
BASE_URL/parameter/?sensor_id=metsta146582&detailed_name=airtemperature_degreesc&format=json

LAST DATA RECEIVED

LATEST DATA VALUES (WITH METADATA)
To retrieve the most recent data values for all sensors and parameters, accompanied by a small amount of metadata:
BASE_URL/last_obs/?format=json

Note: This API call returns a GeoJSON object.
Example code snippets to extract a parameter's data value from the GeoJSON data are:
JavaScript: var myvalue = data.features[0].properties.value;
Python: data = data['features'][0]['properties']['value']

Optional URL Parameters for the last_obs Endpoint

NAME	VALUE FORMAT	EXAMPLE	DESCRIPTION
parameter_id	UUID	parameter_id=45a29fdb-d74a-476b-a5f0-52bbf1631254	returns the latest values from this specific parameter only
sensor_id	text	sensor_id=pyrano190096	returns the latest parameter values collected by this sensor
detailed_name	text	detailed_name=latitude_degrees	returns the latest values from all parameters with this name
is_primary	1 or true	is_primary=1	returns the latest values from all primary parameters
format	'json' or 'csv'	format=csv	the desired output data format (default is json)

PARAMETER DATA

FULL RESOLUTION DATA
To retrieve data from a specific parameter from a specific sensor over a specific time interval at full resolution:
BASE_URL/data/fullres/metsta146582/airtemperature_degreesc/?date_after=2026-04-03%2011:15:16&date_before=2026-04-03%2011:45:16

PRIMARY PARAMETER DATA
To retrieve data from the primary source of a specific parameter over a specific time interval at full resolution:
BASE_URL/data/fullres/primary/airtemperature_degreesc/?date_after=2026-04-03%2011:15:16&date_before=2026-04-03%2011:45:16

DECIMATED DATA
To retrieve every 10th data point from the full resolution data within a specific time interval:
BASE_URL/data/fullres/metsta146582/airtemperature_degreesc/?date_after=2026-04-03%2011:15:16&date_before=2026-04-03%2011:45:16&decfactr=10

LATEST DATA VALUE
To retrieve the most recent data value for a single parameter:
BASE_URL/data/fullres/metsta146582/airtemperature_degreesc/?last_item=1

Optional URL Parameters for Full Resolution Data Retrieval

NAME	VALUE FORMAT	EXAMPLE	DESCRIPTION
date_after	datetime (UTC)	date_after=2025-10-30%2004:00:00	returns only the data from after this date
date_before	datetime (UTC)	date_before=2025-10-31%2004:00:00	returns only the data from before this date
decfactr	integer greater than 1	decfactr=10	returns every X rows only (decimates the data)
last_item	any (e.g. 1 or true)	last_item=1	returns the last (most recent) values from the date range
format	'json' or 'csv'	format=csv	the desired output data format (default is csv)

DATA COUNT

NUMBER OF DATA RECORDS
To retrieve the number of data points in a table within a specific time interval:
BASE_URL/data/countdata/?table=airtemperature_degreesc_metsta146582_fullres&date_0=2026-04-03%2011:15:16&date_1=2026-04-03%2011:45:16
If the table does not exist or is empty, a value of 0 will be returned.

BINNED DATA (WITHOUT STATISTICS)

All requests for binned data will automatically include the following fields:
id, time, latitude, longitude

If no URL parameters are provided, the default is to provide the 1-minute binned data from all parameters and all available dates in CSV format.

To retrieve 10-minute binned data from a specific time interval for all parameters:
BASE_URL/data/binned/?bin_interval=600&date_after=2026-04-03%2011:15:16&date_before=2026-04-03%2011:45:16

Optional URL Parameters for Binned Data Retrieval

NAME	VALUE FORMAT	EXAMPLE	DESCRIPTION
bin_interval	'60' or '600'	bin_interval=60	returns 60-second or 600-second bins (default is 60)
date_after	datetime (UTC)	date_after=2025-10-30%2004:00:00	returns only the data from after this date
date_before	datetime (UTC)	date_before=2025-10-31%2004:00:00	returns only the data from before this date
decfactr	integer greater than 1	decfactr=10	returns every X rows only (decimates the data)
last_item	any (e.g. 1 or true)	last_item=1	returns the last (most recent) values from the date range
format	'json' or 'csv'	format=csv	the desired output data format (default is csv)
geo	true	geo=true	if true, outputs the data with a geo point field (available in JSON format only)
fields	comma-separated list	fields=latitude_degrees_seapth000000,longitude_degrees_seapth000000	exact match to binned field names (case insensitive)
sensors	comma-separated list	sensors=seapth000000,anemom005805	exact match to sensor IDs (case insensitive)
sensors_like	comma-separated list	sensors_like=seapth,anemo	matches part of the sensor ID, model, name, or type (case insensitive)
parameters	comma-separated list	parameters=latitude,sog	exact match to the parameter short name (case insensitive)
parameters_like	comma-separated list	parameters_like=course,speed	matches part of the parameter short name or long name (case insensitive)
classes	comma-separated list	classes=navigation,flowthrough	exact match to sensor classes (case insensitive)
is_primary	any (e.g. 1 or true)	is_primary=true	if set, outputs only primary parameters

BIN STATISTICS

All requests for bin statistics will automatically include the following fields:
id, time, spot_time, spot_value, mean, stddev, minimum, maximum, num_values

If no URL parameters are provided, the default is to provide 1-minute binned data statistics from all available dates in CSV format.

To retrieve bin statistics from a specific time interval for an individual parameter:
BASE_URL/data/binstats/metsta146582/airtemperature_degreesc/?bin_interval=60&date_after=2026-04-03%2011:15:16&date_before=2026-04-03%2011:45:16

Optional URL Parameters for Bin Statistics Retrieval

NAME	VALUE FORMAT	EXAMPLE	DESCRIPTION
bin_interval	'60' or '600'	bin_interval=60	returns 60-second or 600-second bins (default is 60)
date_after	datetime (UTC)	date_after=2025-10-30%2004:00:00	returns only the data from after this date
date_before	datetime (UTC)	date_before=2025-10-31%2004:00:00	returns only the data from before this date
decfactr	integer greater than 1	decfactr=10	returns every X rows only (decimates the data)
last_item	any (e.g. 1 or true)	last_item=1	returns the last (most recent) values from the given date range
format	'json' or 'csv'	format=csv	the desired output data format (default is csv)