bulkGeocode

Function
import { bulkGeocode } from '@esri/arcgis-rest-geocoding';
import { ApplicationSession } from '@esri/arcgis-rest-auth';
//
const addresses = [
  { "OBJECTID": 1, "SingleLine": "380 New York Street 92373" },
  { "OBJECTID": 2, "SingleLine": "1 World Way Los Angeles 90045" }
];
//
bulkGeocode({ addresses, authentication: session })
  .then((response) => {
    response.locations[0].location; // => { x: -117, y: 34, spatialReference: { wkid: 4326 } }
  });

Used to geocode a batch of addresses.

Parameters

Parameter Type Default Notes
requestOptions Required IBulkGeocodeOptions

Request options to pass to the geocoder, including an array of addresses and authentication session.

Available requestOptions

Property Type Notes
addresses IAddressBulk[] | IAddressBulk
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

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.

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 '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. The spatial reference will be added to address locations unless rawResponse: true was passed.

Property Type Notes
locations Array<{
address:
string
attributes:
object
location:
IPoint
score:
number
}>
spatialReference ISpatialReference

Function defined in packages/arcgis-rest-geocoding/src/bulk.ts:64