Skip to content
TarekyDocs
Console

Public API: the most important active POIs inside a bounding box, for the map viewport (metered)

GET
/v1/poi/in-bounds
curl --request GET \
  --url 'https://api.tareky.com/v1/poi/in-bounds?minLng=1&minLat=1&maxLng=1&maxLat=1&take=500' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
minLng
required
number
>= -180 <= 180
minLat
required
number
>= -90 <= 90
maxLng
required
number
>= -180 <= 180
maxLat
required
number
>= -90 <= 90
categoryId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
take
integer
default: 500 >= 1 <= 2000

How many places to return: the most important take in the box.

filters
string

JSON, specific to categoryId, e.g. {“accessType”:“PUBLIC”,“minPowerKw”:22} for EV charging. 400 invalid_request when malformed; ignored for a category with no filters.

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
data
required
Array<object>
object
id
required
string
lng
required
number
lat
required
number
categoryId
required
string | null
name
required
object
ar
required
string | null
en
required
string | null
ckb
required
string | null
category
required
object
id
required
string
name
required
object
ar
required
string | null
en
required
string | null
ckb
required
string | null
avgRating
required

Mean review rating, 0 when there are no reviews

number
reviewCount
required
integer
>= -9007199254740991 <= 9007199254740991
importance
required

Rank of the place on a crowded map (the category weight, higher for a vetted place); read it only as relative, rows arrive in this order

integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "data": [
    {
      "id": "example",
      "lng": 1,
      "lat": 1,
      "categoryId": "example",
      "name": {
        "ar": "example",
        "en": "example",
        "ckb": "example"
      },
      "category": {
        "id": "example",
        "name": {
          "ar": "example",
          "en": "example",
          "ckb": "example"
        }
      },
      "avgRating": 1,
      "reviewCount": 1,
      "importance": 1
    }
  ]
}

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"
}