deposits
Search resource deposits (relays GET /api/v1/deposits). Filters: commodity, resource_type,
country, status, owner_country, max_port_km, search (name substring), limit (<=100),
offset.
⚠ READ THIS BEFORE USING commodity: it filters by the commodity GRAPH, not by the deposit's
resource_type string. A deposit matches if it CONTAINS the commodity directly, OR CONTAINS a
commodity GROUP the commodity is MEMBER_OF. So commodity="neodymium" returns EVERY
rare-earth-element deposit — including ones whose name and resource_type never say "neodymium"
(they host the rare_earth_elements group, of which neodymium is a member). That is correct, not a
broken filter. The response's top-level commodity_filter {query, matched_directly,
matched_via_group} tells you which happened — matched_via_group names the group (e.g.
"rare_earth_elements") when the match came through it. Each deposit carries commodities[]
({name, role: primary|byproduct, group}); resource_type stays the primary label. Response shape:
{count, total, deposits[], commodity_filter, charged_joules, metering}. Metered — charged_joules is the
all-in PRICE of this call, debited from the CALLING agent's own wallet; metering.settlement /
metering.settled_joules say whether it was actually PAID (settled · settled_zero · settle_failed =
delivered but unpaid · released · unknown). Quote first with billing_quote("/api/v1/deposits"). Same as the
SDK deposits(commodity=...).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| search | No | ||
| status | No | ||
| country | No | ||
| commodity | No | ||
| max_port_km | No | ||
| owner_country | No | ||
| resource_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||