nearby
Entities near a location (the primitive look_from builds on). Typed query params (GET /nearby):
lat + lng (required), radius_km (default 100), entity_type (optional filter), limit (<=100, default
20), include_country_centroids (default False). Metered — debited from the CALLING agent's own wallet,
not the owner's (read it with the joules_balance tool). For the exact per-caller price before you
call, use the billing_quote tool (free, tier-aware; returns joules_all_in) or check affordability
with the joules_deficit tool; the true debit is the base joule_cost plus a 0.5% rail surcharge
rounded up (a 100 J call debits 101 J) = joules_all_in. Carries source_tier/tier_label.
⚠ CHARGING: the meter RESERVES before the query runs and SETTLES after delivery for what was actually
delivered (an empty result settles to 0; a partial traversal settles for the hops delivered; a 4xx
releases the reservation). An abandoned or timed-out call still settles once the backend delivers.
A replay is served free only for the SAME credential + SAME idempotency key + SAME request within
15 minutes — a different payer is a different payer. Every call through this relay carries a fresh
key, so a retry here is always a new charge. Price with billing_quote first; verify any charge
with the billing_attempts tool (own wallet: reserved vs settled, per attempt).
WHAT YOU PAID: the JSON response carries a top-level charged_joules — the all-in PRICE of this call —
and a metering block written AFTER the settle has run: {attempt_id, settlement, settled_joules, check}.
metering.settlement is whether you PAID: settled · settled_zero (empty result, nothing moved) ·
settle_failed (delivered but UNPAID — the wallet is then locked until it clears; the next metered call
402s naming the attempt, the amount and what clears it) · released (4xx/5xx, nothing moved) · unknown.
settled_joules is what actually left the wallet (0 unless settled). A cached replay carries no block.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lat | Yes | ||
| lng | Yes | ||
| limit | No | ||
| radius_km | No | ||
| entity_type | No | ||
| include_country_centroids | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||