REST APIs

GeoAnalytics Builder account required

Batch Geocoder

coder.{xml | json}

This service geocode or reverse geocode multiple addresses in a single request.


A batch geocoder request is a JSON object done using the POST method. Addresses to geocode must be specified in an array having id and countrycode as required parameters. Geocoding and reverse geocoding are accepted by the service and can be mixed in the addresses array. A batch geocoder request must be formatted as follow:

https://geowebservices.maporama.com/batchcoder.output

Where:

    • .json output in JavaScript Object Notation (JSON)
    • .xml output as XML
The service is available using HTTPS protocol. The HTTPS verb must be POST.
We recommend to use a maximum of 200 addresses by batch call in order to optimize your flow.

Parameters of the JSON POST payload:

Name Type Values Description
request object The JSON object request payload containing the addresses array.
maporamakey string Your account key

Request object in payload:

Name Type Values Description
coder object The main object of the JSON request payload containing the addresses array.
encoding string e.g. utf-8 The request encoding charset.
addresses array The list of addresses to geocode or coordinates to reverse geocoded.
Address item structure.
id string e.g. 1000 Item ID. This is a mandatory field.
city string e.g. ORGEVAL The City name used for geocoding.
countrycode string e.g. FR The Country Code (ISO 3166-2) used for geocoding. This is a mandatory field.
latitude double e.g. 48.88 The Latitude to use when reverse geocoding a location.
longitude double e.g. 2.33 The Longitude to use when reverse geocoding a location.
maxcount integer e.g. 20 The maximum number of results.
maxdist integer e.g. 20000 The maximum acceptable distance for a reverse geocoding request (in meters).
state string e.g. CA The State Code used for geocoding.
street string e.g. 1598 ROUTE DE QUARANTE SOUS The Street Name used for geocoding.
zipcode string e.g. 78630 The Zip Code used for geocoding.
adm07 string e.g. QUEENS The Administrative division name up to City level
adm07code string e.g. NY081 The Administrative division code up to City level
adm09 string e.g. BRONX The Administrative division name under the City level
adm09code string e.g. NY00508510 The Administrative division code under the City level
Demo
URL:
Format:
Add Parameter
Add Address
Send Request
Request Preview

Example

Definitions

  • "order07": The name of first unit up to the City level
  • "order07code": The code of first unit up to the City level
  • "order09": The name of first unit under the City level
  • "order09code": The name of first unit under the City level
  • "bbox" The Area representations for the Location. It defines the bounds containing the city for a city level geocoding or the street for a street level geocoding. A bounding box is used to recenter the map.
  • "level" There are 6 levels of geocoding:
    • Level 0: No result
    • Level 1: Country level
    • Level 2: State or Administrative division 7 level
    • Level 3: City level
    • Level 4: Zip Code level
    • Level 5: Street level
    • Level 6: Address or POI level
  • type Indicates whether a forward or reverse geocoding was done.
  • score Confidence level for the result (0=Poor to 100=Exact). Up to 73 should be considered as good.