IGeocodeOptions

Interface

Inheritance: IGeocodeOptionsIEndpointOptions

Properties

PropertyTypeNotes
address
 optional 
string
address2
 optional 
string
address3
 optional 
string
authentication
 optional 

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.

city
 optional 
string
countryCode
 optional 
string
credentials
 optional 
RequestCredentials

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

endpoint
 optional 
string

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

headers
 optional 
{ [key: string]: any }

Additional Headers to pass into the request.

hideToken
 optional 
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 

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.

maxUrlLength
 optional 
number

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

neighborhood
 optional 
string
outFields
 optional 
"*" | string[]
params
 optional 

Additional parameters to pass in the request.

portal
 optional 
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'.

postal
 optional 
number
postalExt
 optional 
number
rawResponse
 optional 
boolean

Return the raw response

region
 optional 
string

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

signal
 optional 
AbortSignal

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

singleLine
 optional 
string

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

subregion
 optional 
string
suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

address optional

address: string

address2 optional

address2: string

address3 optional

address3: string

authentication optional

authentication: string | IAuthenticationManager

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.

city optional

city: string

countryCode optional

countryCode: string

credentials optional

credentials: RequestCredentials

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

endpoint optional

headers optional

headers: { [key: string]: any }

Additional Headers to pass into the request.

hideToken optional

hideToken: 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

httpMethod: HTTPMethods

The HTTP method to send the request with.

magicKey optional

magicKey: 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.

Use dark colors for code blocksCopy
         
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
    })
  })

maxUrlLength optional

maxUrlLength: number

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

neighborhood optional

neighborhood: string

outFields optional

outFields: "*" | string[]

params optional

params: IParams

Additional parameters to pass in the request.

portal optional

portal: 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'.

postal optional

postal: number

postalExt optional

postalExt: number

rawResponse optional

rawResponse: boolean

Return the raw response

region optional

region: string

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

signal optional

signal: AbortSignal

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

singleLine optional

singleLine: string

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

subregion optional

subregion: string

suppressWarnings optional

suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.