Distributed Oceanographic Matchup Service (DOMS)
Funded by NASA's Earth Science Technology Office from the Advanced Information Systems Technology Program (NNH14ZDA001N-AIST)
DOMS API
Data Subsetting API
Both Satellite and In Situ Data
| End Point | Description | Sample Call |
|---|---|---|
| https://doms.jpl.nasa.gov/domssubset | Subset DOMS sources given the search domain | https://doms.jpl.nasa.gov/domssubset?dataset=AVHRR_OI_L4_GHRSST_NCEI&insitu=icoads,samos,spurs,spurs2... |
| Parameter | Required | Sample | Note |
|---|---|---|---|
| dataset | optional* | AVHRR_OI_L4_GHRSST_NCEI | The NEXUS dataset. *Optional but at least one of 'dataset' or 'insitu' are required |
| insitu | optional* | icoads,samos,spurs,spurs2 | The in situ source(s). *Optional but at least one of 'dataset' or 'insitu' are required |
| startTime | required | 2013-10-21T00:00:00Z | Starting time in format YYYY-MM-DDTHH:mm:ssZ or seconds since EPOCH |
| endTime | required | 2013-10-31T23:59:59Z | Ending time in format YYYY-MM-DDTHH:mm:ssZ or seconds since EPOCH |
| b | required | -30,15,-45,30 | Minimum (Western) Longitude, Minimum (Southern) Latitude, Maximum (Eastern) Longitude, Maximum (Northern) Latitude |
| parameter | required | sss | The parameter of interest. One of 'sst', 'sss', 'wind' |
| depthMin | optional | 0 | Minimum depth of measurements. Must be less than depthMax. Default: No limit |
| depthMax | optional | 5 | Maximum depth of measurements. Must be greater than depthMin. Default: No limit |
| platforms | optional | 1,2,3,4,5,6,7,8,9 | Platforms to include for subset consideration. Default: All |
| output | required | ZIP | Output type. Only 'ZIP' is currently supported |
In Situ Data
| End Point | Description | Sample Call |
|---|---|---|
| http://rda-data.ucar.edu:8890/ws/search/icoads | International Comprehensive Ocean-Atmosphere Data Set (ICOADS) Release 3, Individual Observations | http://rda-data.ucar.edu:8890/ws/search/icoads?startTime=2012-08-01T00:00:00Z&... |
| http://doms.coaps.fsu.edu/ws/search/samos | Shipboard Automated Meteorological and Oceanographic System (SAMOS) Data | http://doms.coaps.fsu.edu/ws/search/samos?startTime=2012-08-01T00:00:00Z&... |
| https://doms.jpl.nasa.gov/spurs | Salinity Processes in the Upper Ocean Regional Study - 1 (SPURS-1) Data | https://doms.jpl.nasa.gov/spurs?startTime=2012-08-01T00:00:00Z&... |
| https://doms.jpl.nasa.gov/spurs2 | Salinity Processes in the Upper Ocean Regional Study - 2 (SPURS-2) Data | https://doms.jpl.nasa.gov/spurs2?startTime=2016-07-01T00:00:00Z&... |
| Parameter | Required | Sample | Note |
|---|---|---|---|
| startTime | optional | 2012-08-01T00:00:00Z | start time in the format of YYYY-MM-DDTHH:mm:ssZ |
| endTime | optional | 2013-10-31T23:59:59Z | end time in the format of YYYY-MM-DDTHH:mm:ssZ |
| bbox | optional | -45,15,-30,30 | bounding box with coordinates specified in this order: west, south, east, north |
| variable | optional | sss | sst, sss, or wind |
| minDepth | optional | -5 | minimum depth value in meters |
| maxDepth | optional | 5 | maximum depth value in meters |
| platform | optional | 1 | platform ID |
| startIndex | optional | 0 | start index of entries in the result; used for pagination; default is 0 |
| itemsPerPage | optional | 10 | number of results per page; default is 10 |
| pretty | optional | true | return formatted results if set to true |
| End Point | Description | Sample Call |
|---|---|---|
| https://doms.jpl.nasa.gov/domsinsitusubset | Subset a DOMS in situ source given the search domain. | https://doms.jpl.nasa.gov/domsinsitusubset?source=spurs&startTime... |
| Parameter | Required | Sample | Note |
|---|---|---|---|
| source | required | spurs | The in situ Dataset to be sub-setted |
| startTime | required | 2013-10-21T00:00:00Z | Starting time in format YYYY-MM-DDTHH:mm:ssZ or seconds since EPOCH |
| endTime | required | 2013-10-31T23:59:59Z | Ending time in format YYYY-MM-DDTHH:mm:ssZ or seconds since EPOCH |
| b | required | -30,15,-45,30 | Minimum (Western) Longitude, Minimum (Southern) Latitude, Maximum (Eastern) Longitude, Maximum (Northern) Latitude |
| parameter | optional | sss | The parameter of interest. One of 'sst', 'sss', 'wind'. Default: All |
| depthMin | optional | 0 | Minimum depth of measurements. Must be less than depthMax. Default: No limit |
| depthMax | optional | 5 | Maximum depth of measurements. Must be greater than depthMin. Default: No limit |
| platforms | optional | 1,2,3,4,5,6,7,8,9 | Platforms to include for subset consideration. Default: All |
| output | optional | CSV | Output type. Only 'CSV' or 'JSON' is currently supported. Default: JSON |
Satellite Data
| End Point | Description | Sample Call |
|---|---|---|
| https://doms.jpl.nasa.gov/datainbounds | Fetches point values for a given dataset and geographical area | https://doms.jpl.nasa.gov/datainbounds?ds=AVHRR_OI_L4_GHRSST_NCEI&startTime... |
| Parameter | Required | Sample | Note |
|---|---|---|---|
| ds | required | AVHRR_OI_L4_GHRSST_NCEI | The Dataset shortname to use in calculation |
| startTime | required | 2013-10-21T00:00:00Z | Starting time in format YYYY-MM-DDTHH:mm:ssZ or seconds since EPOCH |
| endTime | required | 2013-10-31T23:59:59Z | Ending time in format YYYY-MM-DDTHH:mm:ssZ or seconds since EPOCH |
| b | required | -30,15,-45,30 | Minimum (Western) Longitude, Minimum (Southern) Latitude, Maximum (Eastern) Longitude, Maximum (Northern) Latitude |
| parameter | required | sst | The parameter of interest. One of 'sst', 'sss', 'wind' |
| output | optional | CSV | Output type. Only 'CSV' or 'JSON' is currently supported |
Data Matchup API
| End Point | Description | Sample Call |
|---|---|---|
| https://doms.jpl.nasa.gov/apiversion | List the version of the API | https://doms.jpl.nasa.gov/apiversion |
| https://doms.jpl.nasa.gov/domslist | Provides a list of available data sets | https://doms.jpl.nasa.gov/domslist |
| https://doms.jpl.nasa.gov/domsvalues | Fetches stats and data values for the selected in situ source and bounding box | https://doms.jpl.nasa.gov/domsvalues?source=spurs&... |
| https://doms.jpl.nasa.gov/match_spark | Executes the data matchup service | https://doms.jpl.nasa.gov/match_spark?primary=JPL-L4_GHRSST-SSTfnd-MUR-GLOB-v02.0-fv04.1&matchup=spurs... |
| Parameter | Required | Sample | Note |
|---|---|---|---|
| primary | required | JPL-L4_GHRSST-SSTfnd-MUR-GLOB-v02.0-fv04.1 | The Primary dataset used to find matches for. One of the satellite "shortName" as supplied by https://doms.jpl.nasa.gov/domslist |
| matchup | required | spurs | The Dataset(s) being searched for measurements that match the measurements in Primary. One or more (comma-separated) of the insitu "name" as supplied by https://doms.jpl.nasa.gov/domslist |
| startTime | required | 2012-09-25T00:00:00Z | Starting time in format YYYY-MM-DDTHH:mm:ssZ |
| endTime | required | 2012-09-30T23:59:59Z | Ending time in format YYYY-MM-DDTHH:mm:ssZ |
| b | required | -40,25,-45,30 | Minimum (Western) Longitude, Minimum (Southern) Latitude, Maximum (Eastern) Longitude, Maximum (Northern) Latitude |
| platforms | required | 1,2,3,4,5,6,7,8,9 | Platforms to include for matchup consideration |
| depthMin | optional | 0 | Minimum depth of measurements allowed to be considered for matchup |
| depthMax | optional | 5 | Maximum depth of measurements allowed to be considered for matchup |
| tt | optional (default: 86400) | 86400 | Tolerance in time (seconds) when comparing two measurements. |
| rt | optional (default: 1000.0) | 1000.0 | Tolerance in radius (meters) when comparing two measurements |
| parameter | optional (default: sst) | sst | The parameter of interest used for the match up. One of 'sst', 'sss', 'wind'. |
| matchOnce | optional (default: False) | false | True/False flag used to determine if more than one match per primary point is returned. If true, only the nearest point will be returned for each primary point. If false, all points within the tolerances will be returned for each primary point. |
| resultSizeLimit | optional (default: 500) | 500 | Optional integer value that limits the number of results returned from the matchup. If the number of primary matches is greater than this limit, the service will respond with (HTTP 202: Accepted) and an empty response body. A value of 0 means return all results. Default: 500 |
The following output formats are supported: JSON, CSV, NETCDF The JSON output contains a data array of matched observations. Each object in the data array contains the observation from the primary dataset along a matches array that contains the observations from the secondary dataset(s). The specification for the CSV and NetCDF output is available here. Note that the output file format is still work in progress and will change in future releases. | |||
Data Analytics API
| End Point | Description | Sample Call |
|---|---|---|
| https://doms.jpl.nasa.gov/stats | Computes time series statistics | https://doms.jpl.nasa.gov/stats?ds=... |
| Parameter | Required | Sample | Note |
|---|---|---|---|
| ds | required | one of shortName value as supplied by /list | The dataset on which to generate the statistics |
| minLat | required | -90 : 90 | minimum latitude on which to generate statistics |
| maxLat | required | -90 : 90 | maximum latitude on which to generate statistics |
| minLon | required | -180 : 180 | minimum longitude on which to generate statistics |
| maxLon | required | -180 : 180 | maximum longitude on which to generate statistics |
| startTime | required | 1190962800000 | Start time in which to calculate statistics, in milliseconds since epoch (Jan 1st, 1970) |
| endTime | required | 1317193200000 | End time for which statistics will be calculated, in milliseconds since epoch (Jan 1st, 1970) |
| output | optional | JSON | Data formatting for results. Default is ‘JSON’. Alternative is ‘CSV’ for comma-seperated values. |