Skip to main content
GET
Resolve Free Address

Authorizations

X-Api-Key
string
header
required

Query Parameters

address
string
required

Free-form address string to resolve.

Response

200 - application/json

Detected area object based on provided address.

AI is used to resolve the provided address and detect the geographic area.

ATTENTION: Area detection will fail if the address is unclear or not specific enough.

id
integer
required
read-only
code
string
required
read-only
tags
string
required
read-only
area_group
object | null
required

Minimal serializer for area_group reference in Area.

name_ar
string
Maximum string length: 200
name_en
string
Maximum string length: 200
district
string
Maximum string length: 50
lat
string<decimal> | null
Pattern: ^-?\d{0,3}(?:\.\d{0,15})?$
long
string<decimal> | null
Pattern: ^-?\d{0,3}(?:\.\d{0,15})?$
Maximum string length: 200
is_external
boolean