Start an async run
start_runSubmit work too large for one call as an asynchronous run in the caller's account: it returns a run id at once and get_run reports progress and pages the results. kind=batch: up to 2000 locations with the same fields, processed in plan-sized batches; fetch_batch is the synchronous form for up to the plan's batch size (10 on Free, 100 on paid plans) with results in the same response. kind=enrich: up to 1000 parcel locators, like parcel_enrich; kind=search: one parcel_search body walked page by page up to max_pages. Output: the run object (id like run_..., status queued, estimated_max_lookups, lookups_held, status_url and results_url). Cost: metered like the underlying calls (batch 1 lookup per location per 50 fields; enrich 5 per matched parcel plus point fields; search 25 per page with results). The worst case, or max_lookups if lower, is held upfront and the unused part is refunded when the run ends; the run stops before spending more than max_lookups. Results are kept 7 days after the run ends. Errors: run_input_missing, invalid_locator, too_many_rows, no_fields_requested, state_required, too_many_active_runs (2 at once), quota_exhausted (with the hold needed).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | batch (needs locations and fields/preset), enrich (needs items) or search (needs search). | |
| items | No | kind=enrich: up to 1000 parcel locators, each exactly one of {lat, lng}, {address}, {parcel_id} or {apn, state} (optional county). | |
| fields | No | Field names for kind=batch, or point fields at each parcel centroid for kind=enrich; up to 50 besides the preset. | |
| preset | No | Preset name from list_presets for kind=batch or kind=enrich, combined with fields. | |
| search | No | kind=search: a parcel_search argument object (state, or bbox/polygon, required; limit up to 100 per page). | |
| locations | No | kind=batch: up to 2000 places, each with lat+lng or address. | |
| max_pages | No | kind=search: pages to walk, 1 to 40 (default 10); the run stops early when pages run out. | |
| max_lookups | No | Optional spending cap for the whole run; it is also the upfront hold when lower than the estimate. |