Onfarm Data API

Instructions

The examples on this page can be called using curl or wget, by passing your API key as x-api-key in the header.

Example curl request:

curl -H "x-api-key: your api key" "https://api.precisionsustainableag.org/onfarm/raw?table=biomass_in_field&affiliation=MD"

Tables

Each table below includes a protocols column, which has flags to indicate which parts of the on-farm experiment each site completed:

• 1 if a site is expected to execute a protocol; does not indicate data quality.
• 0 if a site does not execute a protocol.
• -1 if a site does a protocol, but shouldn't be included in analysis because of experimental design or other site factors (like unplanned irrigation, improper termination of the bare strip, etc); we still track/show the data for other reasons.
• -999 if a site started (or even completed) the protocol but the data is bad/incomplete and shouldn't be shown anywhere, e.g. the field person reports they conducted the protocol incorrectly.

For additional documentation on the meaning of each column and table, see https://github.com/precision-sustainable-ag/crowndb-public/wiki

These tables can be filtered by code, year, affiliation, producer_id, last_name, and subplot. You can have multiple filters, and each filter can contain multiple items.

Table: biomass_in_field biomass_nir cc_mixture decomp_bag decomp_biomass_ash decomp_biomass_cn decomp_biomass_dry decomp_biomass_fresh farm_history gps_corners gps_subplots producer_ids rainfall site_information stresscam_ratings texture_from_samples weather wsensor_install yield_corn yield_cotton yield_soybeans yield_in_field

Affiliation: AL DE GA KS MD NC NE PA SC VA VT WI

Column completeness:

• PATHonfarm/raw?table=biomass_in_field&affiliation=MD

• PATHonfarm/raw?table=biomass_in_field&affiliation=MD&complete_count=dry_biomass_wt

Tables weather and rainfall can also be filtered by a range of dates.

Example:

PATHonfarm/raw?table=rainfall&start=2017-11-05&end=2017-11-08

These tables can be queried and filtered by serial numbers, timestamps, and project IDs (if applicable).

• ambient_sensor_data
• water_gateway_data
• water_node_data
• water_sensor_data

Example: ambient_sensor_data, serial no 18000147, start date July 1 2020, end date July 30 2020:

PATHonfarm/raw?table=ambient_sensor_data&serial_no=18000147&start=2020-07-01&end=2020-07-30

Table stresscam_ratings can be filtered by device:

PATHonfarm/raw?table=stresscam_ratings&device=1047782

Summaries

You can get the number of rows for any query using this parameter:

summary=true

Example: Number of producers:

Example: Number of producers with affiliation MD:

You can output grouping totals using this parameter:

group=column1[,column2…]

Note that the group parameter works only in conjunction with summary=true.

Example: Number of producers per affiliation:

Example: Number of producers per affiliation per year:

Any parameter that is output by a query can be used as a grouping column.

Output columns

Output for all Onfarm queries can be limited to specific columns using this parameter:

cols=col1[,col2…]

Example:

Sensor by farm views

Sensor locations can be output for these view using the parameter location=true. However, note that all lat/longs are currently null:

Locations

Example:

Can be filtered by one or more codes, years, affiliations, and producer_ids. (Case-insensitive)

Examples:

Affiliations

Example:

Returns the entire affiliations table.

Producers

Example:

Can be filtered by one or more codes, years, affiliations, first_names, last_names, or producer_ids. (Case-insensitive)

Examples:

Dates

Example:

Can be filtered by one or more codes, years, affiliations, or producer_ids. (Case-insensitive)

Examples:

Biomass and Yield

SSURGO

SSURGO data can be output for table site_information by using parameters &table=site_information&ssurgo=true, along with options listed at the SSURGO documentation.

Multiple sites can be output, and sites without lat/lon will be excluded.

Examples:

• Site AWP, default SSURGO output: PATHonfarm/raw?table=site_information&ssurgo=true&code=AWP
• 2017 Maryland sites, major component only: PATHonfarm/raw?table=site_information&ssurgo=true&affiliation=MD&year=2017&component=major
• 2017 Maryland sites, max component only: PATHonfarm/raw?table=site_information&ssurgo=true&affiliation=MD&year=2017&component=max

options

Queries involving site_information exclude unenrolled sites. To include them, use the parameter &options=include_unenrolled_sites

Examples:

Example:

• Maryland producers: PATHonfarm/producers?affiliation=MD