bulkGeocode

bulkGeocode

Function
bulkGeocode(requestOptionsIBulkGeocodeOptions): Promise<IBulkGeocodeResponse>

Used to geocode a batch of addresses.

1
2
3
4
5
6
7
8
9
10
11
12
import { bulkGeocode } from '@esri/arcgis-rest-geocoding';
import { ApplicationCredentialsManager } from '@esri/arcgis-rest-request';

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 } }
  });
Parameters
ParameterTypeNotes
requestOptions
IBulkGeocodeOptions

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

Returns 
Promise<IBulkGeocodeResponse>

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.

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close