API overview¶
| Item | Current value |
|---|---|
| Base URL | https://api.opensoil.net |
| API version | v1 path, application version 0.1.0 |
| Maturity | Experimental |
| Authentication | None for current read-only routes |
| Response format | JSON |
| Technical source of truth | Generated OpenAPI schema |
| Interactive explorer | Swagger UI |
The /v1 namespace is the versioned external contract. The application version can change while the v1 contract evolves during its experimental period. Breaking changes will be recorded before a stable release and a formal deprecation window will accompany future stable version changes.
Design goals¶
- Make data kind explicit.
- Preserve original provider fields and citations.
- Keep raw payloads separate from normalized records.
- Record every transformation.
- Return provider failures as structured errors.
- Support independent browser dashboards without credentials.
Not in this release¶
Area and polygon queries, bulk downloads, pagination across stored collections, accounts, API keys, service-level guarantees, cross-provider comparison, and stable schemas are roadmap items. The current point query supports one working provider and at most eight properties per request.