IGeocodeOptions

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

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

Additional Headers to pass into the request.

Type declaration

• [key: string]: any

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

The HTTP method to send the request with.

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.

1
2
3
4
5
6
7
8
9
import { suggest, geocode } from '@esri/arcgis-rest-geocoding';

suggest("LAX")
  .then((response) => {
    geocode({
      singleLine: response.suggestions[1].text,
      magicKey: response.suggestions[0].magicKey
    })
  })

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

Additional parameters to pass in the request.

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

Return the raw response

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

An AbortSignal object instance; allows you to abort a request and via an AbortController.

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

Suppress any ArcGIS REST JS related warnings for this request.