Getting Started

Getting Started

Sign Up and Make Your First Call

Get your API key

Sign up at brandmappr.com/signup (opens in a new tab) to get your API key. You start with 100 free credits.

Add your key to requests

Include the x-api-key header on every request. Keys follow the format bm_live_ followed by 24 hex characters.

x-api-key: bm_live_your_api_key_here

Make your first call

curl -X POST https://api.brandmappr.com/api/v1/location-map \
  -H "x-api-key: bm_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"brand":"Starbucks"}'

Authentication

All requests require an API key in the x-api-key header.

⚠️

Security: Never expose your API key in client-side code. Keep it server-side or in environment variables.

Base URL

https://api.brandmappr.com

All endpoints use POST with a JSON body and Content-Type: application/json.

Credits

Credits are charged based on the number of locations returned and the response format (1–8 base credits, with a 2x multiplier for image renders). You start with 100 free credits. See Billing & Credits for the full tier table and cost examples.

The X-Credits-Low response header appears when your balance drops below 50 credits.

IntroductionAPI Playground +