API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Geocode

Forward geocode an address

GET/api/v1/geocode

Reverse geocode a coordinate

GET/api/v1/geocode/reverse

Autocomplete a partial address

GET/api/v1/geocode/autocomplete

Batch geocode multiple addresses

POST/api/v1/geocode/batch

ModelsExpand Collapse

AutocompleteResult = object { features, type }

GeoJSON FeatureCollection of autocomplete suggestions

features: array of GeocodingFeature { geometry, properties, type }

geometry: GeoJsonGeometry { coordinates, type }

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

array of number

array of array of number

array of array of array of number

array of array of array of array of number

type: "Point" or "LineString" or "Polygon" or 3 more

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: object { country_code, display_name, distance_m, 4 more }

country_code: optional string

ISO 3166-1 alpha-2 country code

display_name: optional string

Formatted address or place name

distance_m: optional number

Distance in meters

osm_id: optional number

OpenStreetMap ID

osm_type: optional string

OSM element type

score: optional number

Match confidence score

source: optional string

Result source (address, place, interpolation)

type: "Feature"

type: "FeatureCollection"

GeocodeResult = object { features, type }

GeoJSON FeatureCollection of geocoding results

features: array of GeocodingFeature { geometry, properties, type }

geometry: GeoJsonGeometry { coordinates, type }

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

array of number

array of array of number

array of array of array of number

array of array of array of array of number

type: "Point" or "LineString" or "Polygon" or 3 more

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: object { country_code, display_name, distance_m, 4 more }

country_code: optional string

ISO 3166-1 alpha-2 country code

display_name: optional string

Formatted address or place name

distance_m: optional number

Distance in meters

osm_id: optional number

OpenStreetMap ID

osm_type: optional string

OSM element type

score: optional number

Match confidence score

source: optional string

Result source (address, place, interpolation)

type: "Feature"

type: "FeatureCollection"

GeocodingFeature = object { geometry, properties, type }

geometry: GeoJsonGeometry { coordinates, type }

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

array of number

array of array of number

array of array of array of number

array of array of array of array of number

type: "Point" or "LineString" or "Polygon" or 3 more

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: object { country_code, display_name, distance_m, 4 more }

country_code: optional string

ISO 3166-1 alpha-2 country code

display_name: optional string

Formatted address or place name

distance_m: optional number

Distance in meters

osm_id: optional number

OpenStreetMap ID

osm_type: optional string

OSM element type

score: optional number

Match confidence score

source: optional string

Result source (address, place, interpolation)

type: "Feature"

ReverseGeocodeResult = object { features, type }

GeoJSON FeatureCollection of reverse geocoding results

features: array of GeocodingFeature { geometry, properties, type }

geometry: GeoJsonGeometry { coordinates, type }

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

array of number

array of array of number

array of array of array of number

array of array of array of array of number

type: "Point" or "LineString" or "Polygon" or 3 more

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: object { country_code, display_name, distance_m, 4 more }

country_code: optional string

ISO 3166-1 alpha-2 country code

display_name: optional string

Formatted address or place name

distance_m: optional number

Distance in meters

osm_id: optional number

OpenStreetMap ID

osm_type: optional string

OSM element type

score: optional number

Match confidence score

source: optional string

Result source (address, place, interpolation)

type: "Feature"

type: "FeatureCollection"