Skip to main content
The catalog is the source of truth for every field name, unit, source, and preset assignment. The live, machine-readable version is at GET /v1/meta/fields; this page renders the same data for human browsing. Schema version: 0.14.0296 fields across 7 layers.

How to read this table

  • Name — the catalog field name you pass to /v1/fetch.
  • Layer — one of terrain, land_cover, built_environment, utilities, parcels. Mireye fetches each layer in parallel; fields in the same layer share a fetch round-trip.
  • Type — JSON type returned in the value field (float, int, bool, string).
  • Unit — SI unit, or for enums / booleans / strings.
  • Source — canonical short name of the federal source.
  • Description — what the value represents.
  • Presets — which preset bundles include this field.

All fields

Gated fields

Some recently registered fields (mostly in the climate, hazards, and the newest utilities/parcels additions) are catalog-listed but gated: their bulk datasets are not yet ingested, so they return honest provenance nulls with a notes string explaining the gap instead of fabricated values. They become live per-source as datasets are bootstrapped; nothing about the request shape changes when they do.

Cache TTLs

Each field carries a ttl_seconds hint in /v1/fetch responses reflecting how often the upstream source changes: These are recommendations for downstream caches, not commitments. The underlying values may be updated more or less frequently than the hint suggests — fetched_at is the authoritative “as-of” timestamp.

Data licensing & attribution

Most fields derive from US-government public-domain sources. The open-data sources below additionally require attribution, which we pass through here:
  • Overture Maps Foundation (© Overture Maps Foundation) — theme licenses differ, matching each source’s declared spdx:
    • OVERTURE_PLACES — licensed CDLA-Permissive-2.0 (permissive).
    • OVERTURE_BUILDINGS, OVERTURE_TRANSPORTATION, OVERTURE_DIVISIONS — derived from OpenStreetMap (divisions also from geoBoundaries) and licensed under the Open Database License (ODbL), a share-alike + attribution license. Honor attribution and share-alike obligations when redistributing values derived from these themes.
  • Foursquare OS Places — the Overture places theme (POI-context fields such as nearest_hospital_distance_m and poi_count_1km) includes data from the Foursquare Open Source Places dataset, made available by Foursquare Labs, Inc. under the Apache License, Version 2.0, alongside Meta and Microsoft place data under CDLA-Permissive-2.0. Each place record’s per-source license is carried in Overture’s sources column.

Adding fields

The catalog lives in src/mireye_earth/ask/catalog.py. A new field requires:
  1. Append a FieldSpec to FIELDS.
  2. Ensure the attribute_path resolves on the relevant layer response and terminates at a Field_[T] wrapper.
  3. If the field should be planner-discoverable for a common question pattern, add an interpretation_hints line.
  4. Bump SCHEMA_VERSION per the versioning policy.
Field additions are minor-version bumps (additive, backwards-compatible) and do not require client changes.