This documentation is for ArcGIS REST JS 3.x which is no longer maintained. For the latest 4.x documentation see ArcGIS REST JS on the ArcGIS Developer website.

IGeocodeOptions

Interface

Extends

Properties

Property Type Notes
address Optional string
address2 Optional string
address3 Optional string
city Optional string
countryCode Optional string
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-geocoding';
suggest("LAX")
  .then((response) => {
    geocode({
      singleLine: response.suggestions[1].text,
      magicKey: response.suggestions[0].magicKey
    })
  })
neighborhood Optional string
outFields Optional "*" | string[] | string
postal Optional number
postalExt Optional number
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
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

credentials Optional Inherited RequestCredentials

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

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 [key: string]: any

Additional Headers to pass into the request.

hideToken Optional Inherited boolean

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.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

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

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 authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response


Interface defined in packages/arcgis-rest-geocoding/src/geocode.ts:16