Using Your API Key


Find Information


Address Geocoding


Address Cleaning


Bulk Addresses

Using Your API Key

When making a request to a GeoMap endpoint, you must include your API key within the URL of your request as a parameter. The name of the parameter required is key and the value of this parameter is your API key.

For example to access the allinfofuzzysearch API endpoint in your browser, you would construct a request as follows:

https://geomap.online/api/allinfofuzzysearch?address="22 Abbotford St Kensington NSW 2033"&key=YOUR_KEY_HERE

If you want to try out GeoMap but do not have an API key, check out our pricing page or signup for a free 30 day trial .


api/allinfo

Returns detailed address information, such as longitude, latitude, and socio-economic data for a given input address.

Arguments

lvl_number Optional

unit_number Optional

street_number Required

street_name Required

street_type Required

state Required

suburb Required

postcode Required


api/allinfofuzzysearch

Instead of parsing address components, fuzzy-searching is integrated into this call to return detailed address information.

Arguments

address Required

Example Call

Example Response


api/geocode

Returns the longitude and latitude of a given input address.

Arguments

lvl_number Optional

unit_number Optional

street_number Required

street_name Required

street_type Required

state Required

suburb Required

postcode Required


api/geocode_string

Instead of parsing address components, fuzzy-searching is integrated into this call to return latitude and longitude.

Arguments

address Required

Example Call

Example Response

            
{
  "LATITUDE": "-33.8852254",
  "LONGITUDE": "151.19905525",
  "FOUND_ADDRESS": "6 CENTRAL PARK AV CHIPPENDALE NSW 2008",
  "ORIGINAL_ADDRESS": "\"6 CENTRAL PAHIPPENDALE NSW 2008\"",
  "SCORE": 72
}

api/geocodeinput

Returns the closest address of a given latitude and longitude.

Arguments

latitude Required

longitude Required

Example Call

Example Response

            
[
  {
    "LATITUDE": "-42.88563443",
    "LONGITUDE": "147.33085435",
    "COMPLETE_STRING_REFERENCE": "PARLIAMENT HOUSE 2 MURRAY ST HOBART TAS 7000",
    "BUILDING_NAME": "PARLIAMENT HOUSE",
    "UNIT_NUMBER": "",
    "UNIT_TYPE": "",
    "LEVEL_NUMBER": "",
    "STREET_NUMBER": "2",
    "STREET_NAME": "MURRAY",
    "STREET_TYPE_ABBR": "ST",
    "SUBURB": "HOBART",
    "POSTCODE": "7000",
    "STATE_ABBREVIATION": "TAS",
    "MESH_BLOCK_2016": "60064303000"
  }
]

api/meshblock

Returns meshblock of a given input address.

Arguments

lvl_number Optional

unit_number Optional

street_number Required

street_name Required

street_type Required

state Required

suburb Required

postcode Required


api/meshblock_string

Instead of parsing address components, fuzzy-searching is integrated into this call to return the meshblock.

Arguments

address Required

Example Call

Example Response

                  
{
  "ORIGINAL_ADDRESS": "\"6 CENTRAL PAHIPPENDALE NSW 2008\"",
  "FOUND_ADDRESS": "6 CENTRAL PARK AV CHIPPENDALE NSW 2008",
  "SCORE": 72,
  "MESH_BLOCK_2016": "11204777900"
}
                  

api/socioeconomic

Returns socio-economic data for a given meshblock.

Arguments

2016 Meshblock code Required

Example Call

Example Response

                  
[
  {
    "MB_CODE_2016":"10000022000",
    "SA1_CODE_2011":"1117621",
    "INDEX_RELATIVE_SOCIO_ECONOMIC_ADV_DISADV_SCORE":865,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_ADV_DISADV_SCORE_AUS_RANK":4728,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_ADV_DISADV_SCORE_AUS_PERCENTILE":9,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_ADV_DISADV_SCORE_STATE_RANK":1758,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_ADV_DISADV_SCORE_STATE_PERCENTILE":11,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_DISADV_SCORE":872,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_DISADV_SCORE_AUS_RANK":5090,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_DISADV_SCORE_AUS_PERCENTILE":10,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_DISADV_SCORE_STATE_RANK":1955,
    "INDEX_RELATIVE_SOCIO_ECONOMIC_DISADV_SCORE_STATE_PERCENTILE":12,
    "INDEX_ECONOMIC_RESOURCES_SCORE":831,
    "INDEX_ECONOMIC_RESOURCES_SCORE_AUS_RANK":2695,
    "INDEX_ECONOMIC_RESOURCES_SCORE_AUS_PERCENTILE":6,
    "INDEX_ECONOMIC_RESOURCES_SCORE_STATE_RANK":1083,
    "INDEX_ECONOMIC_RESOURCES_SCORE_STATE_PERCENTILE":7,
    "INDEX_EDUCATION_OCCUPATION_SCORE":883,
    "INDEX_EDUCATION_OCCUPATION_SCORE_AUS_RANK":6297,
    "INDEX_EDUCATION_OCCUPATION_SCORE_AUS_PERCENTILE":12,
    "INDEX_EDUCATION_OCCUPATION_SCORE_STATE_RANK":2082,
    "INDEX_EDUCATION_OCCUPATION_SCORE_STATE_PERCENTILE":13,
    "USUAL_RESIDENT_POPULATION":335
  }
]
                  

api/valid

Checks whether or not a given input address is valid.

Arguments

lvl_number Optional

unit_number Optional

street_number Required

street_name Required

street_type Required

state Required

suburb Required

postcode Required


api/valid_string

Instead of parsing address components, fuzzy-searching is integrated into this call to check for a valid address.

Arguments

address Required

Example Call

Example Response

                    
{
  "ORIGINAL_ADDRESS": "6 CENTRAL PAHIPPENDALE NSW 2008",
  "FULL_ADDRESS": "6 CENTRAL PARK AV CHIPPENDALE NSW 2008",
  "SCORE": 72,
  "VALID": "NO"
}
                    

api/fuzzysearch

Returns the best matched address against valid Australian addresses for given input. Adjust topN to the number of matches you want to see.

Arguments

address Required

topN Optional

Example Call

Example Response

                  
{
  "input": "\"6 CENTRAL PAHIPPENDALE NSW 2008\"",
  "results": [
    {
      "ORIGINAL": "6 CENTRAL PAHIPPENDALE NSW 2008",
      "FULL_ADDRESS": "6 CENTRAL PARK AV CHIPPENDALE NSW 2008",
      "SCORE": 72
    },
    {
      "ORIGINAL": "6 CENTRAL PAHIPPENDALE NSW 2008",
      "FULL_ADDRESS": "8 CENTRAL PARK AV CHIPPENDALE NSW 2008",
      "SCORE": 70
    }
  ]
}
                  

api/batchfuzzysearch

Returns the best matched address against valid Australian addresses for multiple addresses. Adjust topN to the number of matches you want to see.

Arguments

address Required

topN Optional

Example Call

Example Response

                    
[
  {
    "ORIGINAL": "22 ABBOTFORD ST KENSINGTON NSW 2033",
    "FULL_ADDRESS": "22 ABBOTFORD ST KENSINGTON NSW 2033",
    "SCORE": 100
  },
  {
    "ORIGINAL": "\"6 central pahippendale nsw 2008\"",
    "FULL_ADDRESS": "6 CENTRAL PARK AV CHIPPENDALE NSW 2008",
    "SCORE": 72
  }
]
                  

api/addressparser

Returns input address string parsed into address components.

Arguments

address Required

Example Call

Example Response

                    
[
  {
    "value": "\"",
    "component": "road"
  },
  {
    "value": "6",
    "component": "house_number"
  },
  {
    "value": "central",
    "component": "road"
  },
  {
    "value": "pahippendale",
    "component": "city"
  },
  {
    "value": "nsw",
    "component": "state"
  },
  {
    "value": "2008",
    "component": "postcode"
  },
  {
    "value": "\""
    "component": "house"
  }
]
                  

api/addressexpander

Returns input address string parsed into address components.

Arguments

address Required

Example Call

Example Response

                    
{
  " xvii bowen street banana queensland 4702",
  "17 bowen street banana queensland 4702",
  " xvii bowen street banana qld 4702",
  "17 bowen street banana qld 4702"
}
                  

File processing

Our easy-to-use file process will get your addresses processed using any of our endpoints.

Arguments

.csv file (1 address/meshblock in each cell in a column, no headers) Required

For geocodeinput calls - use latitude values in the first column and longitude values in the second column.

Max file size: 100kB


Get Started