Geocoding
Geocoding - Retrieve structured geo-related data from user-input.
Geocoding
Geocoding - Retrieve structured geo-related data from user-input.
POST
/
experimental
/
geography
/
_geocoding
x-api-key
string
*
x-api-key
Required
string
API Key used to be authentified to these APIs. Please contact Fluximmo to get one
object
*
text
string
text
string
filters
object
filters
object
postalCodes
array
postalCodes
array
inseeCode
array
inseeCode
array
addressTypes
Cadastre cadastre = 4; repeated PoiType poi_types = 5 [(validate.rules).repeated .unique = true]; · array
addressTypes
array
context
object
context
object
location
object
location
object
lat
number
lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
lon
number
lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
withGeometry
repeated Index search_on = 5 [(validate.rules).repeated .unique = true]; · boolean
withGeometry
boolean
size
integer
size
integer
curl --request POST \
--url https://api.f6o.co/experimental/geography/_geocoding \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"text": "<string>",
"filters": {
"postalCodes": [
"<string>"
],
"inseeCode": [
"<string>"
],
"addressTypes": [
"UNKNOWN_ADDRESS_TYPE"
]
},
"context": {
"location": {
"lat": 123,
"lon": 123
}
},
"withGeometry": true,
"size": 123
}'{
"apiVersion": "<string>",
"kind": "<string>",
"items": [
{
"ID": "<string>",
"score": 123,
"kind": "<string>",
"address": {
"displayName": "<string>",
"importance": 123,
"type": "UNKNOWN_ADDRESS_TYPE",
"location": {
"postalCode": "<string>",
"inseeCode": "<string>",
"city": "<string>",
"coordinate": {
"lat": 123,
"lon": 123
},
"address": {
"number": "<string>",
"streetName": "<string>"
}
}
}
}
],
"internalDelay": 123
}Authorizations
x-api-key
string
headerrequiredAPI Key used to be authentified to these APIs. Please contact Fluximmo to get one
Body
application/json
text
string
filters
object
filters.postalCodes
string[]
filters.inseeCode
string[]
filters.addressTypes
enum<string>[]
Available options:
UNKNOWN_ADDRESS_TYPE, HOUSE_NUMBER_ADDRESS_TYPE, STREET_ADDRESS_TYPE, LOCALITY_ADDRESS_TYPE, MUNICIPALITY_ADDRESS_TYPE context
object
context.location
object
context.location.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
context.location.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
withGeometry
boolean
size
integer
Response
200 - application/json
apiVersion
string
kind
string
items
object[]
items.ID
string
items.score
number
items.kind
string
items.address
object
items.address.displayName
string
items.address.importance
number
items.address.type
enum<string>
default: UNKNOWN_ADDRESS_TYPEAvailable options:
UNKNOWN_ADDRESS_TYPE, HOUSE_NUMBER_ADDRESS_TYPE, STREET_ADDRESS_TYPE, LOCALITY_ADDRESS_TYPE, MUNICIPALITY_ADDRESS_TYPE items.address.location
object
items.address.location.postalCode
string
items.address.location.inseeCode
string
items.address.location.city
string
items.address.location.coordinate
object
items.address.location.coordinate.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
items.address.location.coordinate.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
items.address.location.address
object
items.address.location.address.number
string
items.address.location.address.streetName
string
internalDelay
integer
Was this page helpful?
curl --request POST \
--url https://api.f6o.co/experimental/geography/_geocoding \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"text": "<string>",
"filters": {
"postalCodes": [
"<string>"
],
"inseeCode": [
"<string>"
],
"addressTypes": [
"UNKNOWN_ADDRESS_TYPE"
]
},
"context": {
"location": {
"lat": 123,
"lon": 123
}
},
"withGeometry": true,
"size": 123
}'{
"apiVersion": "<string>",
"kind": "<string>",
"items": [
{
"ID": "<string>",
"score": 123,
"kind": "<string>",
"address": {
"displayName": "<string>",
"importance": 123,
"type": "UNKNOWN_ADDRESS_TYPE",
"location": {
"postalCode": "<string>",
"inseeCode": "<string>",
"city": "<string>",
"coordinate": {
"lat": 123,
"lon": 123
},
"address": {
"number": "<string>",
"streetName": "<string>"
}
}
}
}
],
"internalDelay": 123
}