Endpoint Reference
POST /api/v1/location-map
Query brand locations by name with optional geographic filters. Returns JSON data or a rendered map image depending on the format parameter.
Request format
Send a JSON body with Content-Type: application/json. The brand parameter is required. Everything else is optional.
{
"brand": "Starbucks",
"country": "US",
"state": "CA",
"format": "json"
}Response formats
| Format | Content-Type | Description |
|---|---|---|
json (default) | application/json | Structured location data |
png | image/png | Rendered map image (lossless) |
jpeg | image/jpeg | Rendered map image (compressed) |
See Parameters for the full parameter reference, JSON Response for the data format, and Image Response for map rendering details.
GET /api/v1/brands
Search and browse all available brands with location counts and ticker mappings. No API key required.
GET https://api.brandmappr.com/api/v1/brands (opens in a new tab)Query parameters
| Param | Type | Default | Description |
|---|---|---|---|
q | string | — | Search filter (case-insensitive substring match) |
limit | integer | 50 | Max results per page (1–500) |
offset | integer | 0 | Pagination offset |
sort | string | "count" | Sort by "count" (highest first) or "name" (A–Z) |
Example request
curl "https://api.brandmappr.com/api/v1/brands?q=star&limit=5"Example response
{
"total": 12,
"limit": 5,
"offset": 0,
"count": 5,
"brands": [
{ "brand": "Starbucks", "ticker": "SBUX", "location_count": 18197 },
{ "brand": "Starwood", "ticker": null, "location_count": 342 },
{ "brand": "Star Market", "ticker": null, "location_count": 89 },
{ "brand": "Coinstar", "ticker": null, "location_count": 684 },
{ "brand": "Kwik Star", "ticker": null, "location_count": 59 }
]
}Use this endpoint to check brand availability before making location queries.