Match Quality
matchquality=[0|1]
This parameter returns an additional object matchquality for every result in the response, containing the following elements: matchcode, matchtype, matchlevel.
| matchquality | details | Expected Values |
|---|---|---|
| matchcode | Specifies the quality of the returned address | exact, fallback, approximate. [Read more] |
| matchtype | Specifies quality of the returned location match | point, centroid, interpolated. [Read more] |
| matchlevel | Specifies the most granular address element that matches the geocoding query | venue, building, street, neighbourhood, island, borough, city, county, state, country, marine, postalcode. [Read more] |
Match Code
Specifies the quality of the returned address
| matchcode | description |
|---|---|
| exact | The result matches the input query with a high level of probability |
| fallback | The result does not exactly match the input but is closely related to it provided there is direct a hierarchical relation. |
| approximate | The result matches the input query with a medium to low level of probability. |
Match Type
Specifies quality of the returned location match
| matchtype | description |
|---|---|
| point | The coordinate returned is a point address, typically with rooftop accuracy |
| centroid | The coordinate returned is a centroid of a road or administrative boundary |
| interpolated | The coordinate returned is a point determined by interpolation |
Match Level
Specifies the most granular address element that matches the geocoding query
| matchlevel | details |
|---|---|
| venue | The returned address is of a Point of Interest (PoI) level |
| building | The returned address is of a house level |
| street | The returned address is on a street level |
| neighbourhood | The returned address is on a neighbourhood level |
| island | The returned address is on a island level |
| borough | The returned address is on a borough level |
| city | The returned address is on a city level |
| county | The returned address is on a county level |
| state | The returned address is on a state level |
| country | The returned address is on a country level |
| marine | The returned address is on a marine level |
| postalcode | The returned address is on a postal code level |
Updated 8 months ago
