Dotlas Data API
API Reference

List nearby outlets

Returns a brand's outlets within a radius of a point, nearest first. Pass the point as lat and lng, and an optional radius in kilometres (capped at 5). Useful for proximity and coverage analysis around a location.

GET/brands/{brandSlug}/outlets/nearby
AuthorizationBearer <token>

In: header

Path Parameters

brandSlugstring

Query Parameters

countryCodestring
Value in"ae" | "sa" | "kw" | "qa" | "bh" | "eg" | "jo" | "om" | "ma" | "kz" | "iq"
latnumber
lngnumber
radius?number
Range0 <= value <= 5
limit?integer
Range1 <= value
cursor?string

Response Body

curl -X GET "https://loading/v1/brands/string/outlets/nearby?countryCode=ae&lat=0&lng=0&radius=5&limit=1&cursor=string"
{
  "data": [
    {
      "restaurantId": "string",
      "brandSlug": "string",
      "city": "string",
      "area": "string",
      "neighbourhoodId": "string",
      "latitude": 0,
      "longitude": 0,
      "distanceKm": 0
    }
  ],
  "pageInfo": {
    "nextCursor": "string",
    "hasMore": true
  }
}
Empty
Empty
Empty
Empty
Empty