Contents

GeoRequest

A single geo entity lookup criterion used in a geo location search request.

Declaration

object GeoRequest

Properties

NameTypeDescription
idstring

Numeric string geo location identifier (geo_location_id). Cannot be provided together with legacyId. Works for any entity type. One of id or legacyId is required.

legacyIdstring

Pipe-delimited geo code encoding the hierarchy, such as US|CA|San Francisco or US|TX|78238. Cannot be provided together with id. Works for any entity type. One of id or legacyId is required.

entity RequiredGeoEntityType

Geo entity type. Values: AdminArea, Country, Locality, PostalCode.

Discussion

The GeoRequest object specifies a single geographic entity to look up within a GeoSearchPostRequest. Both identifiers work for any entity type. Use whichever you already have. Search results return both so you can switch between them freely.

To batch-resolve geo entity eligibility in one call, use multiple GeoRequest objects in a single GeoSearchPostRequest.

Example

{
  "id": "123456789",
  "entity": "Locality"
}

See Also