Back to App
Ocean APIverse

FAQ / 常見問題

FAQ English

What is the Ocean APIverse platform?

Ocean APIverse is an open API platform maintained by the Ocean Data Bank (ODB) of Taiwan’s National Science and Technology Council. Unlike ODB’s main data viewer, Hidy, Ocean APIverse publishes marine data services compliant with the OpenAPI specification so researchers and developers can retrieve data programmatically.

What is the ODB CTD API (for example)?

The ODB CTD API provides nearly forty years of conductivity-temperature-depth observations around Taiwan, including temperature, salinity, dissolved oxygen, transmission and fluorescence. Users can query data by time and location through the API.

Why use ODB Open APIs?

ODB Open APIs provide access to a wide range of marine science datasets, from regional observational averages to global compilations. They comply with the OpenAPI specification, allowing users to call APIs directly from a browser without coding and to integrate data easily across disciplines and platforms. Following the FAIR principles, ODB APIs make marine data findable, accessible, interoperable, and reusable.

How can I retrieve data?

Use the Swagger UI to test each API by entering parameters such as longitude, latitude, and time to retrieve small data subsets. The “Try it out” function is intended for testing only. For larger datasets, copy the Request URL generated by Swagger into your browser or call the API using your own tools. You may also use the Hidy Viewer to interactively select regions and download data.

Are the APIs free?

Yes. All ODB Open APIs are free to use. Some advanced features—like importing/exporting user data or saving custom map layers—require login, but the API data itself is open. For citation guidelines, see: ODB data citation.

Tutorial needed. Are there any limitations or precautions when using the APIs?

Tutorial: https://www.odb.ntu.edu.tw/flipbook/vol26/. The Swagger “Try it out” interface is not designed for bulk downloads. Always limit spatial and temporal ranges using query parameters to reduce data transfer. For large requests, access the API directly via browser or programmatic tools.

Can I use these APIs in the Hidy Viewer?

Yes. Hidy (odbview.oc.ntu.edu.tw/hidy) integrates most ODB APIs (SADCP, CTD, ECO, etc.) within its graphical tools. Functions like “Global Terrain” are powered by GEBCO API endpoints. Ocean APIverse provides the formal OpenAPI documentation and testing interface for direct API access.

Where can I find example code to use the ODB APIs?

ODB provides open-source code on GitHub demonstrating how to call the MHW and WOA23 APIs and reproduce scientific figures. Examples: MHW example; WOA23 oxygen example.

FAQ 中文版

什麼是海洋資訊交流平台(Ocean APIverse)?

海洋資訊交流平台是由國家科學及技術委員會海洋學門資料庫(ODB)維護的開放 API 平台,提供全球海洋資料服務。與主要的資料展示平台 Hidy Viewer 不同,Ocean APIverse 用於發布符合 OpenAPI 規範的各類海洋資料 API,方便資料使用者以程式方式存取。

什麼是 ODB CTD API(舉例)?

ODB CTD API 提供臺灣周邊近 40 年的溫鹽深儀(CTD)觀測資料,包括溫度、鹽度、溶氧、透光度和螢光度等感測器數據。透過 API 可查詢指定時間與空間的測站資料。

為什麼要使用 ODB Open API?

ODB Open API 提供多樣化的海洋科學資料,涵蓋臺灣海域觀測平均場及多種全球資料集。API 遵循國際 OpenAPI 規範,可直接透過瀏覽器調用,不一定需要撰寫程式,並易於跨領域與跨平台整合。此外,ODB Open API 遵循 FAIR 原則(Findable、Accessible、Interoperable、Reusable),讓資料更容易查找、取得、互操作與再利用。

如何取得資料?

您可以在 Ocean APIverse 的 Swagger UI 試用各個 API,輸入經緯度、時間等參數取得小範圍資料。Swagger 的「Try it out」介面僅用於測試,請避免大量下載。若需較大範圍資料,可將 Swagger 生成的 Request URL 貼到瀏覽器網址列,修改參數後取回資料;或透過 ODB 的 Hidy Viewer 以互動式地圖介面選取範圍並下載。

API 是否免費?

是的。ODB 所提供的開放 API 都免費開放使用。部分進階功能(如匯入/匯出資料或儲存自訂圖層)需要登入帳號,但 API 資料本身無需付費或登入,並參考 ODB 資料引用說明

有無步驟教學?使用 API 有什麼限制或注意事項?

步驟教學:https://www.odb.ntu.edu.tw/flipbook/vol26/。Swagger Try‑it‑out 功能主要供測試使用,並非大量下載管道。請善用 API 的參數篩選以限制時間與空間範圍,減少傳輸量。若下載大量資料,請於瀏覽器直接呼叫 API 或使用程式工具。

可以在 Hidy Viewer 使用 API 嗎?

可以。Hidy Viewer 已整合多個 ODB Open API(如 SADCP、CTD、ECO 等),透過圖形化介面直接呼叫。比如「全球地形」工具背後即透過 GEBCO API 取得資料。Ocean APIverse 則提供 OpenAPI 規範文件與測試介面,適合程式開發者使用。

是否有使用 ODB Open API 的範例程式?

ODB 在 GitHub 上提供開源程式範例,示範如何調用 MHW API 與 WOA23 API 重現科學研究圖像。例如:marineheatwave;WOA23 溶氧資料:woa23