Skip to content

Search API

The following table describes the parameters returned in a Search Result Object

NameDescription
key
String
the unique identifier for the search result in it's source.
name
String
the name of the result.
resultNumber
Integer
the number of the result through all search results, even paged data.
distance
Double
the distance from the center of the search area.
  • radius - center point
  • rectangle - center of the rectangle
  • polygon - centroid of the polygon
  • corridor - closest point to the result on the line
distanceUnit
String
Specifies the type of units for the distance. Values are:
  • m - Miles
  • k - Kilometers
sourceName
String
The name of the source
  • hosted - the name of the hosted set searched
  • map - the name of the map data layer searched
  • remote - "remote" will always be returned
shapePoints
Geometry
The shape of the remote data object
fields
Field[]
This is a list of key/value pairs from the hosted data source.