Describe one data catalog product.

Returns one product of the data catalog: the GET /v1/catalog fields plus its agent_description, aliases, question_shapes, related products and variables (names, standard names, units, display units, valid range, thresholds, categories and bands).

include=freshness adds the product's freshness (experimental), as on the list. Caching, auth and cost are as on GET /v1/catalog, including the ETag and 304 without include=freshness.

An id that is not in the catalog, or not served on the REST API, returns 404.

get/v1/catalog/{product_id}

Request

Base URL: https://api.smarterweather.com
URL: https://api.smarterweather.com/v1/catalog/{product_id}
Auth: HTTP bearer

Path parameters

product_idstring required

Catalog product id, e.g. nbm_conus or mrms_qpe_24h_pass2_conus.

Query parameters

includestring

Comma-separated optional sections. The only token is freshness, which adds each product's freshness (experimental) and drops the ETag. Tokens are case-insensitive; unknown tokens are silently dropped.

Response

The product.

idstring required

Product id, the product of /v1/point and the MCP dataset_id.

titlestring required

familystring required

Product family, e.g. nbm, mrms, spc.

kindstring required

Data shape: grid (a gridded field over time), snapshot (the latest gridded analysis), feature (vector features such as outlook polygons) or text (text products). New kinds may be added.

product_typestring nullable required

forecast, analysis or climatology; null when the catalog does not classify the product. New values may be added.

domainstring required

Coverage domain, e.g. conus, alaska, hawaii, global.

coveragestring[] required

Domains the product covers.

cadencestring nullable required

Nominal update cadence, an ISO 8601 duration.

horizonstring nullable required

Forecast horizon, an ISO 8601 duration; null for analyses.

stepstring nullable required

Native frame spacing, an ISO 8601 duration: how far apart the product's frames are (PT6H for a 6-hourly model, PT2M for an MRMS mosaic, P1D for a daily product). Set on every grid and snapshot product; null for feature and text products, which have no frames. A sub-day step divides 24 h and a longer one is whole days. A rolling /v1/series forecast window starts at now floored to it from 00:00Z (a step of a day or more floors to UTC midnight), so the frame covering now is in.

temporal_typestring nullable required

How the product is stored in time: now, hourly, daily or climatology. New values may be added.

grid_res_kmnumber double nullable required

Grid spacing in kilometres; null for non-gridded products.

stabilitystring required

Catalog stability of the product, stable, beta or experimental.

cost_classstring required

Cost class of the product's data calls.

entitlementstring nullable required

Entitlement label the product requires; null when none.

agent_descriptionstring nullable required

Plain-language description of what the product answers.

aliasesstring[] required

Search phrases the product answers to.

question_shapesstring[] required

Example questions the product answers.

relatedstring[] required

Ids of related catalog products.

Example response

{
  "id": "nbm_conus",
  "title": "NBM CONUS Surface Variables",
  "family": "nbm",
  "kind": "grid",
  "product_type": "forecast",
  "domain": "conus",
  "coverage": [
    "conus"
  ],
  "cadence": "PT1H",
  "horizon": "PT264H",
  "step": "PT1H",
  "temporal_type": "hourly",
  "grid_res_km": 2.5,
  "stability": "stable",
  "cost_class": "data",
  "source": {
    "id": "nbm",
    "name": "National Blend of Models",
    "provider_id": "noaa",
    "attribution": "Data provided by NOAA/NWS",
    "license": "public_domain",
    "terms_url": "https://www.weather.gov/disclaimer"
  },
  "freshness": {
    "data_age_seconds": 3600
  },
  "variables": [
    {
      "name": "tmp2m",
      "standard_name": "temperature_2m",
      "units": "K",
      "kind": "deterministic",
      "threshold": {
        "op": "lt"
      },
      "period": "PT1H",
      "bands": [
        {
          "code": "SLGT",
          "level": 2,
          "category": "slight",
          "label": "Slight"
        }
      ],
      "point": {
        "unit": "mm"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.