map_viewport
Map lane: everything inside a bounding box — THE SCREEN (relays GET /api/v1/map.viewport). Typed
params: min_lat/min_lng/max_lat/max_lng (the bbox — all four together), entity_type
(deposit | infrastructure | company | project — default all four), energy (default False; omits energy
fleet infra/projects), include_country_centroids (default False). Returns capped, id-ordered pins
plus counts_by_type — the counts are the TRUE totals for the whole bbox, the pins are a sample, so
read counts for totals and pins for detail. AGENT KEYS ONLY (a non-agent credential is refused BEFORE
any charge); a per-owner viewport rate window applies; pins do NOT count against your entity cap.
Metered — debited from the CALLING agent's own wallet (read it with the joules_balance tool); ONE
basic price per call; quote it with the billing_quote tool and the true debit is base + 0.5% rail
surcharge = joules_all_in. Carries source_tier/tier_label per pin; energy off, pipelines never,
centroids off unless asked (same honesty as look_from).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| energy | No | ||
| max_lat | No | ||
| max_lng | No | ||
| min_lat | No | ||
| min_lng | No | ||
| entity_type | No | ||
| include_country_centroids | No |