Mireye

/api-reference/field-catalog

Field catalog

Full reference of every field exposed by /v1/fetch and /v1/ask.

​ 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

​ Cache TTLs

​ Data licensing & attribution

  • 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.
  • 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

  • Append a FieldSpec to FIELDS.
  • Ensure the attribute_path resolves on the relevant layer response and terminates at a Field_[T] wrapper.
  • If the field should be planner-discoverable for a common question pattern, add an interpretation_hints line.
  • Bump SCHEMA_VERSION per the versioning policy.