Climate FieldView Platform APIs
Last Modified: Wed Jan 4 12:47:29 UTC 2023 All endpoints are only accessible via HTTPS. * All API endpoints are located at https://platform.climate.com (e.g.…
Data & analytics#openapi#open-data
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Last Modified: Wed Jan 4 12:47:29 UTC 2023
All endpoints are only accessible via HTTPS.
- All API endpoints are located at
https://platform.climate.com(e.g.
https://platform.climate.com/v4/fields).
- The authorization token endpoint is located at
https://api.climate.com/api/oauth/token.
Troubleshooting
X-Http-Request-Id response header will be returned on every call,
successful or not. If you experience an issue with our api and need
to contact technical support, please supply the value of the X-Http-Request-Id
header along with an approximate time of when the request was made.
Request Limits
When you’re onboarded to Climate’s API platform, your x-api-key is assigned a custom usage plan. Usage plans are unique to each partner and have the following key attributes:
- Throttling information
- burstLimit: Maximum rate limit over a period ranging from 1 second to a few seconds
- rateLimit: A steady-state rate limit
- Quota information
- Limit: The maximum number of requests that can be made in a given month
When the request rate threshold is exceeded, a 429 response code is returned. Optionally, the Retry-After header may be returned:
Following are examples of rate limit errors:
- Rate limit exceeded:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 32
{"message":"Too Many Requests"}
- Quota exhausted:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 29
{"message":"Limit Exceeded"}
Pagination
Pagination is performed via headers. Any request which returns a "results"
array may be paginated. The following figure shows how query results are laid out with
X-Limit=4 and no filter applied.
- If there are no results, a response code of
304will be returned.
- If the response is the last set of results, a response code of
200or
206 will be returned.
- If there are more results, a response code of
206will be returned.
- If
X-Next-Tokenis provided in the request headers but the token has
expired, a response code of 409 will be returned. This is only applicable
for some endpoints; see specific endpoint documentation below.
X-Limit
The page size can be controlled with the X-Limit header. Valid values are1-100 and defaults to 100.
X-Next-Token
If the results are paginated, a response header of X-Next-Token will be
returned. Use the associated value in the subsequent request (via the X-Next-Token
request header) to retrieve the next page. The following sequence diagram shows how to
use X-Next-Token to fetch all the records.
Chunked Uploads
Uploads larger than 5MiB (5242880 bytes) must be done in 5MiB chunks
(with the exception of the final chunk). Each chunk request MUST contain aContent-Range header specifying the portion of the upload, and a Content-Type
header specifying binary content type (application/octet-stream). Range
uploads must be contiguous. The maximum upload size is capped at 500MiB (524288000 bytes).
Chunked Downloads
Downloads larger than 5MiB (5242880 bytes) must be done in 1-5MiB
chunks (with the exception of the final chunk, which may be less than 1MiB).
Each chunk request MUST contain a Range header specifying the requested portion of the download,
and an Accept header specifying binary and json content types (application/octet-stream,application/json)
or all content types (*/*).
Drivers
If you need drivers to process agronomic data, download the ADAPT plugin below. We only support the plugin in the Windows environment, minimum is Windows 7 SP1.
For asPlanted, asHarvested and asApplied data:
Release notes can be found here.
Download and use of the ADAPT plugin means that you agree to the EULA for use of the ADAPT plugin.
Please review the EULA (last updated on June 6th, 2019) before download and use of the ADAPT plugin.
For more information, please refer to:
Sample Test Data
Sample agronomic data:
To upload the sample data to your account, please follow the instructions in this…
Endpoints 26
Boundaries
- POSTUpload a boundary
/v4/boundariesUpload a Boundary entry by passing the geometry of the boundary. This will store the boundary but will not create field in Climate FieldView and will not link… - POSTRetrieve Boundaries in batch
/v4/boundaries/queryRetrieve multiple Boundaries (up to 10 per request). - GETRetrieve a Boundary by ID
/v4/boundaries/:boundaryIdRetrieve a Boundary by ID.
Fields
- GETRetrieve list of Fields
/v4/fields?fieldName=stringRetrieve list of Fields. Filter the results by field name if the fieldName query parameter is specified. - GETRetrieve list of all Fields the user has access to.
/v4/fields/all?fieldName=stringRetrieve all fields the authenticated user has access to, including fields shared with the authenticated user from other resource owners. Filter the results… - GETRetrieve a specific Field by ID
/v4/fields/:fieldIdRetrieve a given Field by ID.
Uploads
- POSTInitiate a new upload
/v4/uploadsStep one in uploading a data product. The method will return an Upload ID which the caller will use in subsequent PUT requests. The following contentTypes may… - POSTRetrieve Upload statuses in batch
/v4/uploads/status/queryCheck the status of multiple Uploads (up to 100 per request). - PUTChunked upload of data
/v4/uploads/:uploadIdSend chunked data for an Upload. - GETRetrieve Upload status
/v4/uploads/:uploadId/statusCheck the status of an Upload by ID.
Exports
- POSTInitiate a new export request.
/v4/exportsStep one in requesting a data product. The method will return an Export ID which the caller will use in subsequent GET requests. The following contentTypes… - GETRetrieve the binary contents of a processed export request.
/v4/exports/:exportId/contentsDownloads larger than 5MiB (5242880 bytes) in size must be downloaded in chunks no larger than 5MiB (5242880 bytes) and no smaller than 1MiB (1048576 bytes).… - GETRetrieve the status of an Export.
/v4/exports/:exportId/statusCheck the status of an Export by ID.
Layers
- GETRetrieve a list of application activities
/v4/layers/asApplied?resourceOwnerId=3fa85f64-5717-4562-b3fc-2c963f66afa6&occurredAfter=2024-01-01T00:00:00Z&occurredBefore=2024-01-01T00:00:00Z&updatedAfter=2024-01-01T00:00:00ZRetrieve a list of application activities. The id in the response is used for GET /v4/layers/asApplied/{activityId}/contents. - GETRetrieve the raw application activity
/v4/layers/asApplied/:activityId/contentsRetrieve an individual application activity by id. Ids are retrieved via the /layers/asApplied route. Downloads larger than 5MiB (5242880 bytes) in size, must… - GETRetrieve a list of harvest activities
/v4/layers/asHarvested?resourceOwnerId=3fa85f64-5717-4562-b3fc-2c963f66afa6&occurredAfter=2024-01-01T00:00:00Z&occurredBefore=2024-01-01T00:00:00Z&updatedAfter=2024-01-01T00:00:00ZRetrieve a list of harvest activities. The id in the response is used for GET /v4/layers/asHarvested/{activityId}/contents. - GETRetrieve the raw harvest activity
/v4/layers/asHarvested/:activityId/contentsRetrieve an individual harvest activity by id. Ids are retrieved via the /layers/asHarvested route. Downloads larger than 5MiB (5242880 bytes) in size, must… - GETRetrieve a list of planting activities
/v4/layers/asPlanted?resourceOwnerId=3fa85f64-5717-4562-b3fc-2c963f66afa6&occurredAfter=2024-01-01T00:00:00Z&occurredBefore=2024-01-01T00:00:00Z&updatedAfter=2024-01-01T00:00:00ZRetrieve a list of planting activities. The id in the response is used for GET /v4/layers/asPlanted/{activityId}/contents. - GETRetrieve the raw planting activity
/v4/layers/asPlanted/:activityId/contentsRetrieve an individual planting activity by id. Ids are retrieved via the /layers/asPlanted route. Downloads larger than 5MiB (5242880 bytes) in size, must be… - GETRetrieve a list of scouting observations
/v4/layers/scoutingObservations?occurredAfter=2024-01-01T00:00:00Z&occurredBefore=2024-01-01T00:00:00ZRetrieve a list of scouting observations created or updated by the user identified by the Authorization header. - GETRetrieve individual scouting observation
/v4/layers/scoutingObservations/:scoutingObservationIdRetrieve an individual scouting observation by id. Ids are retrieved via the /layers/scoutingObservations route. - GETRetrieve attachments associated with a given scouting observation.
/v4/layers/scoutingObservations/:scoutingObservationId/attachmentsRetrieve attachments associated with a given scouting observation. Photos added to scouting notes in the FieldView app are capped to 20MB, and we won’t store… - GETRetrieve the binary contents of a scouting observation’s attachment.
/v4/layers/scoutingObservations/:scoutingObservationId/attachments/:attachmentId/contentsPhotos added to scouting notes in the FieldView app are capped to 20MiB (20971520 bytes), and we won’t store photos larger than that in a scouting note.…
ResourceOwners
- GETRetrieve a resource owner by ID
/v4/resourceOwners/:resourceOwnerIdRetrieve a resource owner for the given resourceOwnerId.
FarmOrganizations
- GETRetrieve a specific farm organization by organization type and ID
/v4/farmOrganizations/:farmOrganizationType/:farmOrganizationIdRetrieve a given farm organization by organization type and ID.
Operations
- GETRetrieve the operations accessible to a a given user.
/v4/operations/all?resourceOwnerId=stringRetrieve the operations accessible to the authenticated user. Filter the results by resource owner if the resourceOwnerId query parameter is specified.
API details
- Base URL
https://platform.climate.com- Authentication
- An API key in the X-Api-Key header
OAuth 2.0 (authorization code flow) with 24 scopes - Operations
- 26 operations on 26 pathsGET 20POST 5PUT 1
- Main resources
- Layers 10Uploads 4Boundaries 3Exports 3Fields 3FarmOrganizations 1Operations 1ResourceOwners 1
- Description format
- OpenAPI 3.0.0, API version
4.0.11 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Climate FieldView Platform APIs in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Climate FieldView Platform APIs collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-Api-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Upload a boundary” (POST /v4/boundaries), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Climate FieldView Platform APIs?
Last Modified: Wed Jan 4 12:47:29 UTC 2023 All endpoints are only accessible via HTTPS. * All API endpoints are located at https://platform.climate.com (e.g.… It is listed under Data & analytics and has 26 endpoints.
Who publishes the Climate FieldView Platform APIs?
It is listed from Climate's public API description (an OpenAPI document), not published by Climate on Swastik Codes. Anyone who controls climate.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Climate FieldView Platform APIs?
Requests go to https://platform.climate.com. Endpoint paths are added to this base URL.
How do I authenticate with the Climate FieldView Platform APIs?
It accepts 2 methods: an API key in the X-Api-Key header; OAuth 2.0 (authorization code flow) with 24 scopes.
How many endpoints does the Climate FieldView Platform APIs have?
26 operations on 26 paths (20 GET, 5 POST, 1 PUT). The largest groups are Layers, Uploads, Boundaries, Exports.
Is forking the Climate FieldView Platform APIs free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.