ODB Open API

Swagger API doc

ODB CTD/SADCP API manual/online try-out

Usage

1. ODB SADCP API: Get SADCP/current mean data collected by research vessels in the waters around Taiwan.

• e.g: https://ecodata.odb.ntu.edu.tw/api/sadcp?lon0=120&lon1=135&lat0=20&lat1=35&dep0=100

2. ODB CTD API: Get CTD mean data collected by research vessels in the waters around Taiwan.

• e.g: https://ecodata.odb.ntu.edu.tw/api/ctd?lon0=120&lon1=135&lat0=20&lat1=35&dep0=100

Demo

Use the CTD mean data queried by the ODB CTD API to plot the sea temperature and salinity distribution in the waters around Taiwan and the sea temperature, salinity and density profiles along 22°N.

Current runtime and development

The 1.7.0 release runs on Node 24.20.0 (.nvmrc) with pnpm 8.15.4. The production API paths are /api/ctd and /api/sadcp; Swagger UI is available at /api/, with OpenAPI JSON/YAML at /api/json and /api/yaml. /bio and /gql are retired, and raw/cruise query paths remain disabled.

Before making changes, read AGENTS.md, the production-readiness and performance assessment, and the SQL Server asset guide. Run the application tests with:

cd server
nvm use 24.20.0
pnpm test

SQL procedure files under database/stored-procedures/ are versioned review and rollback snapshots; they are not automatic migrations. Production SQL changes require the database/table maintainer's separate validation and rollback evidence. See CHANGES.md for the release summary and the release checklist for deployment order.

Skill (for AI agent)

You can also load skills/odb-openapi-ocean-maps into the skills/ folder used by your AI agent, so the agent can call ODB SADCP/CTD/GEBCO/MHW APIs and generate oceanographic maps with Basemap or Cartopy.

Prompt example:

• Use the odb-openapi-ocean-maps skill to draw a current map from ODB SADCP API for the Kuroshio east of Taiwan.

Reference example:

• See examples/japanese_eel_fig1_skill_cartopy_test and examples/japanese_eel_fig1_skill_cartopy_template_test for a reproduction-style example based on: Chang, YL.K., Miyazawa, Y., Miller, M.J. et al. Potential impact of ocean circulation on the declining Japanese eel catches. Sci Rep 8, 5496 (2018). https://doi.org/10.1038/s41598-018-23820-6
• Please note that the original figure used reanalysis/model circulation fields, while the examples in this repo use public ODB observation-based mean fields. The reproduced maps therefore keep the same scientific theme, but are not expected to be visually identical to the published figure.

Attribution

Reference:

1. https://www.odb.ntu.edu.tw/adcp/
2. https://www.odb.ntu.edu.tw/ctd/

Citation

• This API is compiled by Ocean Data Bank (ODB), and can be cited as:

  • Ocean Data Bank, National Science and Technology Council, Taiwan. https://doi.org/10.5281/zenodo.7512112. Accessed DAY/MONTH/YEAR from ecodata.odb.ntu.edu.tw/api/sadcp. v1.0.

  • Ocean Data Bank, National Science and Technology Council, Taiwan. https://doi.org/10.5281/zenodo.7512112. Accessed DAY/MONTH/YEAR from ecodata.odb.ntu.edu.tw/api/ctd. v1.0.