Pacific Gyre API Explorer
Generate API request for Get Data and Send Command
Support

Don’t have an API key? Enter your username and password, then click Generate API key.
Use API Key for best performance. Username/Password is only for retrieving or confirming the key.

Retrieve sensor data from selected devices.

If empty, all fields are returned.
Only data recorded while submerged.
Select the sampling rate command to send to the device.
This action sends a command to the device and changes its sampling behavior.

If empty, default is beginning of today (UTC).
If empty, default is now (UTC).
Alternative to Start/End.
Alternative to Start/End.

Generate API Request
Build a URL you can open in browser or copy into your app.
Open
Tip: For KML in Google Earth, set File Format = KML and Download = Yes, then open the generated URL.
API Guide

The Pacific Gyre API allows customers to programmatically access device data from external applications (for example MATLAB, Python, or other software) by passing query parameters on a URL.

This API Helper provides a simple way to build, preview, and copy API requests. You can open the generated URL in a browser to verify results, or copy it directly into your application.

Authentication
  • Every Pacific Gyre user has a unique API Key.
  • The API key can be used instead of username and password for all API calls.
  • API keys are safer than passwords and cannot be used to log into the website.
  • Username and password are used only to retrieve or confirm an API key.
  • For best performance, always use the API key for data requests.
How This Helper Works
  • Some operations automatically force JSON output and disable the File Format selector.
  • Sections such as Device Filters, Time Range, and Output are shown or hidden based on the selected operation.
  • Selecting API Key Info switches authentication to username/password mode and disables the API key field.
Supported Output Formats

The API supports multiple output formats to simplify integration:

  • CSV, JSON, XML
  • Excel (XLSX)
  • KML (for Google Earth and mapping tools)
  • HTML and fixed-width text
Device & Field Selection
  • Device lists are loaded only after a valid API key is provided.
  • Available Fields requires at least one Comm ID to be selected.
Commonly Used Parameters
  • CommIDs – Comma-delimited list of device communication IDs (IMEI, etc.).
  • DeviceNames – Filter by device names.
  • FieldList – Return only selected fields (for example: Latitude,Longitude).
  • NumMinutes – Retrieve only the most recent data (for example: NumMinutes=30).
  • NumDays – Retrieve data for the last N days.
  • DateFormat – Customize date output format (default: yyyy-MM-dd HH:mm:ss).
  • FileFormat – Output format (CSV, JSON, XML, KML, etc.).
  • Compression – Optional file compression (gzip or zip).
Time Filtering Rules
  • NumMinutes and NumDays override Start and End dates.
  • If no time parameters are provided, API defaults are used.
  • All date and time values are interpreted as UTC.
URL Encoding

The API is called via URL. Ensure special characters are URL-encoded. Common examples:

  • %26 → &
  • %2C → ,
  • %20 → space
  • %3D → =
  • %3F → ?
Mapping & Visualization
  • To view data in Google Earth:
    • Set File Format = KML
    • Set Download = Yes
    • Specify a filename ending with .kml
Support & Assistance

If you encounter any issues, unexpected results, or have questions about the API, you can contact Pacific Gyre Support using one of the options below:

General Notes
  • Optional parameters may be removed to return default results.
  • Use Open to preview results and Copy to reuse the URL in your application.
Version: 1.0.0.0 2026-07-12
en-US
© 2026 Pacific Gyre • API v2 Explorer