IGeocodeRequestOptions

Interface

Extends

Properties

Property Type Notes
address Optional string
address2 Optional string
address3 Optional string
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

city Optional string
countryCode Optional string
endpoint Optional Inherited string

Any ArcGIS Geocoding service (example: http://sampleserver6.arcgisonline.com/arcgis/rest/services/Locators/SanDiego/GeocodeServer )

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

magicKey Optional string

You can create an autocomplete experience by making a call to suggest with partial text and then passing through the magicKey and complete address that are returned to geocode.

import { suggest, geocode } from '@esri/arcgis-rest-geocoder';
suggest("LAX")
  .then((response) => {
    geocode({
      singleLine: response.suggestions[1].text,
      magicKey: response.suggestions[0].magicKey
    })
  })
maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

neighborhood Optional string
params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to 'https://www.arcgis.com/sharing/rest'.

postal Optional number
postalExt Optional number
rawResponse Optional Inherited boolean

Return the raw response

region Optional string

The World Geocoding Service expects US states to be passed in as a 'region'.

singleLine Optional string

use this if all your address info is contained in a single string.

subregion Optional string

Interface defined in packages/arcgis-rest-geocoder/src/geocode.ts:18