API and agentsAPI reference
SearchResults
object
The grouped map-search answer. places is present only when asked for, refusedLayers only when a layer's values were refused.
layersarrayrequiredVisible layers whose names match.
(each item)objectlayerIdstringrequirednamestringrequiredvizstringrequiredThe layer's visualization type.
valuesarrayrequiredMatching features, one row each, at most 20. Point features carry
point; lines and polygons carry an interioranchorandbounds[minLng, minLat, maxLng, maxLat].(each item)objectlayerIdstringrequiredlayerNamestringrequiredfieldstringrequiredvaluestringrequiredpointarray of numberanchorarray of numberboundsarray of number
refusedLayersarrayVisible layers whose matching values were refused: one of them is longer than 2,097,152 bytes (2 MiB) as a JSON string, the ceiling for one value. Such a layer answers no value rows; the others answer as usual. Each entry carries the error and errorCode a failed widget carries (query_result_too_large). Other layer failures contribute nothing and are not listed.
(each item)objectlayerIdstringrequiredlayerNamestringrequirederrorstringrequirederrorCodestringrequiredOne of the documented error codes.
coordinatesarrayrequiredEvery plausible reading of a pasted decimal pair — both when both are valid.
(each item)objectreadingstringrequiredOne of
latlon,lonlatlatnumberrequiredlngnumberrequired
placesobjectThe places group's answer:
okwith results and the provider's attribution,unconfigured, orfailedwith a sanitized message (never the provider URL).statestringrequiredOne of
ok,unconfigured,failedattributionstringor nullmessagestringresultsarray(each item)objectnamestringrequiredcontextstringor nulllngnumberrequiredlatnumberrequiredboundsarray of number
7439201b