{ "opencollection": "1.0.0", "info": { "name": "DTN Marine Weather API", "version": "1.0.0" }, "items": [ { "info": { "name": "Parameters", "type": "folder" }, "items": [ { "info": { "name": "GET /", "type": "http" }, "http": { "method": "GET", "url": "https://weather.api.dtn.com/" } } ] }, { "info": { "name": "Endpoints", "type": "folder" }, "items": [ { "info": { "name": "Marine Conditions", "type": "http" }, "http": { "method": "GET", "url": "https://weather.api.dtn.com/v1/conditions/marine", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "lat", "value": "55.81", "type": "query" }, { "name": "lon", "value": "3.88", "type": "query" }, { "name": "startTime", "value": "2023-06-30T10:00:00Z", "type": "query" }, { "name": "endTime", "value": "2023-07-07T10:00:00Z", "type": "query" }, { "name": "parameters", "value": "airTemp,seaSurfaceTemp,windSpeed10m", "type": "query" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.auth.dtn.com/v1/tokens/authorize", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint provides forecast and historical conditions for any specific point in the ocean. Specify the location, the marine parameters of interest, and a time range up to 10 days long, from 10 years in the past to 10 days in the future. The API responds with the requested time series in GeoJSON format.\n\nCommon uses include weather monitoring, marine research, localized operations, and supply-chain management planning in ports and offshore platforms.\n\nUse query parameters to control the resul" }, { "info": { "name": "Marine Route", "type": "http" }, "http": { "method": "POST", "url": "https://weather.api.dtn.com/v1/conditions/marine/route", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "parameters", "value": "airTemp,seaSurfaceTemp,windSpeed10m", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.auth.dtn.com/v1/tokens/authorize", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is designed for complex shipping applications, route planning, and back-track vessel analysis. Submit up to 1000 waypoints and timestamps in a single request body. The API responds with the marine weather conditions for each location and timestamp pair in GeoJSON format.\n\nQuota calculation: Please note that the quota charged is based on the number of locations or waypoints in your API requests, and not the number of requests. One request with 1000 locations uses the same API quota " }, { "info": { "name": "Wave Partitions", "type": "http" }, "http": { "method": "GET", "url": "https://weather.api.dtn.com/v1/conditions/marine/wave-partitions", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.auth.dtn.com/v1/tokens/authorize", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint provides a forecast for unique wave partition parameters. Like the Marine Conditions endpoint, specify the location, the marine parameters of interest, and a time range up to 10 days long, from now to 10 days in the future. The API responds with the requested time series in GeoJSON format.\n\nUse query parameters to control the results in the response body:\n\n * Specify a location as latitude (`lat`) and longitude (`lon`).\n\n * Specify `parameters` to filter by specific marine weath" }, { "info": { "name": "Marine Parameters", "type": "http" }, "http": { "method": "GET", "url": "https://weather.api.dtn.com/v1/conditions/marine/parameters", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "category", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.auth.dtn.com/v1/tokens/authorize", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint provides helpful context in JSON format about the marine weather parameters and operations that the other endpoints support.\n\nUse query parameters to control the results in the response body:\n * Set `category` to either `hourlyForecast` or `hourlyHistorical` to filter marine parameters by that category.\n * Specify a `name` to filter marine parameters by that name (e.g., `name=airTemp`).\n * Specify a `category` and `name` to filter by both.\n * Omit all query parameters to obtain" }, { "info": { "name": "Marine Spectra", "type": "http" }, "http": { "method": "GET", "url": "https://weather.api.dtn.com/v1/conditions/marine/spectra", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "lat", "value": "55.81", "type": "query" }, { "name": "lon", "value": "3.88", "type": "query" }, { "name": "startTime", "value": "2023-06-30T10:00:00Z", "type": "query" }, { "name": "endTime", "value": "2023-07-07T10:00:00Z", "type": "query" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.auth.dtn.com/v1/tokens/authorize", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint provides the hourly forecast 2D spectra wave data for a specified location and time range. Spectra 2D wave data represents the distribution of wave energy across various frequencies and directions at specific timestamps. This detailed information is crucial for understanding complex sea states and optimizing operations in offshore and shipping projects.\n\nFor example, it can be used to enhance the stability and safety of offshore platforms or to optimize routing for shipping vessels" }, { "info": { "name": "Marine Spectra Plot", "type": "http" }, "http": { "method": "GET", "url": "https://weather.api.dtn.com/v1/conditions/marine/spectra-plot", "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.auth.dtn.com/v1/tokens/authorize", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint provides frequency-direction spectral plots in polar coordinates for forecast times. This detailed information is crucial for understanding complex sea states and optimizing operations in offshore and shipping projects.\nThis endpoint returns a presigned URL to a zipped file containing the requested plots as PNG images.\n\nFor example, it can be used to enhance the stability and safety of offshore platforms or to optimize routing for shipping vessels to avoid severe sea conditions.\n\nU" } ] } ], "bundled": true }