The OOI Machine-to-Machine (M2M) interface provides access to OOI data via a RESTful Application Programming Interface (API). A RESTful API allows two software programs to communicate with each other. For OOI, this interface allows authenticated users to request small amounts of data via synchronous JSON requests, request larger amounts of data in NetCDF or CSV format to download multiple data streams or data from multiple platforms, or set up recurring downloads to update an existing dataset. Additionally, searches of the asset management system can be executed to find deployment, calibration, quality control parameters, annotations, and other information, both in bulk and for specific instruments or platforms.
OOI Machine to Machine (M2M) Examples
A number of Community Tools resources have been developed to assist users in getting started using M2M. The examples below are not exhaustive, but do include some step-by-step instructions and sample code that can be modified by users seeking access to data. We have found it is helpful to familiarize yourself with OOI terminology and data structure using the OOI Knowledge Base and the additional resources at the bottom of this page before you dive into the M2M system.
M2M Quickstart Examples
The following examples show how the OOI API interface can be used to request, download, and plot OOI data using various programming libraries.Matlab Quickstart Python Quickstart R Quickstart
M2M Demo Workbooks
The following Python notebooks demonstrate how the Python requests library can be used to access data from the OOI M2M web service.Basic M2M Examples JSON Requests NetCDF Requests Real-Time Requests
For additional guidance, please see the following examples, developed for the 2018 Early Career Data Workshops held at Rutgers University.Introduction to the OOI M2M Interface Synchronous Requests and Basic Plotting Example 1 – Requesting OOI Data in NetCDF Format
Demonstrates how the OOI M2M interface can be used to retrieve information about OOI instruments in the database and to request downloads for instrument data.Example 2 – Plotting OOI Time Series Data (from NetCDF files)Shows how to programmatically download and work with NetCDF time series data from the OOI. Example 3 – Plotting DO Profiles (and more) from NetCDF data filesDemonstrates how to programmatically download and plot colored depth profilers using OOI NetCDF data, using data from the Cabled Array Oregon Slope Base Shallow Profiler Mooring Shallow Profiler CTD.
M2M User Login Information
Before you can use the OOI M2M Interface/API, you need to establish an account on the OOI Data Portal. Please use the following steps to setup your account and retrieve your API Username and Token. (Note, these are different from the username and password you use to log into the Data Portal.)
- Create a user account on ooinet.oceanobservatories.org, or use the CILogon button with an academic or Google account.
- Log in
- Navigate to the drop down menu screen in the top-right corner menu
- Click on the “User Profile” element of the drop down.
- Copy and save the following data from the user profile: API Username and API Token.
Tools to access OOI M2M Web Services
Here is a quick rundown on how to access the OOI M2M using some common coding tools.
Python (using the library)
1 | requests.get('https://ooinet.oceanobservatories.org/api/m2m/...', auth=(API_USERNAME, API_TOKEN))
1 | urlread('https://ooinet.oceanobservatories.org/api/m2m/...', 'Authentication', 'Basic', 'Username', API_USERNAME, 'Password', API_TOKEN);
1 | curl –k https://API_USERNAME:API_TOKEN@ooinet.oceanobservatories.org/api/m2m/…
1 | http --auth API_USERNAME:API_TOKEN https://ooinet.oceanobservatories.org/api/m2m/...