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
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"
}'
Enter your API key to send
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 send requests.
  2. Set parameters — start with just a brand name. Add country, state, or city filters to narrow results.
  3. Switch format to png or jpeg to reveal map rendering and Focus Mode options.
  4. Review the request in the cURL or JavaScript tab (right panel). Click Copy to grab it.
  5. Click Send Request to execute the call. The response body and headers appear below.

Tips

  • Switching format to png reveals the full map rendering parameter set (width, height, style, markers, heatmap, Focus Mode).
  • The focus_region dropdown is only enabled when focus_country is set to US.
  • 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