POST
/
experimental
/
geography
/
_geocoding
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
header
required

API Key used to be authentified to these APIs. Please contact Fluximmo to get one

Body

application/json
​
text
string
​
filters
object
​
context
object
​
withGeometry
boolean
​
size
integer

Response

200
application/json
A successful response.
​
apiVersion
string
​
kind
string
​
items
object[]
​
internalDelay
integer

Was this page helpful?