Skip to content
TarekyDocs
Console

Public API: resolve a place name to coordinates (metered)

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
required
string
>= 1 characters <= 120 characters
limit
integer
default: 10 >= 1 <= 25
proximity
string

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
query
required
string
results
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: poi admin street plus_code
name
required
object
ar
required
string | null
en
required
string | null
ckb
required
string | null
lng
required
number
lat
required
number
relevance
required
number
distanceMeters
required
number | null
Example
{
  "results": [
    {
      "kind": "poi"
    }
  ]
}

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