Overview
The Farm Primary Data API is the primary data ingestion layer for all farm-level information on the platform. It provides a programmatic interface for creating and maintaining farm records, designed to accommodate the practical realities of agricultural data collection — where information arrives from multiple sources, across multiple timeframes, and rarely all at once.
Purpose
Every downstream process on the platform — agronomic analysis, compliance reporting, operational planning — depends on accurate farm data. This API exists to make collecting that data as frictionless as possible, so integrations can be built without being blocked by incomplete information at any stage.
Design principles
Flexibility first. Any field can be submitted or updated at any time, in any order, independently of other fields. There are no cross-field validation rules. A farm record can be created with minimal data and enriched progressively over time.
Type integrity over strict validation. The only enforced constraint is that each field must be submitted in its defined type format. This keeps the API predictable without imposing rigid submission requirements.
Completeness as a separate concern. Writing data and assessing its completeness are intentionally decoupled. The completeness endpoint is a standalone audit tool — it does not gate or influence any write operation.
Who uses this API
| Stakeholder | How they use it |
|---|---|
| Integration engineers | Connect internal or partner systems to push farm data programmatically |
| Field data operators | Upload and update farm records as information is collected on the ground |
| Data quality teams | Use the completeness endpoint to monitor and drive data collection progress |
| Platform and operations teams | Assess data coverage across the farm portfolio |
What this documentation covers
This documentation includes a full API Reference with live endpoint testing, Guides covering authentication, the flexibility model, type formats, and completeness scoring, and Recipes with end-to-end workflow examples for the most common integration patterns.
