smarterweather-com · Schema

CatalogProduct

A data catalog product with its variables and retrieval fields (`GET /v1/catalog/{product_id}`).

CompanyWeatherDataForecastingClimate

Properties

Name Type Description
id string Product id, the `product` of `/v1/point` and the MCP `dataset_id`.
title string
family string Product family, e.g. `nbm`, `mrms`, `spc`.
kind string 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_type stringnull `forecast`, `analysis` or `climatology`; `null` when the catalog does not classify the product. New values may be added.
domain string Coverage domain, e.g. `conus`, `alaska`, `hawaii`, `global`.
coverage array Domains the product covers.
cadence stringnull Nominal update cadence, an ISO 8601 duration.
horizon stringnull Forecast horizon, an ISO 8601 duration; `null` for analyses.
step stringnull 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 `snapsho
temporal_type stringnull How the product is stored in time: `now`, `hourly`, `daily` or `climatology`. New values may be added.
grid_res_km numbernull Grid spacing in kilometres; `null` for non-gridded products.
stability string Catalog stability of the product, `stable`, `beta` or `experimental`.
cost_class string Cost class of the product's data calls.
entitlement stringnull Entitlement label the product requires; `null` when none.
source object
freshness object **Experimental** (`x-stability: experimental`). Present only with `include=freshness`. `null` when the platform has neither a freshness check nor a model run for the product, or when freshness has bee
agent_description stringnull Plain-language description of what the product answers.
aliases array Search phrases the product answers to.
question_shapes array Example questions the product answers.
related array Ids of related catalog products.
time object
query object
role object The product's role in its domain; `null` when it has none.
properties_schema objectnull Feature and text products: each property's type and aggregate rule, keyed by property name; `null` for gridded products.
table_store object A table-backed reference layer's store; `null` otherwise.
quality object
variables array
View JSON Schema on GitHub

JSON Schema

smarterweather-com-catalog-product-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/smarterweather-com/json-schema/smarterweather-com-catalog-product-schema.json",
  "title": "CatalogProduct",
  "description": "A data catalog product with its variables and retrieval fields\n(`GET /v1/catalog/{product_id}`).\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/smarterweather-com-meta-api-openapi.yml#/components/schemas/CatalogProduct",
  "allOf": [
    {
      "$ref": "#/$defs/CatalogProductSummary"
    },
    {
      "type": "object",
      "required": [
        "agent_description",
        "aliases",
        "question_shapes",
        "related",
        "time",
        "query",
        "role",
        "properties_schema",
        "table_store",
        "quality",
        "variables"
      ],
      "properties": {
        "agent_description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Plain-language description of what the product answers."
        },
        "aliases": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Search phrases the product answers to."
        },
        "question_shapes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Example questions the product answers."
        },
        "related": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Ids of related catalog products."
        },
        "time": {
          "$ref": "#/$defs/CatalogTime"
        },
        "query": {
          "$ref": "#/$defs/CatalogQuery"
        },
        "role": {
          "description": "The product's role in its domain; `null` when it has none.",
          "oneOf": [
            {
              "$ref": "#/$defs/CatalogRole"
            },
            {
              "type": "null"
            }
          ]
        },
        "properties_schema": {
          "type": [
            "object",
            "null"
          ],
          "description": "Feature and text products: each property's type and aggregate\nrule, keyed by property name; `null` for gridded products.\n",
          "additionalProperties": {
            "$ref": "#/$defs/CatalogProperty"
          }
        },
        "table_store": {
          "description": "A table-backed reference layer's store; `null` otherwise.",
          "oneOf": [
            {
              "$ref": "#/$defs/CatalogTableStore"
            },
            {
              "type": "null"
            }
          ]
        },
        "quality": {
          "$ref": "#/$defs/CatalogQuality"
        },
        "variables": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CatalogVariable"
          }
        }
      }
    }
  ],
  "$defs": {
    "CatalogCredit": {
      "type": "object",
      "description": "One upstream publisher a product credits, with its licence terms.",
      "required": [
        "provider_id",
        "name",
        "attribution",
        "license",
        "terms_url"
      ],
      "properties": {
        "provider_id": {
          "type": "string"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "attribution": {
          "type": "string"
        },
        "license": {
          "type": "string",
          "description": "Licence token: `public_domain`, `cc_by_4`, `cdla_permissive_2`,\n`odbl_1` or `internal`. New values may be added.\n"
        },
        "terms_url": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "CatalogFreshness": {
      "type": "object",
      "x-stability": "experimental",
      "description": "**Experimental** (`x-stability: experimental`). How current a\nproduct's data is, as the MCP `list_datasets` tool reports it. The\nshape is final; the values' sources are still being completed:\nfreshness checks cover a fixed set of products today, so some\nproducts (for example untracked analyses) have `freshness: null`\nand an untracked forecast has a `latest_run` but no\n`freshness_status`. Values are refreshed at most once a minute;\nwhile the freshness source is unavailable the last values are kept\nfor up to 5 minutes (`data_age_seconds` is computed when the response\nis made, so it still shows how old the data is), then `freshness` is\n`null`.\n",
      "required": [
        "data_age_seconds"
      ],
      "properties": {
        "freshness_status": {
          "type": "string",
          "enum": [
            "fresh",
            "stale",
            "missing"
          ],
          "description": "The platform's freshness check for the product: `fresh` within\nits expected age, `stale` older, `missing` no data found. When\na product is checked in more than one store, the stalest\nresult. Absent when the product is not checked.\n"
        },
        "latest_time": {
          "type": "string",
          "format": "date-time",
          "description": "Valid time of the newest data the freshness check found."
        },
        "latest_run": {
          "type": "string",
          "format": "date-time",
          "description": "Reference time of the latest model run served (forecasts only)."
        },
        "data_age_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Age of the newest data in seconds: from `latest_run` for a\nforecast, else from `latest_time`. `null` when unknown or when\nthe time is in the future (a forecast valid time says nothing\nabout age).\n"
        }
      }
    },
    "CatalogProductSummary": {
      "type": "object",
      "description": "A data catalog product, as listed by `GET /v1/catalog`.",
      "required": [
        "id",
        "title",
        "family",
        "kind",
        "product_type",
        "domain",
        "coverage",
        "cadence",
        "horizon",
        "step",
        "temporal_type",
        "grid_res_km",
        "stability",
        "cost_class",
        "entitlement",
        "source"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Product id, the `product` of `/v1/point` and the MCP `dataset_id`."
        },
        "title": {
          "type": "string"
        },
        "family": {
          "type": "string",
          "description": "Product family, e.g. `nbm`, `mrms`, `spc`."
        },
        "kind": {
          "type": "string",
          "description": "Data shape: `grid` (a gridded field over time), `snapshot` (the\nlatest gridded analysis), `feature` (vector features such as\noutlook polygons) or `text` (text products). New kinds may be\nadded.\n"
        },
        "product_type": {
          "type": [
            "string",
            "null"
          ],
          "description": "`forecast`, `analysis` or `climatology`; `null` when the catalog\ndoes not classify the product. New values may be added.\n"
        },
        "domain": {
          "type": "string",
          "description": "Coverage domain, e.g. `conus`, `alaska`, `hawaii`, `global`."
        },
        "coverage": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Domains the product covers."
        },
        "cadence": {
          "type": [
            "string",
            "null"
          ],
          "description": "Nominal update cadence, an ISO 8601 duration."
        },
        "horizon": {
          "type": [
            "string",
            "null"
          ],
          "description": "Forecast horizon, an ISO 8601 duration; `null` for analyses."
        },
        "step": {
          "type": [
            "string",
            "null"
          ],
          "description": "Native frame spacing, an ISO 8601 duration: how far apart the\nproduct's frames are (`PT6H` for a 6-hourly model, `PT2M` for an\nMRMS mosaic, `P1D` for a daily product). Set on every `grid` and\n`snapshot` product; `null` for `feature` and `text` products,\nwhich have no frames. A sub-day step divides 24 h and a longer\none is whole days. A rolling `/v1/series` forecast window starts\nat now floored to it from 00:00Z (a step of a day or more floors\nto UTC midnight), so the frame covering now is in.\n"
        },
        "temporal_type": {
          "type": [
            "string",
            "null"
          ],
          "description": "How the product is stored in time: `now`, `hourly`, `daily` or\n`climatology`. New values may be added.\n"
        },
        "grid_res_km": {
          "type": [
            "number",
            "null"
          ],
          "format": "double",
          "description": "Grid spacing in kilometres; `null` for non-gridded products."
        },
        "stability": {
          "type": "string",
          "description": "Catalog stability of the product, `stable`, `beta` or `experimental`."
        },
        "cost_class": {
          "type": "string",
          "description": "Cost class of the product's data calls."
        },
        "entitlement": {
          "type": [
            "string",
            "null"
          ],
          "description": "Entitlement label the product requires; `null` when none."
        },
        "source": {
          "$ref": "#/$defs/CatalogSource"
        },
        "freshness": {
          "description": "**Experimental** (`x-stability: experimental`). Present only with\n`include=freshness`. `null` when the platform has neither a\nfreshness check nor a model run for the product, or when\nfreshness has been unavailable for more than 5 minutes (the\ncatalog still answers).\n",
          "x-stability": "experimental",
          "oneOf": [
            {
              "$ref": "#/$defs/CatalogFreshness"
            },
            {
              "type": "null"
            }
          ]
        }
      }
    },
    "CatalogProperty": {
      "type": "object",
      "description": "One feature property and how it aggregates under an area.",
      "required": [
        "type",
        "aggregate"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "`integer`, `number`, `string`, `boolean`, `array` or `object`."
        },
        "aggregate": {
          "type": "string",
          "description": "`centroid_in` (sum over the features whose centroid is inside),\n`area_weighted` (sum weighted by the overlapped fraction),\n`precomputed` (each feature already holds its total: sum the\nfeatures), `count_by` (count features per value) or `none`. New\nvalues may be added.\n"
        },
        "description": {
          "type": "string"
        },
        "units": {
          "type": [
            "string",
            "null"
          ]
        },
        "enum": {
          "type": "array",
          "items": {}
        },
        "filterable": {
          "type": "boolean",
          "description": "Whether a data-query filter may select on this property."
        },
        "filter_ops": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Operators a filter on this property accepts: `eq`, `ne`, `gt`,\n`ge`, `lt`, `le`, `in`. New values may be added.\n"
        },
        "partition_by": {
          "type": "string",
          "description": "The property a sum of this one is additive within: features with\ndifferent values of it overlap (zone types), so a sum needs a\nfilter on it.\n"
        }
      }
    },
    "CatalogQuality": {
      "type": "object",
      "description": "Caveats to read before using the product.",
      "required": [
        "caveats"
      ],
      "properties": {
        "caveats": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "CatalogQuery": {
      "type": "object",
      "description": "The data-query words the product supports: query shapes (OGC API EDR\nnames), time words, reducers and filters. New values may be added to\neach list.\n",
      "required": [
        "shapes",
        "time_words",
        "reducers",
        "filters",
        "where",
        "area_as_reference",
        "max_cells",
        "max_locations"
      ],
      "properties": {
        "shapes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "`position`, `locations`, `bbox`, `area`, `path`, `nearest`,\n`items`.\n"
        },
        "time_words": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "`hours`, `start_end`, `at`, `run`."
        },
        "reducers": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "`sum`, `max`, `min`, `mean`, `count_above`, `count_below`,\n`percentile`, `degree_days`, `cumulative`, `count`, `count_by`.\n"
        },
        "filters": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The product's filterable properties (see `properties_schema`)."
        },
        "where": {
          "type": "boolean",
          "description": "Whether criteria and window search apply (a numeric series)."
        },
        "area_as_reference": {
          "type": "boolean",
          "description": "Whether the product's features can be referenced as an area."
        },
        "max_cells": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Zonal-statistics cell cap per element; `null` for non-gridded products."
        },
        "max_locations": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Places per request; `null` when not applicable."
        }
      }
    },
    "CatalogRole": {
      "type": "object",
      "description": "The product's role in its domain: the standard names it is the\nproduct of record for, their observed counterparts and alternates,\nand the domain's native accumulation products.\n",
      "required": [
        "default_for",
        "observed_counterpart",
        "accumulations",
        "alternates"
      ],
      "properties": {
        "default_for": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "observed_counterpart": {
          "type": "object",
          "description": "standard_name -> the domain's observed product of record.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "accumulations": {
          "type": "object",
          "description": "ISO 8601 duration -> the native accumulation product.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "alternates": {
          "type": "object",
          "description": "standard_name -> other forecast products of the domain that serve it.",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "CatalogSource": {
      "type": "object",
      "description": "The product's data source and attribution terms.",
      "required": [
        "id",
        "name",
        "provider_id",
        "attribution",
        "license",
        "terms_url",
        "credits"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "provider_id": {
          "type": "string"
        },
        "attribution": {
          "type": "string",
          "description": "Attribution text to display with the data."
        },
        "license": {
          "type": "string"
        },
        "terms_url": {
          "type": [
            "string",
            "null"
          ]
        },
        "credits": {
          "type": "array",
          "description": "Every upstream the product credits, one element each; the fields\nabove equal the first. Display each element's `attribution`.\n",
          "items": {
            "$ref": "#/$defs/CatalogCredit"
          }
        }
      }
    },
    "CatalogTableStore": {
      "type": "object",
      "description": "A table-backed reference layer's store: the property holding each\nfeature's portable id, how often the table is refreshed and its\nsource vintage.\n",
      "required": [
        "type",
        "id_property",
        "id_format",
        "refresh",
        "vintage"
      ],
      "properties": {
        "type": {
          "type": "string"
        },
        "id_property": {
          "type": "string"
        },
        "id_format": {
          "type": "string",
          "description": "How a feature id is spelled from the id columns: `{geoid}`, or\n`{zone_type}/{zone_id}` for a composite id (`fire/COZ214`). The\nvalue an area reference's `feature_id` takes.\n"
        },
        "refresh": {
          "type": "string"
        },
        "vintage": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "CatalogTime": {
      "type": "object",
      "description": "The product's time semantics.",
      "required": [
        "axis",
        "direction",
        "step",
        "horizon",
        "cadence",
        "latency",
        "history"
      ],
      "properties": {
        "axis": {
          "type": "string",
          "description": "What the product's frames are indexed by: `valid` (valid time),\n`issue` (issue time), `both`, `none` (a time-free reference\nlayer) or `day_of_year` (a climatology). New values may be added.\n"
        },
        "direction": {
          "type": "string",
          "description": "`forward` (the data looks ahead), `back` (it looks back) or\n`none`. New values may be added.\n"
        },
        "step": {
          "type": [
            "string",
            "null"
          ],
          "description": "Native frame spacing, an ISO 8601 duration (the product's `step`)."
        },
        "horizon": {
          "type": [
            "string",
            "null"
          ],
          "description": "Forecast horizon, an ISO 8601 duration (the product's `horizon`)."
        },
        "cadence": {
          "type": [
            "string",
            "null"
          ],
          "description": "Update cadence, an ISO 8601 duration (the product's `cadence`)."
        },
        "latency": {
          "type": [
            "string",
            "null"
          ],
          "description": "Typical delay from valid or issue time to availability, an ISO 8601 duration; `null` when not stated."
        },
        "history": {
          "type": [
            "string",
            "null"
          ],
          "description": "How far back the product can be read, an ISO 8601 duration; `null` when not stated."
        }
      }
    },
    "CatalogVariable": {
      "type": "object",
      "description": "One variable of a catalog product.",
      "required": [
        "name",
        "standard_name",
        "label",
        "description",
        "units",
        "display_units",
        "kind",
        "threshold",
        "period",
        "min",
        "max",
        "aliases",
        "categories",
        "bands",
        "cell_methods",
        "level",
        "encoding",
        "point"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Stored variable name, as the data files name it; accepted as an\nalias of `standard_name` on `/v1/point` and `/v1/series`.\n"
        },
        "standard_name": {
          "type": "string",
          "description": "Standard variable name, the public identifier on every door: the\n`var` of `/v1/point` and `/v1/series`, the MCP `query_dataset`\n`variables`, and the key of every `values` and `units` map.\n"
        },
        "label": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "units": {
          "type": [
            "string",
            "null"
          ],
          "description": "Units of the stored values, in the catalog unit vocabulary\n(assets/data-catalog/README.md).\n"
        },
        "display_units": {
          "type": "object",
          "required": [
            "conversion",
            "metric",
            "imperial"
          ],
          "properties": {
            "conversion": {
              "type": "string",
              "description": "`absolute` for a value, `delta` for a difference (converted\nwithout an offset). New values may be added.\n"
            },
            "metric": {
              "type": [
                "string",
                "null"
              ]
            },
            "imperial": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        },
        "kind": {
          "type": "string",
          "description": "`deterministic`, `probability`, `percentile`, `stddev` or\n`category`. New values may be added.\n"
        },
        "threshold": {
          "description": "The event a probability variable measures; `null` otherwise.",
          "oneOf": [
            {
              "type": "object",
              "required": [
                "op",
                "value",
                "units"
              ],
              "properties": {
                "op": {
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double"
                },
                "units": {
                  "type": "string"
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "period": {
          "type": [
            "string",
            "null"
          ],
          "description": "Accumulation or aggregation period, an ISO 8601 duration."
        },
        "min": {
          "type": [
            "number",
            "null"
          ],
          "format": "double",
          "description": "Lower bound of valid values, in `units`."
        },
        "max": {
          "type": [
            "number",
            "null"
          ],
          "format": "double",
          "description": "Upper bound of valid values, in `units`."
        },
        "aliases": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "categories": {
          "type": "array",
          "description": "Value buckets in ascending `max` order; the last bucket has\n`max: null` (the catch-all). A value takes the label of the first\nbucket whose `max` is greater than or equal to it, or the\ncatch-all's label when it exceeds every `max`.\n",
          "items": {
            "type": "object",
            "required": [
              "max",
              "label"
            ],
            "properties": {
              "max": {
                "type": [
                  "number",
                  "null"
                ],
                "format": "double"
              },
              "label": {
                "type": "string"
              }
            }
          }
        },
        "bands": {
          "type": "array",
          "description": "Categorical codes and their public levels (outlook risk bands).",
          "items": {
            "type": "object",
            "required": [
              "code",
              "level",
              "category",
              "label"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "level": {
                "type": "integer"
              },
              "category": {
                "type": "string"
              },
              "label": {
                "type": "string"
              }
            }
          }
        },
        "cell_methods": {
          "type": [
            "object",
            "null"
          ],
          "description": "How the value is reduced over time (CF cell_methods), e.g.\n`{\"time\": \"maximum\"}`; `null` when not stated.\n",
          "additionalProperties": {
            "type": "string"
          }
        },
        "level": {
          "description": "The variable's vertical level; `null` when not stated.",
          "oneOf": [
            {
              "type": "object",
              "required": [
                "type",
                "value",
                "units"
              ],
              "properties": {
                "type": {
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double"
                },
                "units": {
                  "type": "string"
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "encoding": {
          "description": "A raw variable's encoding: a sentinel value and its meaning, and\nthe base its values count from (`utc_midnight_seconds`); `null`\nwhen the value is not encoded.\n",
          "oneOf": [
            {
              "type": "object",
              "required": [
                "sentinel",
                "meaning",
                "unit_base"
              ],
              "properties": {
                "sentinel": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "meaning": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "unit_base": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "point": {
          "description": "How `/v1/point` serves the variable: the `unit` it reports\n(`null` for a categorical zone). `null` when `/v1/point` does not\nserve the variable.\n",
          "oneOf": [
            {
              "type": "object",
              "required": [
                "unit"
              ],
              "properties": {
                "unit": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            },
            {
              "type": "null"
            }
          ]
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/smarterweather-com-catalog-product"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.