Skip to content
GuidesBlogPlaygroundDashboard

Geocode

Forward geocode an address
GeocodeResult Geocode.Forward(GeocodeForwardParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/geocode
Forward geocode an address
GeocodeResult Geocode.ForwardPost(GeocodeForwardPostParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/geocode
Reverse geocode a coordinate
ReverseGeocodeResult Geocode.Reverse(GeocodeReverseParams?parameters, CancellationTokencancellationToken = default)
GET/api/v1/geocode/reverse
Reverse geocode a coordinate
ReverseGeocodeResult Geocode.ReversePost(GeocodeReversePostParams?parameters, CancellationTokencancellationToken = default)
POST/api/v1/geocode/reverse
Autocomplete a partial address
AutocompleteResult Geocode.Autocomplete(GeocodeAutocompleteParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/geocode/autocomplete
Autocomplete a partial address
AutocompleteResult Geocode.AutocompletePost(GeocodeAutocompletePostParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/geocode/autocomplete
Batch geocode multiple addresses
GeocodeBatchResponse Geocode.Batch(GeocodeBatchParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/geocode/batch
ModelsExpand Collapse
class AutocompleteResult:

GeoJSON FeatureCollection of autocomplete suggestions for partial address input. Optimized for low-latency type-ahead UIs. Content-Type: application/geo+json.

required IReadOnlyList<GeocodingFeature> Features

Autocomplete suggestions ordered by relevance

required GeoJsonGeometry Geometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

required Coordinates Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type

Geometry type

One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties

Geocoding result properties

required string DisplayName

Formatted address or place name

string? Category

POI category (e.g. restaurant, cafe, park). Present for place results.

string? City

City or town name. Present for address results.

Double? Confidence

Interpolation confidence (0-1). Present only for interpolated results.

maximum1
minimum0
string? Country

Country name. Present for reverse geocode address results.

string? CountryCode

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
Double? DistanceM

Distance from the query point in meters (reverse geocode / nearby only)

string? FullAddress

Complete formatted address from the database. Present for reverse geocode address results.

string? HouseNumber

House or building number. Present for address and interpolated results.

Boolean? Interpolated

Whether this result was estimated by address interpolation rather than an exact database match.

string? Name

Place name (raw). Present for reverse geocode place results.

Long? OsmID

OpenStreetMap element ID (null for interpolated results)

OsmType? OsmType

OSM element type (node, way, relation)

One of the following:
"node"Node
"way"Way
"relation"Relation
string? Postcode

Postal code. Present for reverse geocode address results.

Double? Score

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

minimum0
Source? Source

Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)

One of the following:
"structured"Structured
"bm25"Bm25
"fuzzy"Fuzzy
"address"Address
"place"Place
"interpolation"Interpolation
string? State

State or province name. Present for reverse geocode address results.

string? Street

Street name. Present for address and interpolated results.

string? Subcategory

POI subcategory. Present for place results.

IReadOnlyDictionary<string, string>? Tags

Raw OSM tags. Present for place results.

string? Wikipedia

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

required Type Type
required Type Type
class GeocodeResult:

GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: application/geo+json.

required IReadOnlyList<GeocodingFeature> Features

Geocoding results ordered by relevance score

required GeoJsonGeometry Geometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

required Coordinates Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type

Geometry type

One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties

Geocoding result properties

required string DisplayName

Formatted address or place name

string? Category

POI category (e.g. restaurant, cafe, park). Present for place results.

string? City

City or town name. Present for address results.

Double? Confidence

Interpolation confidence (0-1). Present only for interpolated results.

maximum1
minimum0
string? Country

Country name. Present for reverse geocode address results.

string? CountryCode

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
Double? DistanceM

Distance from the query point in meters (reverse geocode / nearby only)

string? FullAddress

Complete formatted address from the database. Present for reverse geocode address results.

string? HouseNumber

House or building number. Present for address and interpolated results.

Boolean? Interpolated

Whether this result was estimated by address interpolation rather than an exact database match.

string? Name

Place name (raw). Present for reverse geocode place results.

Long? OsmID

OpenStreetMap element ID (null for interpolated results)

OsmType? OsmType

OSM element type (node, way, relation)

One of the following:
"node"Node
"way"Way
"relation"Relation
string? Postcode

Postal code. Present for reverse geocode address results.

Double? Score

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

minimum0
Source? Source

Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)

One of the following:
"structured"Structured
"bm25"Bm25
"fuzzy"Fuzzy
"address"Address
"place"Place
"interpolation"Interpolation
string? State

State or province name. Present for reverse geocode address results.

string? Street

Street name. Present for address and interpolated results.

string? Subcategory

POI subcategory. Present for place results.

IReadOnlyDictionary<string, string>? Tags

Raw OSM tags. Present for place results.

string? Wikipedia

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

required Type Type
required Type Type
class GeocodingFeature:

GeoJSON Feature representing a geocoding result. The geometry is always a Point. Properties include the formatted display name, OSM metadata, confidence score, and source type.

required GeoJsonGeometry Geometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

required Coordinates Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type

Geometry type

One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties

Geocoding result properties

required string DisplayName

Formatted address or place name

string? Category

POI category (e.g. restaurant, cafe, park). Present for place results.

string? City

City or town name. Present for address results.

Double? Confidence

Interpolation confidence (0-1). Present only for interpolated results.

maximum1
minimum0
string? Country

Country name. Present for reverse geocode address results.

string? CountryCode

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
Double? DistanceM

Distance from the query point in meters (reverse geocode / nearby only)

string? FullAddress

Complete formatted address from the database. Present for reverse geocode address results.

string? HouseNumber

House or building number. Present for address and interpolated results.

Boolean? Interpolated

Whether this result was estimated by address interpolation rather than an exact database match.

string? Name

Place name (raw). Present for reverse geocode place results.

Long? OsmID

OpenStreetMap element ID (null for interpolated results)

OsmType? OsmType

OSM element type (node, way, relation)

One of the following:
"node"Node
"way"Way
"relation"Relation
string? Postcode

Postal code. Present for reverse geocode address results.

Double? Score

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

minimum0
Source? Source

Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)

One of the following:
"structured"Structured
"bm25"Bm25
"fuzzy"Fuzzy
"address"Address
"place"Place
"interpolation"Interpolation
string? State

State or province name. Present for reverse geocode address results.

string? Street

Street name. Present for address and interpolated results.

string? Subcategory

POI subcategory. Present for place results.

IReadOnlyDictionary<string, string>? Tags

Raw OSM tags. Present for place results.

string? Wikipedia

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

required Type Type
class ReverseGeocodeResult:

GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: application/geo+json.

required IReadOnlyList<GeocodingFeature> Features

Reverse geocoding results ordered by distance

required GeoJsonGeometry Geometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

required Coordinates Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type

Geometry type

One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties

Geocoding result properties

required string DisplayName

Formatted address or place name

string? Category

POI category (e.g. restaurant, cafe, park). Present for place results.

string? City

City or town name. Present for address results.

Double? Confidence

Interpolation confidence (0-1). Present only for interpolated results.

maximum1
minimum0
string? Country

Country name. Present for reverse geocode address results.

string? CountryCode

ISO 3166-1 alpha-2 country code

maxLength2
minLength2
Double? DistanceM

Distance from the query point in meters (reverse geocode / nearby only)

string? FullAddress

Complete formatted address from the database. Present for reverse geocode address results.

string? HouseNumber

House or building number. Present for address and interpolated results.

Boolean? Interpolated

Whether this result was estimated by address interpolation rather than an exact database match.

string? Name

Place name (raw). Present for reverse geocode place results.

Long? OsmID

OpenStreetMap element ID (null for interpolated results)

OsmType? OsmType

OSM element type (node, way, relation)

One of the following:
"node"Node
"way"Way
"relation"Relation
string? Postcode

Postal code. Present for reverse geocode address results.

Double? Score

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

minimum0
Source? Source

Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)

One of the following:
"structured"Structured
"bm25"Bm25
"fuzzy"Fuzzy
"address"Address
"place"Place
"interpolation"Interpolation
string? State

State or province name. Present for reverse geocode address results.

string? Street

Street name. Present for address and interpolated results.

string? Subcategory

POI subcategory. Present for place results.

IReadOnlyDictionary<string, string>? Tags

Raw OSM tags. Present for place results.

string? Wikipedia

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

required Type Type
required Type Type