Skip to content
TarekyDocs
Console

Public API: place name at a coordinate (metered)

GET
/v1/locations/reverse-geocode
curl --request GET \
  --url 'https://api.tareky.com/v1/locations/reverse-geocode?lat=1&lng=1&lang=ar' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
lat
required
number
lng
required
number
lang
string
default: ar
Allowed values: ar en ckb

Header Parameters

Section titled “Header Parameters”
x-access-key-id
string

Legacy key id (until its sunset)

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
place
required

The nearest place or area name in the requested lang, falling back to Arabic and then English; null outside every known area

string
nullable
street
required

The nearest named street within 60 m, in the requested lang (Arabic where it has no name in it); never an alley code such as 214-109

string
nullable
address
required

Street, subdistrict, district, city: finest first, each in the requested lang (Arabic where it has no name in it); joined with the Arabic comma, or with “, “ for lang=en

string
nullable
plusCode
required

The 10-digit Open Location Code of the point (a ~14 m cell)

string
label
required

The name to show for the point, never null. First match wins: a named POI within 50 m, a named street within 60 m, a named POI within 200 m (near: true), the smallest containing area, the plus code.

object
source
required

What the label names

string
Allowed values: poi street admin plus_code
id
required

The POI, street or admin row; null for a plus code

string | null
name
required
object
ar
required
string | null
en
required
string | null
ckb
required
string | null
distanceMeters
required

To the POI or street; null for an area or a plus code

number | null
near
required

True when the label is a POI 50-200 m away: show it as “near X”

boolean
area
required

The smallest admin area containing the point

object
id
required
string
name
required
object
ar
required
string | null
en
required
string | null
ckb
required
string | null
level
required
string
Allowed values: governorate district area
region
required

The governorate, when it is not already area

object
id
required
string
name
required
object
ar
required
string | null
en
required
string | null
ckb
required
string | null
Example
{
  "label": {
    "source": "poi"
  },
  "area": {
    "level": "governorate"
  }
}

429

Section titled “429”

Rate limit or monthly quota exceeded; see Retry-After

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable code, e.g. quota_exceeded, no_route

string
message
required
string
status
required
integer
>= -9007199254740991 <= 9007199254740991
details

For invalid_request: the validation issues

docsUrl
required
string
requestId
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}

default

Section titled “default”

Any other error, in the /v1 error envelope

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable code, e.g. quota_exceeded, no_route

string
message
required
string
status
required
integer
>= -9007199254740991 <= 9007199254740991
details

For invalid_request: the validation issues

docsUrl
required
string
requestId
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}