v1.0.0

service-geokoder

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Multi-provider geocoding API (forward/reverse)

Servers

https://api.dev.kalisio.xyz/geocoderDevelopment

---

Default

Operations

GET/healthcheckGET/capabilities/{operation}GET/forwardGET/reverse

---

Service health check

GET

/healthcheck

Authorizations

bearerAuth

Paste a Kalisio JWT access token to authorize requests sent through the API gateway.

Type

HTTP (bearer)

Responses

Service is up

Content-Type

application/json

{

  

"name": "geokoder",

  

"version": "1.2.0",

  

"buildNumber": "42"

}

GET

/healthcheck

Playground

Server

Authorization

bearerAuth

Samples

---

List available geocoding sources for a given operation

GET

/capabilities/{operation}

Authorizations

bearerAuth

Paste a Kalisio JWT access token to authorize requests sent through the API gateway.

Type

HTTP (bearer)

Parameters

Path Parameters

operation*

Geocoding operation

Type

string

Required

Valid values

"forward""reverse"

Responses

Available sources and i18n labels

Content-Type

application/json

{

  

"geocoders": [

  

  

[

  

  

  

"openstreetmap",

  

  

  

"opendatafrance",

  

  

  

"mairies:mairies",

  

  

  

"upstream:openstreetmap"

  

  

]

  

],

  

"i18n": {

  

}

}

GET

/capabilities/{operation}

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

operation*

Samples

---

Forward geocoding — address/place name to coordinates

GET

/forward

Authorizations

bearerAuth

Paste a Kalisio JWT access token to authorize requests sent through the API gateway.

Type

HTTP (bearer)

Parameters

Query Parameters

q*

Search query (address, place name, etc.)

Type

string

Required

Example"80 Chemin des Tournesols, 11400 Castelnaudary"

sources

Minimatch filter on source names. Supports wildcards (*, open*) and glob alternation ({openstreetmap,opendatafrance}).

Type

string

Example"open*"

Default

"*"

limit

Maximum number of results (capped by server paginate.max.forward)

Type

integer

Example5

Minimum

1

viewbox

Bounding box filter as lon1,lat1,lon2,lat2 (decimal degrees). Results outside the box are discarded.

Type

string

Example"1.891365,43.283502,2.010069,43.340896"

Responses

Array of GeoJSON Features sorted by relevance score

Content-Type

application/json

[

  

{

  

  

"type": "string",

  

  

"geometry": {

  

  

  

"type": "string",

  

  

  

"coordinates": [

  

  

  

  

[

  

  

  

  

  

1.9373,

  

  

  

  

  

43.2996

  

  

  

  

]

  

  

  

]

  

  

},

  

  

"properties": {

  

  

  

"formattedAddress": "80 Chemin des Tournesols, 11400 Castelnaudary",

  

  

  

"streetNumber": "80",

  

  

  

"streetName": "Chemin des Tournesols",

  

  

  

"city": "Castelnaudary",

  

  

  

"country": "France"

  

  

},

  

  

"geokoder": {

  

  

  

"source": "opendatafrance",

  

  

  

"match": "Chemin des Tournesols",

  

  

  

"matchProp": "label"

  

  

}

  

}

]

GET

/forward

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

q*

sources

limit

viewbox

Samples

---

Reverse geocoding — coordinates to address/place name

GET

/reverse

Authorizations

bearerAuth

Paste a Kalisio JWT access token to authorize requests sent through the API gateway.

Type

HTTP (bearer)

Parameters

Query Parameters

lat*

Latitude (decimal degrees)

Type

number

Required

Example43.2119

Format

"float"

lon*

Longitude (decimal degrees)

Type

number

Required

Example2.3531

Format

"float"

sources

Minimatch filter on source names. Supports wildcards and glob alternation.

Type

string

Example"mairies:mairies"

Default

"*"

limit

Maximum number of results (capped by server paginate.max.reverse)

Type

integer

Example5

Minimum

1

distance

Search radius in meters (provider-dependent)

Type

number

Example500

Format

"float"

Responses

Array of GeoJSON Features sorted by distance

Content-Type

application/json

[

  

{

  

  

"type": "string",

  

  

"geometry": {

  

  

  

"type": "string",

  

  

  

"coordinates": [

  

  

  

  

[

  

  

  

  

  

2.3531,

  

  

  

  

  

43.2119

  

  

  

  

]

  

  

  

]

  

  

},

  

  

"properties": {

  

  

  

"streetNumber": "80",

  

  

  

"streetName": "Chemin des Tournesols",

  

  

  

"city": "Castelnaudary",

  

  

  

"country": "France",

  

  

  

"formattedLabel": "Carcassonne"

  

  

},

  

  

"geokoder": {

  

  

  

"source": "mairies:mairies"

  

  

}

  

}

]

GET

/reverse

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

lat*

lon*

sources

limit

distance

Samples

---