Models

Model List

This provides a list of forecast models.

GET /models

Request Examples

See Headers for request header details.

$ curl -X GET http://model.api.wdtinc.com/models

Response Example

See Status Codes for response code details.

HTTP/1.1 200 OK
[
  {
    "id": "df38153a-c557-431f-82b1-83679460800c",
    "name": "noaa-storm-surge",
    "description": "NOAA storm surge forecast.",
    "forecasts": "/models/df38153a-c557-431f-82b1-83679460800c/forecasts"
  },
  {
    "id": "4a79aeab-84f0-4dde-ae39-a20b4ccee878",
    "name": "weatherops-tropical-gfe",
    "description": "WeatherOps AWIPS II GFE tropical forecast.",
    "forecasts": "/models/4a79aeab-84f0-4dde-ae39-a20b4ccee878/forecasts"
  }
]

Model Information

This provides information about a particular forecast model.

GET /models/{model-id-or-name}

Request Examples

See Headers for request header details.

$ curl -X GET http://model.api.wdtinc.com/models/4a79aeab-84f0-4dde-ae39-a20b4ccee878
$ curl -X GET http://model.api.wdtinc.com/models/weatherops-tropical-gfe

Response Example

See Status Codes for response code details.

HTTP/1.1 200 OK
{
  "id": "4a79aeab-84f0-4dde-ae39-a20b4ccee878",
  "name": "weatherops-tropical-gfe",
  "description": "WeatherOps AWIPS II GFE tropical forecast.",
  "forecasts": "/models/4a79aeab-84f0-4dde-ae39-a20b4ccee878/forecasts"
}

Model Variables

These are the variables that are required to exist in each of a model’s forecasts.

GET /models/{model-id-or-name}/variables

Request Example

See Headers for request header details.

$ curl -X GET http://model.api.wdtinc.com/models/weatherops-tropical/variables

Response Example

[
  {
    "name": "weatherops-tropical-34kt-wind-probability-forecast",
    "description": "WeatherOps probability of tropical wind speed greater than 34 knots"
  },
  {
    "name": "weatherops-tropical-50kt-wind-probability-forecast",
    "description": "WeatherOps probability of tropical wind speed greater than 50 knots"
  },
  {
    "name": "weatherops-tropical-64kt-wind-probability-forecast",
    "description": "WeatherOps probability of tropical wind speed greater than 64 knots"
  },
  {
    "name": "weatherops-tropical-precipitation-forecast",
    "description": "WeatherOps tropical quantitative precipitation forecast in inches"
  },
  {
    "name": "weatherops-tropical-wind-direction-forecast",
    "description": "WeatherOps tropical wind direction forecast in degrees"
  },
  {
    "name": "weatherops-tropical-wind-gust-forecast",
    "description": "WeatherOps tropical wind gust forecast in knots"
  },
  {
    "name": "weatherops-tropical-wind-speed-forecast",
    "description": "WeatherOps tropical wind speed forecast in knots"
  }
]