ArcGIS REST JS
ArcGIS REST API JavaScript Client

getGeocodeService

Function

Used to fetch metadata from a geocoding service.

import { getGeocoderServiceInfo } from '@esri/arcgis-rest-geocoding';

getGeocoderServiceInfo()
  .then((response) => {
    response.serviceDescription; // => 'World Geocoder'
  });

Parameters

Parameter Type Default Notes
requestOptions Optional IEndpointOptions

Request options can contain a custom geocoding service to fetch metadata from.

Available requestOptions

Property Type Notes
endpoint Optional string

Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )
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.
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

Returns

A Promise that will resolve with the data from the response.

Promise<IGetGeocodeServiceResponse>
Property Type Notes
addressFields any[] | any
capabilities string
countries string[] | string
currentVersion number
serviceDescription string
Function defined in packages/arcgis-rest-geocoding/src/helpers.ts:43