Convert Geographic Reference
convert_referenceConvert geographic identifiers or names between reference systems within one declared country, global, or marine scope using loc_id or a published crosswalk for reliable joins.
Instructions
Convert within one declared scope per call: iso3 is required and names one ISO3 country, GLOBAL, or MARINE. A batch uses one from_system, to_system, and crosswalk_id, with at most 25000 requested result rows. Convert X -> loc_id -> Y; omit to_system to enter the loc_id universe. For admin or city names use from_system admin_boundary with a country_hint inside the declared country. A published direct crosswalk uses one selected artifact; if the system pair has multiple artifacts, supply crosswalk_id from the typed ambiguity error. An exact miss ends on that artifact. Use get_geography when family or scope coverage is unknown. The tools/list access metadata states authored free, account, and paid item allowances; active operator policy may waive payment.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| iso3 | No | Required scope pack for the entire call: one ISO3 country, GLOBAL, or MARINE. Every item must stay within this scope. | |
| as_of | No | ISO date or year used for time-bounded identities. | |
| items | No | Reference conversions within one scope and one source/target/crosswalk route. Split mixed routes. Maximum requested item count times per-item limit is 25000. | |
| limit | No | Maximum ranked output references to return. Default 10. | |
| value | No | Identifier or name in the input system, for example 'Springfield, Illinois' with admin_boundary. | |
| batch_id | No | Optional caller-supplied batch id for tracing. | |
| min_share | No | Optional minimum overlap share threshold. | |
| to_system | No | Optional output reference system. Defaults to DaedalMap loc_id; provide zcta, nws_fire, overlay_nws_public_zone, overlay_tribal, admin_local, or another catalog system for any-to-any conversion. | daedalmap.loc_id |
| request_id | No | Optional caller-supplied request id for tracing. | |
| from_system | No | Input reference system, such as admin_boundary (admin and city names; admin_text and place_name are accepted aliases), zip, overlay_zcta, nws_fire, tribal, or loc_id. | |
| country_hint | No | Optional country hint for admin/name resolution (USA), or a subdivision to search within (USA-OR). Names may also carry their parent: 'Washington County, Oregon'. Ambiguous names return candidates instead of a match. | |
| crosswalk_id | No | Exact published crosswalk ID when the source/target system pair has multiple artifacts. A route ambiguity error lists valid IDs. | |
| admin_level_hint | No | Optional admin-level hint for admin/name resolution. | |
| target_admin_level | No | Admin level used as the intermediate crosswalk target. Default admin_2. | |
| relationship_vintage | No | Optional source relationship vintage to require. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | ||
| from | No | ||
| error | No | ||
| loc_id | No | ||
| reason | No | ||
| results | No | ||
| batch_id | No | ||
| guidance | No | ||
| warnings | No | ||
| next_step | No | ||
| to_system | No | ||
| item_count | No | ||
| request_id | No | ||
| from_system | No | ||
| clarification | No | ||
| meter_receipt | No | ||
| converted_count | No | ||
| unconverted_count | No | ||
| settlement_receipt | No |