Geocoding service

The Geocoding service finds addresses, businesses, and places around the world. You can convert an address to a location (forward geocoding) or a location to an address (reverse geocoding). The service provides suggested address names for partial address and place names. You can also geocode many addresses at one time with batch geocoding.

Places, addresses, and businesses found using the geocoding service

Key features

  • World geocoding and place finding.
  • Filter place search by category type.
  • Return values in different languages and locales.
  • Specify the spatial reference of the candidates returned.
  • Refine search by location, extent, city, and country code.
  • Specify data fields to return in the geocoding response.
  • Limit the number of candidates returned.
  • Specify the language of search candidates.
  • Specify rooftop or street location for PointAddress candidates.
  • Choose 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:

  • Geocoding: get a location from an address.
  • Place search: 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.

Service URL

The base URL for the geocoding service is:

 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer

Geocoding

To geocode an address, use the findAddressCandidates 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

 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?address={searchText}&outFields={fieldList}&f=json&token=YOUR-API-KEY

Key parameters

address or singleline

The address text to search for.

outFields (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:

  • maxLocations: Limit the number of candidates returned.
  • outSR: 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.
  • searchExtent: Limit search results to a geographic extent. Candidates outside this extent will not be returned.
  • locationType: Specify whether the location is the candidate's rooftop or a street location suitable for driving directions.

Examples

Get the top result

Get the best match for 10 Downing Street, London by also specifying to return at most 1 result candidate.

RequestResponse
 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?address=10 Downing Street, London&maxLocations=1&f=json&token=YOUR-API-KEY
                       
{
  "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
      }
    }
  ]
}

To search for a place or POI, use the findAddressCandidates 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

 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?SingleLine={placeName}&location={longitude,latitude}&category={category}f=json&token=YOUR-API-KEY

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.

outFields (optional)

outFields 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:

  • maxLocations: Limit the number of candidates returned.
  • outSR: The spatial reference for the location and extent. If not specified, they are returned in WGS84.
  • searchExtent: Limit search results to a geographic extent. Candidates outside this extent will not be returned.
  • locationType: Specify whether the location is the candidate's rooftop or a street location suitable for driving directions.

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.

RequestResponse
 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?singleline=Starbucks&location=-118.2,34&f=json&token=YOUR-API-KEY
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
{
  "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": {
        "xmin": -118.19005999999996,
        "ymin": 33.98334000000005,
        "xmax": -118.18005999999997,
        "ymax": 33.99334000000005
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.22590999999994,
        "y": 33.986770000000035
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.23090999999994,
        "ymin": 33.98177000000003,
        "xmax": -118.22090999999995,
        "ymax": 33.99177000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.16766999999999,
        "y": 34.00302000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.17266999999998,
        "ymin": 33.99802000000005,
        "xmax": -118.16266999999999,
        "ymax": 34.00802000000005
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.22014999999999,
        "y": 34.024590000000046
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22514999999999,
        "ymin": 34.01959000000004,
        "xmax": -118.21515,
        "ymax": 34.02959000000005
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.18847999999997,
        "y": 33.970660000000066
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.19347999999997,
        "ymin": 33.965660000000064,
        "xmax": -118.18347999999997,
        "ymax": 33.97566000000007
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.18435999999997,
        "y": 34.03353000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.18935999999997,
        "ymin": 34.02853000000004,
        "xmax": -118.17935999999997,
        "ymax": 34.038530000000044
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.15261999999996,
        "y": 34.005580000000066
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.15761999999995,
        "ymin": 34.00058000000006,
        "xmax": -118.14761999999996,
        "ymax": 34.01058000000007
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.23935999999998,
        "y": 34.025360000000035
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24435999999997,
        "ymin": 34.02036000000003,
        "xmax": -118.23435999999998,
        "ymax": 34.03036000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.16402999999997,
        "y": 33.969670000000065
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.16902999999996,
        "ymin": 33.96467000000006,
        "xmax": -118.15902999999997,
        "ymax": 33.97467000000007
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.16608999999994,
        "y": 33.96668000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.17108999999994,
        "ymin": 33.96168000000005,
        "xmax": -118.16108999999994,
        "ymax": 33.971680000000056
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.24911999999995,
        "y": 33.98210000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25411999999994,
        "ymin": 33.97710000000006,
        "xmax": -118.24411999999995,
        "ymax": 33.98710000000006
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.15033999999997,
        "y": 34.01794000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.15533999999997,
        "ymin": 34.012940000000064,
        "xmax": -118.14533999999998,
        "ymax": 34.02294000000007
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.21920999999998,
        "y": 33.95510000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22420999999997,
        "ymin": 33.95010000000007,
        "xmax": -118.21420999999998,
        "ymax": 33.960100000000075
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25648999999999,
        "y": 33.987990000000025
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26148999999998,
        "ymin": 33.98299000000002,
        "xmax": -118.25148999999999,
        "ymax": 33.99299000000003
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.18670999999995,
        "y": 33.95198000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.19170999999994,
        "ymin": 33.946980000000046,
        "xmax": -118.18170999999995,
        "ymax": 33.95698000000005
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.20459999999997,
        "y": 34.05541000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.20959999999997,
        "ymin": 34.05041000000005,
        "xmax": -118.19959999999998,
        "ymax": 34.060410000000054
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.16397999999998,
        "y": 33.952270000000055
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.16897999999998,
        "ymin": 33.94727000000005,
        "xmax": -118.15897999999999,
        "ymax": 33.95727000000006
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.16735999999997,
        "y": 33.94831000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.17235999999997,
        "ymin": 33.94331000000005,
        "xmax": -118.16235999999998,
        "ymax": 33.95331000000005
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.23922999999996,
        "y": 34.04851000000008
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24422999999996,
        "ymin": 34.043510000000076,
        "xmax": -118.23422999999997,
        "ymax": 34.05351000000008
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25339999999994,
        "y": 34.03985000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25839999999994,
        "ymin": 34.034850000000056,
        "xmax": -118.24839999999995,
        "ymax": 34.04485000000006
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.13032999999996,
        "y": 34.01464000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.13532999999995,
        "ymin": 34.00964000000004,
        "xmax": -118.12532999999996,
        "ymax": 34.019640000000045
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.24243999999999,
        "y": 34.049570000000074
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24743999999998,
        "ymin": 34.04457000000007,
        "xmax": -118.23743999999999,
        "ymax": 34.054570000000076
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.14368999999999,
        "y": 34.03923000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.14868999999999,
        "ymin": 34.03423000000003,
        "xmax": -118.13869,
        "ymax": 34.044230000000034
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.20462999999995,
        "y": 34.061590000000024
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.20962999999995,
        "ymin": 34.05659000000002,
        "xmax": -118.19962999999996,
        "ymax": 34.066590000000026
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.24261999999999,
        "y": 34.050920000000076
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24761999999998,
        "ymin": 34.04592000000007,
        "xmax": -118.23761999999999,
        "ymax": 34.05592000000008
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25119999999998,
        "y": 34.04577000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25619999999998,
        "ymin": 34.04077000000006,
        "xmax": -118.24619999999999,
        "ymax": 34.050770000000064
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.23595999999998,
        "y": 34.05615000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24095999999997,
        "ymin": 34.05115000000006,
        "xmax": -118.23095999999998,
        "ymax": 34.06115000000006
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.26098999999999,
        "y": 34.03926000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26598999999999,
        "ymin": 34.03426000000007,
        "xmax": -118.25599,
        "ymax": 34.04426000000007
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25951999999995,
        "y": 34.04231000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26451999999995,
        "ymin": 34.03731000000004,
        "xmax": -118.25451999999996,
        "ymax": 34.047310000000046
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25188999999995,
        "y": 34.04912000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25688999999994,
        "ymin": 34.04412000000007,
        "xmax": -118.24688999999995,
        "ymax": 34.054120000000076
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25714999999997,
        "y": 34.04514000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26214999999996,
        "ymin": 34.04014000000006,
        "xmax": -118.25214999999997,
        "ymax": 34.05014000000006
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.26440999999994,
        "y": 34.03926000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26940999999994,
        "ymin": 34.03426000000007,
        "xmax": -118.25940999999995,
        "ymax": 34.04426000000007
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.26262999999994,
        "y": 34.04144000000008
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26762999999994,
        "ymin": 34.03644000000008,
        "xmax": -118.25762999999995,
        "ymax": 34.04644000000008
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25483999999994,
        "y": 34.048640000000034
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25983999999994,
        "ymin": 34.04364000000003,
        "xmax": -118.24983999999995,
        "ymax": 34.05364000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25313999999997,
        "y": 34.05008000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25813999999997,
        "ymin": 34.045080000000034,
        "xmax": -118.24813999999998,
        "ymax": 34.05508000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25137999999998,
        "y": 34.05166000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25637999999998,
        "ymin": 34.046660000000024,
        "xmax": -118.24637999999999,
        "ymax": 34.05666000000003
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.12449999999995,
        "y": 33.97547000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.12949999999995,
        "ymin": 33.97047000000003,
        "xmax": -118.11949999999996,
        "ymax": 33.98047000000003
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.26780999999994,
        "y": 34.037330000000054
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.27280999999994,
        "ymin": 34.03233000000005,
        "xmax": -118.26280999999994,
        "ymax": 34.04233000000006
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.24940999999995,
        "y": 34.053750000000036
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25440999999995,
        "ymin": 34.048750000000034,
        "xmax": -118.24440999999996,
        "ymax": 34.05875000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.26122999999995,
        "y": 34.04507000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26622999999995,
        "ymin": 34.040070000000064,
        "xmax": -118.25622999999996,
        "ymax": 34.05007000000007
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25800999999996,
        "y": 34.04792000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26300999999995,
        "ymin": 34.04292000000003,
        "xmax": -118.25300999999996,
        "ymax": 34.052920000000036
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.23979999999995,
        "y": 34.05972000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24479999999994,
        "ymin": 34.054720000000025,
        "xmax": -118.23479999999995,
        "ymax": 34.06472000000003
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.24701999999996,
        "y": 34.056250000000034
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25201999999996,
        "ymin": 34.05125000000003,
        "xmax": -118.24201999999997,
        "ymax": 34.06125000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25251999999995,
        "y": 34.05319000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25751999999994,
        "ymin": 34.04819000000003,
        "xmax": -118.24751999999995,
        "ymax": 34.05819000000003
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25291999999996,
        "y": 34.05326000000008
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25791999999996,
        "ymin": 34.04826000000008,
        "xmax": -118.24791999999997,
        "ymax": 34.05826000000008
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25519999999995,
        "y": 34.05165000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26019999999994,
        "ymin": 34.04665000000005,
        "xmax": -118.25019999999995,
        "ymax": 34.056650000000054
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.27826999999996,
        "y": 34.02425000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.28326999999996,
        "ymin": 34.01925000000005,
        "xmax": -118.27326999999997,
        "ymax": 34.029250000000054
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.27738,
        "y": 34.02634000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.28237999999999,
        "ymin": 34.02134000000006,
        "xmax": -118.27238,
        "ymax": 34.031340000000064
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25628999999998,
        "y": 34.05144000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26128999999997,
        "ymin": 34.04644000000007,
        "xmax": -118.25128999999998,
        "ymax": 34.05644000000007
      }
    }
  ]
}

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.

RequestResponse
 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/findAddressCandidates?category=Coffee Shop&location=-118.2,34&f=json&token=YOUR-API-KEY
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
{
  "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": {
        "xmin": -118.20710999999994,
        "ymin": 34.00950000000005,
        "xmax": -118.19710999999995,
        "ymax": 34.01950000000006
      }
    },
    {
      "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": "Mark's Coffee",
      "location": {
        "x": -118.19961999999998,
        "y": 34.01619000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.20461999999998,
        "ymin": 34.01119000000005,
        "xmax": -118.19461999999999,
        "ymax": 34.021190000000054
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.18505999999996,
        "y": 33.98834000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.19005999999996,
        "ymin": 33.98334000000005,
        "xmax": -118.18005999999997,
        "ymax": 33.99334000000005
      }
    },
    {
      "address": "F Gavina and Sons",
      "location": {
        "x": -118.22165999999999,
        "y": 33.99606000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22665999999998,
        "ymin": 33.991060000000054,
        "xmax": -118.21665999999999,
        "ymax": 34.00106000000006
      }
    },
    {
      "address": "Rae G Cafe",
      "location": {
        "x": -118.21971999999994,
        "y": 34.00926000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22471999999993,
        "ymin": 34.00426000000004,
        "xmax": -118.21471999999994,
        "ymax": 34.01426000000004
      }
    },
    {
      "address": "Casa de Cafe & Snacks",
      "location": {
        "x": -118.21413999999999,
        "y": 33.98093000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.21913999999998,
        "ymin": 33.975930000000055,
        "xmax": -118.20913999999999,
        "ymax": 33.98593000000006
      }
    },
    {
      "address": "Twinkle Brown Sugar",
      "location": {
        "x": -118.22486999999995,
        "y": 33.98828000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22986999999995,
        "ymin": 33.98328000000003,
        "xmax": -118.21986999999996,
        "ymax": 33.993280000000034
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.22590999999994,
        "y": 33.986770000000035
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.23090999999994,
        "ymin": 33.98177000000003,
        "xmax": -118.22090999999995,
        "ymax": 33.99177000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.16766999999999,
        "y": 34.00302000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.17266999999998,
        "ymin": 33.99802000000005,
        "xmax": -118.16266999999999,
        "ymax": 34.00802000000005
      }
    },
    {
      "address": "Bradford Coffee",
      "location": {
        "x": -118.22294999999997,
        "y": 34.02015000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22794999999996,
        "ymin": 34.015150000000055,
        "xmax": -118.21794999999997,
        "ymax": 34.02515000000006
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.22014999999999,
        "y": 34.024590000000046
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22514999999999,
        "ymin": 34.01959000000004,
        "xmax": -118.21515,
        "ymax": 34.02959000000005
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.18847999999997,
        "y": 33.970660000000066
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.19347999999997,
        "ymin": 33.965660000000064,
        "xmax": -118.18347999999997,
        "ymax": 33.97566000000007
      }
    },
    {
      "address": "Kelly's Coffee & Fudge Factory",
      "location": {
        "x": -118.16296999999997,
        "y": 33.98684000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.16796999999997,
        "ymin": 33.98184000000003,
        "xmax": -118.15796999999998,
        "ymax": 33.99184000000003
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.18435999999997,
        "y": 34.03353000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.18935999999997,
        "ymin": 34.02853000000004,
        "xmax": -118.17935999999997,
        "ymax": 34.038530000000044
      }
    },
    {
      "address": "RVCC Intersect",
      "location": {
        "x": -118.22968999999995,
        "y": 34.02960000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.23468999999994,
        "ymin": 34.02460000000007,
        "xmax": -118.22468999999995,
        "ymax": 34.034600000000076
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.15261999999996,
        "y": 34.005580000000066
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.15761999999995,
        "ymin": 34.00058000000006,
        "xmax": -118.14761999999996,
        "ymax": 34.01058000000007
      }
    },
    {
      "address": "Maru Coffee",
      "location": {
        "x": -118.23019,
        "y": 34.03092000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.23518999999999,
        "ymin": 34.025920000000035,
        "xmax": -118.22519,
        "ymax": 34.03592000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.23935999999998,
        "y": 34.025360000000035
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24435999999997,
        "ymin": 34.02036000000003,
        "xmax": -118.23435999999998,
        "ymax": 34.03036000000004
      }
    },
    {
      "address": "Dunkin' Donuts",
      "location": {
        "x": -118.16469999999998,
        "y": 33.970750000000066
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.16969999999998,
        "ymin": 33.965750000000064,
        "xmax": -118.15969999999999,
        "ymax": 33.97575000000007
      }
    },
    {
      "address": "Stumptown Coffee Roasters",
      "location": {
        "x": -118.22983999999997,
        "y": 34.033240000000035
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.23483999999996,
        "ymin": 34.02824000000003,
        "xmax": -118.22483999999997,
        "ymax": 34.03824000000004
      }
    },
    {
      "address": "Chacui's Snack Bar and Coffee",
      "location": {
        "x": -118.21164999999996,
        "y": 33.95867000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.21664999999996,
        "ymin": 33.95367000000004,
        "xmax": -118.20664999999997,
        "ymax": 33.96367000000004
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.16402999999997,
        "y": 33.969670000000065
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.16902999999996,
        "ymin": 33.96467000000006,
        "xmax": -118.15902999999997,
        "ymax": 33.97467000000007
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.16608999999994,
        "y": 33.96668000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.17108999999994,
        "ymin": 33.96168000000005,
        "xmax": -118.16108999999994,
        "ymax": 33.971680000000056
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.24911999999995,
        "y": 33.98210000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25411999999994,
        "ymin": 33.97710000000006,
        "xmax": -118.24411999999995,
        "ymax": 33.98710000000006
      }
    },
    {
      "address": "Dulce dos",
      "location": {
        "x": -118.23889999999994,
        "y": 34.030850000000044
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24389999999994,
        "ymin": 34.02585000000004,
        "xmax": -118.23389999999995,
        "ymax": 34.035850000000046
      }
    },
    {
      "address": "Paramount Coffee Project",
      "location": {
        "x": -118.23889999999994,
        "y": 34.030850000000044
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24389999999994,
        "ymin": 34.02585000000004,
        "xmax": -118.23389999999995,
        "ymax": 34.035850000000046
      }
    },
    {
      "address": "Go Get Em Tiger",
      "location": {
        "x": -118.23888,
        "y": 34.03105000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24387999999999,
        "ymin": 34.02605000000005,
        "xmax": -118.23388,
        "ymax": 34.03605000000005
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.15033999999997,
        "y": 34.01794000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.15533999999997,
        "ymin": 34.012940000000064,
        "xmax": -118.14533999999998,
        "ymax": 34.02294000000007
      }
    },
    {
      "address": "Volcano Tea House Commerce",
      "location": {
        "x": -118.14524999999998,
        "y": 33.99834000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.15024999999997,
        "ymin": 33.99334000000004,
        "xmax": -118.14024999999998,
        "ymax": 34.003340000000044
      }
    },
    {
      "address": "Weird Wave Coffee Brewers",
      "location": {
        "x": -118.20709999999997,
        "y": 34.04666000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.21209999999996,
        "ymin": 34.04166000000003,
        "xmax": -118.20209999999997,
        "ymax": 34.051660000000034
      }
    },
    {
      "address": "The Coffee Bean & Tea Leaf",
      "location": {
        "x": -118.16188999999997,
        "y": 34.03493000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.16688999999997,
        "ymin": 34.02993000000003,
        "xmax": -118.15688999999998,
        "ymax": 34.039930000000034
      }
    },
    {
      "address": "Blue Bottle Coffee",
      "location": {
        "x": -118.23265999999995,
        "y": 34.039010000000076
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.23765999999995,
        "ymin": 34.03401000000007,
        "xmax": -118.22765999999996,
        "ymax": 34.04401000000008
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.21920999999998,
        "y": 33.95510000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22420999999997,
        "ymin": 33.95010000000007,
        "xmax": -118.21420999999998,
        "ymax": 33.960100000000075
      }
    },
    {
      "address": "The Coffee Bean & Tea Leaf",
      "location": {
        "x": -118.14246999999995,
        "y": 33.99553000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.14746999999994,
        "ymin": 33.99053000000003,
        "xmax": -118.13746999999995,
        "ymax": 34.00053000000003
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.25648999999999,
        "y": 33.987990000000025
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26148999999998,
        "ymin": 33.98299000000002,
        "xmax": -118.25148999999999,
        "ymax": 33.99299000000003
      }
    },
    {
      "address": "3 Worlds Coffee",
      "location": {
        "x": -118.25633999999997,
        "y": 34.01330000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.26133999999996,
        "ymin": 34.00830000000007,
        "xmax": -118.25133999999997,
        "ymax": 34.018300000000075
      }
    },
    {
      "address": "Capuyo Cafe",
      "location": {
        "x": -118.21818999999999,
        "y": 34.04654000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22318999999999,
        "ymin": 34.04154000000005,
        "xmax": -118.21319,
        "ymax": 34.05154000000005
      }
    },
    {
      "address": "Starbucks",
      "location": {
        "x": -118.18670999999995,
        "y": 33.95198000000005
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.19170999999994,
        "ymin": 33.946980000000046,
        "xmax": -118.18170999999995,
        "ymax": 33.95698000000005
      }
    },
    {
      "address": "12th Street Coffee Shop",
      "location": {
        "x": -118.24736999999999,
        "y": 34.03119000000004
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25236999999998,
        "ymin": 34.026190000000035,
        "xmax": -118.24237,
        "ymax": 34.03619000000004
      }
    },
    {
      "address": "Philz Coffee",
      "location": {
        "x": -118.23817999999994,
        "y": 34.038940000000025
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24317999999994,
        "ymin": 34.03394000000002,
        "xmax": -118.23317999999995,
        "ymax": 34.04394000000003
      }
    },
    {
      "address": "Tierra Mia Coffee",
      "location": {
        "x": -118.18227999999999,
        "y": 33.95143000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.18727999999999,
        "ymin": 33.94643000000007,
        "xmax": -118.17728,
        "ymax": 33.956430000000076
      }
    },
    {
      "address": "Urth Caffe",
      "location": {
        "x": -118.23524999999995,
        "y": 34.04210000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24024999999995,
        "ymin": 34.03710000000006,
        "xmax": -118.23024999999996,
        "ymax": 34.047100000000064
      }
    },
    {
      "address": "Café Con Leche",
      "location": {
        "x": -118.22377999999998,
        "y": 34.04732000000007
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.22877999999997,
        "ymin": 34.04232000000007,
        "xmax": -118.21877999999998,
        "ymax": 34.05232000000007
      }
    },
    {
      "address": "Bulletproof Coffee",
      "location": {
        "x": -118.23255999999998,
        "y": 34.04388000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.23755999999997,
        "ymin": 34.038880000000056,
        "xmax": -118.22755999999998,
        "ymax": 34.04888000000006
      }
    },
    {
      "address": "Coffee Prince",
      "location": {
        "x": -118.25052999999997,
        "y": 34.03239000000008
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25552999999996,
        "ymin": 34.027390000000075,
        "xmax": -118.24552999999997,
        "ymax": 34.03739000000008
      }
    },
    {
      "address": "Groundwork",
      "location": {
        "x": -118.23545999999999,
        "y": 34.04520000000008
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.24045999999998,
        "ymin": 34.04020000000008,
        "xmax": -118.23046,
        "ymax": 34.05020000000008
      }
    },
    {
      "address": "Espresso USA",
      "location": {
        "x": -118.24663999999996,
        "y": 34.03789000000006
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25163999999995,
        "ymin": 34.03289000000006,
        "xmax": -118.24163999999996,
        "ymax": 34.042890000000064
      }
    },
    {
      "address": "Coffeeberry",
      "location": {
        "x": -118.25278999999995,
        "y": 34.03205000000003
      },
      "score": 100,
      "attributes": {},
      "extent": {
        "xmin": -118.25778999999994,
        "ymin": 34.027050000000024,
        "xmax": -118.24778999999995,
        "ymax": 34.03705000000003
      }
    }
  ]
}

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

 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest?text={partialText}&f=json&token=YOUR-API-KEY

Key parameters

text

The 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.
  • maxCandidates: Limit the number of complete suggestions to return.
  • searchExtent: 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 documentation.

Examples

Get the search suggestions for partial text

Get the best search completions for the text Amster.

RequestResponse
 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/suggest?text=Amster&f=json&token=YOUR-API-KEY
                             
{
  "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 reverseGeocode 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

 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?location={point}&f=json&token=YOUR-API-KEY

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:

  • featureTypes: Limit the types of candidates to return (such as Street Address, POI, Street Intersection).
  • locationType: Specify rooftop or street to control what the candidate location refers to.
  • langCode: Control the language of the returned address.

Examples

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.

RequestResponse
 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?location=-118.2,34&featureTypes=StreetInt&f=json&token=YOUR-API-KEY
                                
{
  "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
    }
  }
}

Stored vs not stored geocoding

Two types of geocoding and place search are possible: not stored and stored. Not stored geocoding and place search is for use in an application where the results are temporary, and there is no cost for this for the first 20,000 geocodes per month. Stored geocoding or place search allows for the results to be stored and used later or outside the application. For stored geocoding, use the forStorage parameter.

Authentication

This service requires authentication using either:

  • API key: Allows access to location services using a permanent token that can be restricted to specific services and included in public applications.
  • ArcGIS Identity (OAuth 2.0): Uses OAuth 2.0 protocol to authenticate app users with their ArcGIS Online or Enterprise Identity. The resulting token is used to access the service.

API support

GeocodingReverse GeocodingBatch GeocodingPlace/POI SearchAutosuggestUI Component
ArcGIS API for JavaScriptFully supportedFully supportedFully supportedFully supportedFully supportedFully supported
ArcGIS API for AndroidFully supportedFully supportedFully supportedFully supportedFully supportedNot supported
ArcGIS API for iOSFully supportedFully supportedFully supportedFully supportedFully supportedNot supported
ArcGIS API for .NetFully supportedFully supportedFully supportedFully supportedFully supportedNot supported
ArcGIS API for QtFully supportedFully supportedFully supportedFully supportedFully supportedNot supported
ArcGIS API for JavaFully supportedFully supportedFully supportedFully supportedFully supportedNot supported
ArcGIS API for PythonFully supportedFully supportedFully supportedFully supportedFully supportedNot supported
Esri LeafletFully supportedFully supportedAccess via ArcGIS REST JSFully supportedFully supportedFully supported
MapBox GL JSAccess via ArcGIS REST JSAccess via ArcGIS REST JSAccess via ArcGIS REST JSAccess via ArcGIS REST JSAccess via ArcGIS REST JSNot supported
OpenLayersAccess via ArcGIS REST JSAccess via ArcGIS REST JSAccess via ArcGIS REST JSAccess via ArcGIS REST JSAccess via ArcGIS REST JSNot supported
ArcGIS REST JSFully supportedFully supportedFully supportedFully supportedFully supportedNot supported
Full supportPartial support (see notes)Not supported

Service metadata

The properties and capabilities of the geocoding service are described by metadata JSON that can be accessed here:

 
https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer?f=json&token=YOUR-API-KEY

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.

Tutorials