JSON Response

When format: "json" (the default), the response body is a JSON object with the brand name, region filter, total count, and an array of location objects.

Response body

{
  "brand": "Starbucks",
  "region": "US, CA",
  "count": 3182,
  "locations": [
    {
      "id": "a1b2c3d4-...",
      "brand": "Starbucks",
      "name": "Starbucks",
      "address": "1912 Pike Pl, Seattle, WA 98101, US",
      "lat": 47.6097,
      "lng": -122.3425,
      "country": "US",
      "state": "WA",
      "city": "Seattle",
      "postcode": "98101",
      "phone": "+1-206-624-0173",
      "hours": "Mo-Su 06:00-21:00",
      "features": ["drive_through", "outdoor_seating", "internet_access"],
      "source": "osm",
      "osm_id": "node/123456789",
      "last_updated": "2026-04-03T17:23:28.022+00:00"
    }
  ]
}

Location fields

Field	Type	Description
`id`	string	Unique location identifier (UUID)
`brand`	string	Brand name
`name`	string	Location display name
`address`	string	Full street address
`lat`	number	Latitude
`lng`	number	Longitude
`country`	string	ISO 3166-1 alpha-2 country code
`state`	string	State or province code
`city`	string	City name
`postcode`	string	Zip/postal code (when available)
`phone`	string	Phone number (when available)
`hours`	string	Opening hours in OSM format (when available)
`features`	string[]	Location features (e.g. `drive_through`, `outdoor_seating`)
`source`	string	Data source identifier
`osm_id`	string	OpenStreetMap node/way ID
`last_updated`	string	ISO 8601 timestamp of last data update

Response headers

All responses

Header	Type	Description
`X-Location-Count`	number	Total locations returned
`X-Brand`	string	Brand name queried
`X-Region`	string	Region filter applied (e.g. `"CA, US"`) or `"global"`
`X-Credits-Charged`	number	Credits deducted for this request
`X-Credits-Remaining`	number	Credits remaining on your key
`X-Credits-Low`	boolean	Present and `true` when balance drops below 50

Rate limit headers

Header	Type	Description
`X-RateLimit-Limit`	number	Maximum requests per minute for your tier
`X-RateLimit-Remaining`	number	Requests remaining in the current window
`X-RateLimit-Reset`	number	Unix timestamp when the window resets

CSV and GeoJSON responses

When format is "csv", the response is a text/csv file with a Content-Disposition header for auto-download. Fields match the JSON location fields.

When format is "geojson", the response is an RFC 7946 GeoJSON FeatureCollection with each location as a Point feature. Properties include all location fields except lat and lng (which are in the geometry).

Parameters Image Response