Maps keys, limits and endpoints
Create and revoke Maps keys, pick live or test, set rate limits, and see which endpoints are available.
Maps keys are separate from your project API keys. A Maps key can only call Maps, so it is safer to ship inside a mobile or web app.
Create a key
- Open Maps & Geo (your project must be approved: see Maps: get access and make your first request).
- Choose New Maps API Key or Generate Key.
- Enter a Key Name / Description, for example "iOS app".
- Pick an Environment Tier: Live (Production:
pgb_map_live_...) or Test (Staging:pgb_map_test_...). - Set the Rate Limit (Requests / Minute). The default is 600.
- Choose Generate Token.
The new token is shown in a Maps API Token Generated window with Copy Token. Copy it now, and store it where your app can read it, such as an environment variable.
Manage keys
The PGB Maps API Keys table lists each key's Name, API Token / Key (masked until you reveal it), Tier, Rate Limit, Created date, and a Revoke button. Revoke a key as soon as it is exposed or no longer needed. Anything using it stops working immediately.
If your project has no key, the page can issue a default public key the first time an app asks for one.
Sending the key
Any of these works:
?access_token=<key>or?key=<key>on the address (what map libraries do)Authorization: Bearer <key>X-PGB-Key: <key>header
What you can call
All paths start with https://<your-project>.pgbhub.app/maps.
| Area | Path |
|---|---|
| Place search (forward geocoding) | /geocoding/v5/mapbox.places/{query}.json |
| Reverse geocoding | /search/geocode/v6/reverse?latitude=...&longitude=... |
| Search suggestions (autocomplete) | /search/searchbox/v1/suggest |
| Search result details | /search/searchbox/v1/retrieve/{id} |
| Directions | /directions/v5/mapbox/{profile}/{coordinates} |
| Travel-time matrix | /directions-matrix/v5/mapbox/{profile}/{coordinates} |
| Map style | /styles/v1/{owner}/{style_id} |
| Map tiles | /styles/v1/mapbox/{style_id}/tiles/{256 or 512}/{z}/{x}/{y} |
| Fetch your public token and base address | /mapbox-token |
Profiles are driving-traffic (live congestion), driving, walking and cycling. Directions can return steps, alternatives and congestion annotations through the usual query options.
Set up your app
Keep your base address and key in configuration, so you can change them without a new release:
PGB_MAPS_URL=https://my-project.pgbhub.app/maps
If you are replacing another map provider, you usually change only the base address and the token.
Good to know
- Rate limits are per key, per minute. Over the limit, requests are refused until the minute passes.
- Use Test keys while you build and Live keys in production.
- Counts on the Maps page include search and routing separately.