List Search filters and output fields
curl --request GET \
--url https://api.mireye.com/v1/search/fieldsimport requests
url = "https://api.mireye.com/v1/search/fields"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.mireye.com/v1/search/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/search/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/search/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/search/fields")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mireye.com/v1/search/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>",
"filter_ops": [
"<string>"
],
"interpretation_hints": "<string>",
"name": "<string>",
"null_meaning": "<string>",
"nullable": true,
"returnable": true,
"source": "<string>",
"type": "<string>",
"unit": "<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/search/fields
List every Search name with its filter operators, output support, hints and price.
GET
/
v1
/
search
/
fields
List Search filters and output fields
curl --request GET \
--url https://api.mireye.com/v1/search/fieldsimport requests
url = "https://api.mireye.com/v1/search/fields"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.mireye.com/v1/search/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/search/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/search/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/search/fields")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mireye.com/v1/search/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>",
"filter_ops": [
"<string>"
],
"interpretation_hints": "<string>",
"name": "<string>",
"null_meaning": "<string>",
"nullable": true,
"returnable": true,
"source": "<string>",
"type": "<string>",
"unit": "<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/search/fields before building a Search request.
For every name it says which operators the name accepts in filters and whether
it can be named in fields, so an agent can validate a query before paying for it.
An unknown name in a Search request returns 422 search_invalid_filter. Enrich and
Fetch have their own lists: GET /v1/enrich/fields
and GET /v1/meta/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/search/fields
Example response
An excerpt: one filterable name and one output-only name are shown.{
"version": "0.18.0",
"pricing": {
"currency": "USD",
"unit": "query",
"price_usd": "0.20",
"plan_prices_usd": {"build": "0.18", "free": "0.20", "growth": "0.15"},
"charged_when": "Once per completed page, including a valid page with zero matches. Every requested field is included."
},
"fields": [
{
"name": "parcel_boundary_geojson",
"type": "string",
"unit": null,
"description": "Full GeoJSON Polygon/MultiPolygon of the matched parcel (WGS84), encoded as a JSON string.",
"interpretation_hints": "One uniquely intersecting parcel, preserving all polygon parts and holes. No nearest fallback. A multi-parcel site requires separate assembly.",
"null_meaning": "No unique parcel at the point, or the matched record lacks this attribute. Storage or parse failures carry failed status.",
"nullable": true,
"source": "PARCEL_VENDOR",
"filter_ops": [],
"returnable": true
},
{
"name": "pvd_gisacre",
"type": "float",
"unit": "acres",
"description": "Parcel vendor area calculated from parcel boundary",
"interpretation_hints": "Parcel vendor area calculated from parcel boundary",
"null_meaning": null,
"nullable": true,
"source": "PARCEL_VENDOR",
"filter_ops": ["eq", "ne", "lt", "lte", "gt", "gte", "in", "between"],
"returnable": true
}
]
}
Response shape
| Key | Meaning |
|---|---|
version | Response envelope version. |
pricing | Search price: price_usd on Free, plan_prices_usd per plan, and charged_when. |
fields | Every Search name, sorted by name. |
name, type, unit (null when unitless), description,
interpretation_hints, null_meaning (null when not documented), nullable and
source, plus:
filter_ops: operators the name accepts infilters. Text and boolean names takeeq,neandin; numbers and dates also takelt,lte,gt,gteandbetween;geometrytakesintersectsandwithin. An empty list means the name is output-only.returnable: whether the name can be listed in the request’sfields.
state2 filter with eq or in.
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | query_parameter_unknown | The request included a query parameter; this endpoint takes none. |