IGeocodeOptions

Interface

Inheritance: IGeocodeOptionsIEndpointOptions

Properties

Hide inherited properties
PropertyTypeNotes
string
string
string

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.

string
string
credentials
inherited
RequestCredentials

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

endpoint
inherited
string

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

headers
inherited
{ [key: string]: any }

Additional Headers to pass into the request.

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

The HTTP method to send the request with.

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
inherited
number

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

string
"*" | string[]
params
inherited

Additional parameters to pass in the request.

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

string | number
string | number
rawResponse
inherited
boolean

Return the raw response

string

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

signal
inherited
AbortSignal

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

string

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

string
boolean

Suppress any ArcGIS REST JS related warnings for this request.

address

optional
Interface Property
address: string

address2

optional
Interface Property
address2: string

address3

optional
Interface Property
address3: string

authentication

optionalinherited
Interface Property
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
Interface Property
city: string

countryCode

optional
Interface Property
countryCode: string

credentials

optionalinherited
Interface Property
credentials: RequestCredentials

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

endpoint

optionalinherited
Interface Property

headers

optionalinherited
Interface Property
headers: { [key: string]: any }

Additional Headers to pass into the request.

Type declaration
  • [key: string]: any

hideToken

optionalinherited
Interface Property
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

optionalinherited
Interface Property
httpMethod: HTTPMethods

The HTTP method to send the request with.

magicKey

optional
Interface Property
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

optionalinherited
Interface Property
maxUrlLength: number

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

neighborhood

optional
Interface Property
neighborhood: string

outFields

optional
Interface Property
outFields: "*" | string[]

params

optionalinherited
Interface Property
params: IParams

Additional parameters to pass in the request.

portal

optionalinherited
Interface Property
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
Interface Property
postal: string | number

postalExt

optional
Interface Property
postalExt: string | number

rawResponse

optionalinherited
Interface Property
rawResponse: boolean

Return the raw response

region

optional
Interface Property
region: string

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

signal

optionalinherited
Interface Property
signal: AbortSignal

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

singleLine

optional
Interface Property
singleLine: string

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

subregion

optional
Interface Property
subregion: string

suppressWarnings

optionalinherited
Interface Property
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.