API Playground

Build requests interactively, see the generated code, and send them with your API key. Parameters on the left, request preview and response on the right.

💡

Your API key is never stored or transmitted anywhere except directly to the BrandMappr API. It stays in your browser session only.

POST/api/v1/location-mapInteractive
Authentication
x-api-key
Core
brand REQ
country
state
city
postcode
radius_km
format
tickers
Map Rendering
width
height
style
marker_color#FF0000
marker_radius
Viewport
zoom
center
bounds
padding
Focus Map
focus_country
REQUEST
curl -X POST https://api.brandmappr.com/api/v1/location-map \
  -H "x-api-key: bm_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
  "brand": "Starbucks",
  "country": "US",
  "format": "png"
}' \
  --output map.png
Enter your API key to send full request — or use "Check brand" without one
RESPONSE

Response will appear here after you send a request.

How to use

  1. Enter your API key in the Authentication section (left panel). You need a real key to render a map image.
  2. Set parameters — start with just a brand name. Add country, state, or city filters to narrow the map.
  3. Adjust map rendering — width, height, style, marker color, legend, and heatmap.
  4. Review the request in the cURL or JavaScript tab (right panel). Click Copy to grab it.
  5. Click Send Request to render the map image — or Check brand (free) to see whether a brand is in our data, no API key needed.

Tips

  • Check brand (free) returns a count, last-updated date, and a small sample — no API key, no credits charged.
  • Image responses render inline. You can right-click to save the map.
  • The response Headers tab shows X-Location-Count, X-Render-Time, and rate limit headers.
Getting StartedEndpoint