REST APIs

GeoAnalytics Builder account required

Geocoder

coder.{xml | json}

This service transforms an address to geographic coordinates (latitude and longitude).


A geocoder request must be formatted as follow:

https://geowebservices.maporama.com/coder.output?maporamakey=key&parameters

Where:

  • key: Your account key
  • output: The response format. May be either of the following values:
    • .json output in JavaScript Object Notation (JSON)
    • .xml output as XML
The service is available using HTTPS protocol. The HTTPS verb must be GET.

List of parameters

Name Type Values Description
country string e.g. US Country code (ISO 3166-2). This is a mandatory field.
city string e.g. New york City. This is a mandatory field if Zip Code is not used.
state string e.g. NY The administrative division name under the country level (only for USA, Canada and Australia)
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
zip string e.g. 10307 Zip Code. This is a mandatory field if City is not used.
street string e.g. 34 MAIN ST Street Name
Demo
URL:
Format:
Send Request

Example

Definitions

  • <AdmDivisions> Returns the geopolitical division according to the country of the request. The geocoder can output 3 types of Administrative divisions:
    • adm01: The unit under the Country level.
    • adm07: The first unit up to the City level.
    • adm09: The first unit under the City level.
  • <BoundingBox> 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 quality:
    • 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: Street Number 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.
  • <diag>The search diagnostic returning an array of issue. An optional diag might be set even if a result is returned.
    Diagnostic types:
    • street The Street name
    • street_type The Street type, e.g. avenue
    • street_number The Street specified
    • zip The Zip Code specified
    • city The City name specified
    Diagnostic values:
    • MM: Misspellings
    • NF: Not Found