Skip to content
TarekyDocs
Console

Public API: search for places by name (metered)

GET
/v1/locations/search
curl --request GET \
  --url 'https://api.tareky.com/v1/locations/search?query=example&limit=10' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
query
required
string
>= 1 characters
lng
number
>= -180 <= 180
lat
number
>= -90 <= 90
limit
integer
default: 10 >= 1 <= 20

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
Array<object>
object
id
required
string
kind
required
string
Allowed values: poi admin street plus_code
distanceMeters
required

From lng/lat, when both were given

number | null
name
required

Arabic name, else English, else empty

string
description
required

English name, else Arabic, else empty

string
lat
required
number
lng
required
number
zoom
required

An admin area’s stored map zoom, which is approximate; null for every other kind

number | null
category
required

A place’s category; null for every other kind, and for the catch-all General category

object
id
required
string
name
required
object
ar
required
string | null
en
required
string | null
ckb
required
string | null
area
required

The smallest admin area the result lies in (a street by its midpoint); for an admin area, its parent

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; null for a governorate

object
id
required
string
name
required
object
ar
required
string | null
en
required
string | null
ckb
required
string | null
adminLevel
required

The level of an admin row; null for every other kind

string
nullable
Allowed values: governorate district area
bbox
required

[minLng, minLat, maxLng, maxLat] of an admin area’s polygon or a street’s line, ready for fitBounds; else null

array
nullable >= 4 items <= 4 items
Example
{
  "place": [
    {
      "kind": "poi",
      "area": {
        "level": "governorate"
      },
      "adminLevel": "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"
}