List Enrich fields and presets
curl --request GET \
--url https://api.mireye.com/v1/enrich/fieldsimport requests
url = "https://api.mireye.com/v1/enrich/fields"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.mireye.com/v1/enrich/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mireye.com/v1/enrich/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mireye.com/v1/enrich/fields"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mireye.com/v1/enrich/fields")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mireye.com/v1/enrich/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"fields": [
{
"description": "<string>",
"interpretation_hints": "<string>",
"name": "<string>",
"null_meaning": "<string>",
"nullable": true,
"presets": [
"<string>"
],
"source": "<string>",
"type": "<string>",
"unit": "<string>"
}
],
"presets": [
{
"description": "<string>",
"fields": [
"<string>"
],
"name": "<string>"
}
],
"pricing": {
"charged_when": "<string>",
"currency": "USD",
"plan_prices_usd": {},
"price_usd": "<string>",
"unit": "parcel"
},
"version": "<string>"
}{
"detail": {
"error": "query_parameter_unknown",
"message": "Unknown query parameter(s): limit.",
"retryable": false
}
}Discover parcels
GET /v1/enrich/fields
List every Enrich field ID and preset, with types, units, hints and price.
GET
/
v1
/
enrich
/
fields
List Enrich fields and presets
curl --request GET \
--url https://api.mireye.com/v1/enrich/fieldsimport requests
url = "https://api.mireye.com/v1/enrich/fields"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.mireye.com/v1/enrich/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mireye.com/v1/enrich/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mireye.com/v1/enrich/fields"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mireye.com/v1/enrich/fields")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mireye.com/v1/enrich/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"fields": [
{
"description": "<string>",
"interpretation_hints": "<string>",
"name": "<string>",
"null_meaning": "<string>",
"nullable": true,
"presets": [
"<string>"
],
"source": "<string>",
"type": "<string>",
"unit": "<string>"
}
],
"presets": [
{
"description": "<string>",
"fields": [
"<string>"
],
"name": "<string>"
}
],
"pricing": {
"charged_when": "<string>",
"currency": "USD",
"plan_prices_usd": {},
"price_usd": "<string>",
"unit": "parcel"
},
"version": "<string>"
}{
"detail": {
"error": "query_parameter_unknown",
"message": "Unknown query parameter(s): limit.",
"retryable": false
}
}When to use this
Read/v1/enrich/fields before calling Enrich to pick a
small fields or preset selection instead of requesting every field. It lists
each field ID Enrich accepts, the presets that bundle them, and the Enrich price.
Agents can use it to validate field names before sending a paid request. Fetch and
Search have their own lists: GET /v1/meta/fields and
GET /v1/search/fields.
No authentication is required and the call is free. The response carries an ETag
and Cache-Control: public, max-age=3600. Send If-None-Match with the last ETag
to receive 304 Not Modified when nothing changed.
Request shape
GET with no body and no query parameters.
curl https://api.mireye.com/v1/enrich/fields
Example response
An excerpt: one preset and one field are shown.{
"version": "0.18.0",
"pricing": {
"currency": "USD",
"unit": "parcel",
"price_usd": "0.02",
"plan_prices_usd": {"build": "0.018", "free": "0.02", "growth": "0.015"},
"charged_when": "Once per matched parcel, only when at least one requested field is returned. No-match, ambiguous, unavailable and empty results are free."
},
"presets": [
{
"name": "legal",
"description": "Legal description, plat, book/page, block, lot, subdivision and PLSS location.",
"fields": ["plss_township", "plss_section", "plss_range", "legaldesc", "plat", "book", "page", "block", "lot", "subdivision"]
}
],
"fields": [
{
"name": "slope_degrees",
"type": "float",
"unit": "degrees",
"description": "Surface slope in degrees, computed from the USGS 3DEP DEM at the queried point. 0 = flat; 90 = vertical.",
"interpretation_hints": "Slope >15° materially raises wildfire spread risk on forested land. Slope >25° complicates conventional construction. Combine with lcms_class and dist_to_wui_m for wildfire underwriting.",
"null_meaning": null,
"nullable": false,
"source": "USGS_3DEP",
"presets": ["terrain"]
}
]
}
Response shape
| Key | Meaning |
|---|---|
version | Response envelope version. |
pricing | Enrich price: price_usd on Free, plan_prices_usd per plan, and charged_when. |
presets | Presets in response order, each with name, description and its exact fields. |
fields | Every field ID, in catalog order. |
name, type, unit (null when unitless), description,
interpretation_hints, null_meaning (null when not documented), nullable,
source (the public source ID returned with values) and presets. Pass name
values in the Enrich fields list and preset names in preset.
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | query_parameter_unknown | The request included a query parameter; this endpoint takes none. |