OceanWorks:
Ocean Science Platform

OceanWorks API

API BASE URL: https://oceanworks.jpl.nasa.gov/

End Point Description Sample Call
/list Provides a list of available data sets http://oceanworks.jpl.nasa.gov/list
/timeSeriesSpark Computes time series statistics https://oceanworks.jpl.nasa.gov/timeSeriesSpark?ds=AVHRR_OI_L4_GHRSST_NCEI&...
Parameter Required Sample Note
ds required one of shortName value as supplied by /list The dataset on which to generate the statistics
b required -60.0,10.0,-45.0,30.0 Bounding box Minimum (Western) Longitude, Minimum (Southern) Latitude, Maximum (Eastern) Longitude, Maximum (Northern) Latitude
startTime required 1453072400 Starting time in format YYYY-MM-DDTHH:mm:ssZ or seconds since EPOCH
endTime required 1463072400 Ending time in format YYYY-MM-DDTHH:mm:ssZ or seconds since EPOCH
seasonalFilter optional False Flag used to specify if the seasonal averages should be computed during Time Series computation
lowPassFilter optional False Flag used to specify if a low pass filter should be computed during Time Series computation
spark optional local,4,8 Configuration used to launch in the Spark cluster. Value should be 3 elements separated by commas. 1) Spark Master 2) Number of Spark Executors 3) Number of Spark Partitions. Only Number of Spark Partitions is used by this function.
output optional JSON Data formatting for results. Default is ‘JSON’. Alternative is ‘CSV’ for comma-seperated values
End Point Description Sample Call
/dailydifferenceaverage_spark Computes anomolies for a specified region over a specified timeframe https://oceanworks.jpl.nasa.gov/dailydifferenceaverage_spark?ds1=AVHRR_OI_L4_GHRSST_NCEI&climatology=AVHRR_OI_L4_GHRSST_NCEI_CLIM...
Parameter Required Sample Note
dataset required AVHRR_OI_L4_GHRSST_NCEI The dataset on which to calculate anomalies. One of shortName value as supplied by /list
climatology required AVHRR_OI_L4_GHRSST_NCEI_CLIM The dataset climatology used to calculate anomalies. One of shortName value as supplied by /list
b required -170,-5,-120,5 Minimum (Western) Longitude, Minimum (Southern) Latitude, Maximum (Eastern) Longitude, Maximum (Northern) Latitude
startTime required 1291190400 Start time in which to calculate anomalies, in format YYYY-MM-DDTHH:mm:ssZ or seconds since epoch (Jan 1st, 1970)
endTime required 1462086000 End time in which to calculate anomalies, in format YYYY-MM-DDTHH:mm:ssZ or seconds since epoch (Jan 1st, 1970)

Output

The output consist of json (or CSV if specified) resulting in several pieces of information.