The geocoding service can find addresses, businesses, and places around the world. Address text can be converted to location candidates (forward geocoding) and a location can be converted to an address (reverse geocoding). The service provides suggested address candidates for partial address text and place name search. Many addresses can also be geocoded at one time with batch geocoding.
Places, addresses, and businesses found using the geocoding service
Key features Geocode addresses and find places around the world. Filter place search by category type. Return candidates in different languages and locales. Return candidates in a different spatial reference. Refine search by location, extent, city, and country code. Return specific data fields for each candidate. Limit the number of candidates returned. Find a rooftop or street location for Point candidates. Specify the type of city name or street name to be included in output fields. How the geocoding service works The geocoding service performs a number of operations:
Address geocoding : get a location from an address.Place geocoding : get a location from a place name.Reverse geocoding : get an address or place name from a location .Autosuggest : get likely complete search strings for a partial address or place name.Batch geocoding : get locations from a set of addresses.The results from geocoding operations can be used dynamically in-memory (not-stored) or persisted for future use (stored). To learn more about storing results, see Storage parameter .
Service URLs Standard endpoint Enhanced endpoint
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/<request>?<parameters>
Use dark colors for code blocks Copy
1
https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/<request>?<parameters>
Learn more about standard and enhanced endpoints in Service endpoints .
Required parameters Name Description Examples fThe format of the data returned. f=json f=pjsontokenAn API key or OAuth 2.0 access token . Learn how to get an access token in Security and authentication . token=< token=<
Storage parameter If you need to store or persist the geocoding service results in any way, you are required to use the for
Name Description Example forSpecifies whether the results of the operation will be persisted. for
Address geocoding To geocode an address, use the find operation.
This returns a JSON structure containing an array of address candidates. Each candidate includes a:
score (between 0-100)complete address point location coverage extent set of attributes URL Request Standard endpoint Enhanced endpoint
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?address={searchText}&outFields={fieldList}&f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?address={searchText}&outFields={fieldList}&f=json&token=<ACCESS_TOKEN>
Learn more about standard and enhanced endpoints in Service endpoints .
Key parameters address or singlelineThe address text to search for.
If the address parameter is the only search text parameter specified, it is equivalent to singleline.
If additional search text parameters are specified (such as neighborhood, city, or country), then address is treated as the first part of a multi-parameter search and singleline is ignored. For a complete list of search text parameters, see the address property of the service metadata JSON.
out (optional)A list of attributes to return for each result candidate. If not specified, no attributes are returned.
Use * to return all attributes.
Other parameters There are many other parameters that can be used to improve and modify geocode results.
Some commonly used parameters are:
max: Limit the number of candidates returned.out: The spatial reference for the location and extent. If not specified, they are returned in WGS84.location: Candidate scores will be weighted to prefer results closer to this location.search: Limit search results to a geographic extent. Candidates outside this extent will not be returned.location: Specify whether the location is the candidate's rooftop or a street location suitable for driving directions.for: Specifies whether the results of the operation will be persisted.Example Get the top result Get the best match for 10 Downing Street, London by also specifying to return at most 1 result candidate.
Request Response
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?address=10 Downing Street, London&maxLocations=1&f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"spatialReference" : {
"wkid" : 4326 ,
"latestWkid" : 4326
},
"candidates" : [
{
"address" : "10 Downing Street, London, England, SW1A 2" ,
"location" : {
"x" : -0.12766996404513975 ,
"y" : 51.503359983443914
},
"score" : 100 ,
"attributes" : {},
"extent" : {
"xmin" : -0.12866996404513975 ,
"ymin" : 51.50235998344392 ,
"xmax" : -0.12666996404513975 ,
"ymax" : 51.50435998344391
}
}
]
}
Place geocoding To search for a place or POI, use the find operation.
This returns a JSON structure containing an array of place candidates. Each candidate includes a:
score (between 0-100)complete address point location coverage extent set of attributes You can specify a place name to search by name using the singleline parameter, and/or a category to search by type of place. You can also specify a location to search near.
singleline, category, and location are all optional, but you should typically specify at least singleline or category.
URL Request Standard endpoint Enhanced endpoint
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?SingleLine={placeName}&location={longitude,latitude}&category={category}f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?SingleLine={placeName}&location={longitude,latitude}&category={category}f=json&token=<ACCESS_TOKEN>
Learn more about standard and enhanced endpoints in Service endpoints .
Key parameters address or singleline (optional)The place name to search for.
category (optional)Which type of places to search for. If not specified, all categories are considered.
location (optional)Candidate scores will be weighted to prefer results closer to this location.
out (optional)out specifies which attributes to return for each result candidate. If not specified, no attributes are returned.
Use * to return all attributes.
Other parameters There are many other parameters that can be used to improve and modify place search results.
Some commonly used parameters are:
max: Limit the number of candidates returned.out: The spatial reference for the location and extent. If not specified, they are returned in WGS84.search: Limit search results to a geographic extent. Candidates outside this extent will not be returned.location: Specify whether the location is the candidate's rooftop or a street location suitable for driving directions.for: Specifies whether the results of the operation will be persisted.Code examples Get the nearest POI locations by name Get the nearest Starbucks locations to (lat,lon) 34,-118.2. Note that this translates to (x,y) -118.2,34.
Request Response
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?singleline=Starbucks&location=-118.2,34&f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
{
"spatialReference" : {
"wkid" : 4326 ,
"latestWkid" : 4326
},
"candidates" : [
{
"address" : "Starbucks" ,
"location" : {
"x" : -118.21380999999997 ,
"y" : 33.988890000000026
},
"score" : 100 ,
"attributes" : {},
"extent" : {
"xmin" : -118.21880999999996 ,
"ymin" : 33.983890000000024 ,
"xmax" : -118.20880999999997 ,
"ymax" : 33.99389000000003
}
},
{
"address" : "Starbucks" ,
"location" : {
"x" : -118.18505999999996 ,
"y" : 33.98834000000005
},
"score" : 100 ,
"attributes" : {},
"extent" : {
Get the nearest POI locations by category Get the nearest Coffee Shop locations to (lat,lon) 34,-118.2. Note that this translates to (x,y) -118.2,34.
Request Response
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?category=Coffee Shop&location=-118.2,34&f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
{
"spatialReference" : {
"wkid" : 4326 ,
"latestWkid" : 4326
},
"candidates" : [
{
"address" : "Euro Coffee" ,
"location" : {
"x" : -118.20613999999995 ,
"y" : 33.99613000000005
},
"score" : 100 ,
"attributes" : {},
"extent" : {
"xmin" : -118.21113999999994 ,
"ymin" : 33.99113000000005 ,
"xmax" : -118.20113999999995 ,
"ymax" : 34.00113000000005
}
},
{
"address" : "Universal Coffee" ,
"location" : {
"x" : -118.20210999999995 ,
"y" : 34.014500000000055
},
"score" : 100 ,
"attributes" : {},
"extent" : {
Autosuggest To get complete text suggestions for partial search text, use the suggest operation.
This returns a JSON structure containing an array of complete search suggestions for incomplete search text, which can be displayed in a UI for the user to choose from. Each suggestion includes text which can be used to make a geocode or place search request.
URL Request Standard endpoint Enhanced endpoint
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest?text={partialText}&f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest?text={partialText}&f=json&token=<ACCESS_TOKEN>
Learn more about standard and enhanced endpoints in Service endpoints .
Key parameters textThe partial search text to get complete search suggestions for.
Other parameters Additional parameters can be used to improve the complete suggestions.
Some commonly used parameters are:
location: Complete suggestions will be weighted to prefer those closer to this location.max: Limit the number of complete suggestions to return.search: Specify an extent to limit search results. Suggestions outside this extent will not be returned.category: See Place search .To learn more, see the REST API documentation .
If location, search, category, or country are used to limit the suggestions, they should also be used when the suggested text is used to geocode.
Example Get the search suggestions for partial text Get the best search completions for the text Amster.
Request Response
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest?text=Amster&f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
"suggestions" : [
{
"text" : "Amsterdam, NLD" ,
"magicKey" : "dHA9MCNsb2M9NDI0OTc4MzcjbG5nPTMyI3BsPTQzMDg4MjQyI2xicz0xNDo1MDQxNDE3" ,
"isCollection" : false
},
{
"text" : "Amsterdam Airport Gemeente Haarlemmermeer, NLD" ,
"magicKey" : "dHA9MCNsb2M9NDI4MDI5OTgjbG5nPTMyI3BsPTQzNjcyNjA5I2xicz0xNDo1MDQxNDIx" ,
"isCollection" : false
},
{
"text" : "Amsterdao Amsterdam, NLD" ,
"magicKey" : "dHA9MCNsb2M9NDI4MDMxMzEjbG5nPTMyI3BsPTQzNjcyNzY1I2xicz0xNDo1MDQxNzI0" ,
"isCollection" : false
},
{
"text" : "Amsterdam, NY, USA" ,
"magicKey" : "dHA9MCNsb2M9NDU3NjkyNSNsbmc9MzMjcGw9MTcwMTExMyNsYnM9MTQ6NTA0MTQxNw==" ,
"isCollection" : false
},
{
"text" : "Amsterdam, Gert Sibande, Mpumalanga, ZAF" ,
"magicKey" : "dHA9MCNsb2M9NDk5NjMxNDgjbG5nPTMzI3BsPTU0OTg5MTk3I2xicz0xNDo1MDQxNDE3" ,
"isCollection" : false
}
]
}
Reverse geocoding To get the nearest address or place name for a point location, use the reverse operation.
This returns a JSON structure containing a single candidate. The candidate includes:
address: detailed result information.location: The point location of the result.URL Request Standard endpoint Enhanced endpoint
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?location={point}&f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?location={point}&f=json&token=<ACCESS_TOKEN>
Learn more about standard and enhanced endpoints in Service endpoints .
Key parameters location (optional)Specify a location to get an address for.
Other parameters Additional parameters can be used to improve reverse geocode results.
Some commonly used parameters are:
feature: Limit the types of candidates to return (such as Street Address, POI, Street Intersection).location: Specify rooftop or street to control what the candidate location refers to.lang: Control the language of the returned address.for: Specifies whether the results of the operation will be persisted.Example Get the nearest intersection Get the nearest street intersection to (lat,lon) 34,-118.2. Note that this translates to (x,y) -118.2,34.
Request Response
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?location=-118.2,34&featureTypes=StreetInt&f=json&token=<ACCESS_TOKEN>
Use dark colors for code blocks Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
"address" : {
"Match_addr" : "District Blvd & Everett Ave, Los Angeles, California, 90058" ,
"LongLabel" : "District Blvd & Everett Ave, Los Angeles, CA, 90058, USA" ,
"ShortLabel" : "District Blvd & Everett Ave" ,
"Addr_type" : "StreetInt" ,
"Type" : "" ,
"PlaceName" : "" ,
"AddNum" : "" ,
"Address" : "District Blvd & Everett Ave" ,
"Block" : "" ,
"Sector" : "" ,
"Neighborhood" : "" ,
"District" : "" ,
"City" : "Los Angeles" ,
"MetroArea" : "Los Angeles Metro Area" ,
"Subregion" : "Los Angeles County" ,
"Region" : "California" ,
"Territory" : "" ,
"Postal" : "90058" ,
"PostalExt" : "" ,
"CountryCode" : "USA"
},
"location" : {
"x" : -118.199789933022 ,
"y" : 33.99992003757502 ,
"spatialReference" : {
"wkid" : 4326 ,
"latestWkid" : 4326
}
Batch geocoding To search for multiple places or POIs, use the geocode operation.
This returns a JSON structure containing an array of place candidates. Each candidate includes a:
score (between 0-100)complete address point location coverage extent set of attributes URL Request Enhanced endpoint
Use dark colors for code blocks Copy
1
2
https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/geocodeAddresses?addresses={records}&f=json&token=<ACCESS_TOKEN>
Learn more about standard and enhanced endpoints in Service endpoints .
Authentication To make authenticated requests you need to use one of the following:
API key :content (currently in beta ).ArcGIS Identity (formerly named user ):OAuth 2.0 , giving your application permission to access the content and services authorized to an existing ArcGIS user's account.Learn more about getting access tokens in Security and authentication .
API support Pricing To determine how much it costs to access the service:
If you have an ArcGIS Developer account , go to Pricing . Transactions are billed in US dollars. A free tier of transactions may be available. If you have an ArcGIS Online account , go to Understand credits . Transactions are billed in credits . The properties and capabilities of the geocoding service are described by metadata JSON that can be accessed here:
Use dark colors for code blocks Copy
1
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer?f=json&token=<ACCESS_TOKEN>
Service data Source The main sources for data are HERE and Geonames. Additional sources may be used for different countries. See a complete list of data sources for each country here .
Quality The service provides geocoding for most countries in the world. The quality of results depends on the data available. The quality is ranked Level 1 (darkest) to Level 4 (lighest); Level 1 being the highest quality.
Language support Addresses can be returned in a specific language. Different languages are supported for each country. Visit the language table to learn which languages are supported.
Click on the map below to explore the support level.
Three text strings geocoded in one transaction with the geocoding service
Tutorials
