logo
API docs by Redocly

DTN Agriculture Core API (1.0.0)

Download OpenAPI specification:

DTN AgCore API Team: agintel@dtn.com

Introduction

AgCore provides data and business services through an application programming interface (API). AgCore is intended to be the next-generation back-end for all DTN Agriculture systems.

Key Features:

  • Land Centric database - The AgCore data is literally built from the ground up. The API offers the unique ability to search for land within a given radius. You can find land surrounding your business or other points of interest.

  • Identify Crop locations - The AgCore data can show where crops are planted, including a 7-year history.

  • Who is Farming What, Where? - Not only can land be linked to crops, but also to the farm and farmers. The AgCore database differentiates between the land’s location and the farmer’s location.

  • Summarized data - View data that has already been summarized from the land level up to each Grower, Address and Operation.

Applications:

This API caters to a wide range of users and applications, including:

  • Grain Elevators, Ethanol Plants, Crush Facilities and Feedlots can find growers and crops within their Draw Area

  • Marketers can:

    • Find Growers nearby and query the crops they grow

    • Find Growers with Grain Bins (On-Farm Storage)

    • Match their existing customers to the database

This interactive documentation will get you up to speed on setting up requests, understanding responses, and leveraging the DTN AgCore API for your needs.

Endpoint deprecation

A x-deprecated header will be added that indicates the date of removal for the endpoint.

Getting Started

To get started, all users need their own client ID and client secret. Please contact an account manager or the DTN sales team to obtain these. Then, review the Authentication section to learn how to request an API access token. Do not share or use others' API credentials, since doing so may compromise information security.

Making requests

Starting off your journey with the the AgCore API couldn't be easier. We've provided a variety of options to suit your needs and comfort level: Interactive Documentation: Our interactive documentation is a great starting point. Simply navigate to the "Authentication" section, insert your credentials, and you'll obtain an access token behind the scenes. Then, explore the API endpoints described in the Endpoints section.

1. Interactive documentation: Navigate to the Authentication section on this page, insert credentials to obtain an access token, then explore the API endpoints described in the Endpoints section.

2. Postman collection: For a hands-on approach, consider downloading this Postman collection. Insert credentials and start testing the API in Postman's interactive application.

3. Writing code: Ready to start coding? Try the Python example below, replacing client_id and client_secret with proper credentials. This invokes the API endpoint with a GET request and prints the response.

  import requests
  
  # --- Obtain an API access token ---
  authUrl = 'https://api.auth.dtn.com/v1/tokens/authorize'
  body = {
      'grant_type': 'client_credentials',
      'client_id': '...insert your client id here...',
      'client_secret': '...insert your client secret here...',
      'audience': 'https://agcore.prd.ag.zones.dtn.com/api'
  }
  
  response = requests.post(authUrl, json=body)
  access_token = response.json()['data']['access_token']
  
  # --- Invoke the API ---
  api_base_url = 'https://agcore-api.prd.ag.zones.dtn.com/api/v1/'
  
  endpoint = 'land/addresses?state-code=mn&postal-code=55337&address-line=11400 Rupp Dr'
  headers = {'Authorization': 'Bearer ' + access_token, 'Content-Type': 'application/json'}
  response = requests.get(api_base_url + endpoint, headers=headers)
  
  # --- Print the response ---
  print(response.json())

/api/v1/health-check

Get a message to prove the API is responding.

Returns a message to indicate the API is up and running.

Responses

Response samples

Content type
application/json
{
  • "message": "works"
}

/api/v1/activities/field-accessibilities

Field accessibility.

Returns a list of field accessibility.

Authorizations:
bearerAuth
query Parameters
fips-code
required
string
Example: fips-code=01001,01003,01019

A single fips code value or comma separated list of fips codes.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/activities/irrigation-needs

Irrigation need.

Returns a list of irrigation needs.

Authorizations:
bearerAuth
query Parameters
fips-code
required
string
Example: fips-code=01001,01003,01019

A single fips code value or comma separated list of fips codes.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/activities/spray-suitabilities

Spray suitability.

Returns a list of spray suitabilities.

Authorizations:
bearerAuth
query Parameters
fips-code
required
string
Example: fips-code=01001,01003,01019

A single fips code value or comma separated list of fips codes.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/demo-categories

Codes and descriptions for demographics.

Returns a demographic category's.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/codes/unit-of-measures

Codes and descriptions for units of measures.

Returns a list of unit of measure codes and descriptions.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/codes/facility-types

Facility type ids and descriptions.

Returns facility type ids and descriptions of a given Facility Type.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/codes/facility-types/{facilityCode}

Facility type ids and descriptions.

Returns facility type ids and descriptions of a given Facility Type.

Authorizations:
bearerAuth
path Parameters
facilityCode
required
number
Enum: 1 2 3 4 5

This field is the facility type id for facility objects. If one is entered one facility type object is returned. If not then all facility type objects are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/genders

Gender codes and descriptions.

Returns gender codes and descriptions of a given Gender Code

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/genders/{genderCode}

Gender codes and descriptions.

Returns gender codes and descriptions of a given Gender Code

Authorizations:
bearerAuth
path Parameters
genderCode
required
number
Enum: 1 2 3 4 5

This field is the Gender Code for Gender Code objects. If one is entered one gender code object is returned. If not then all gender code objects are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/irrigation-types

Codes and descriptions for irrigation ID objects.

Returns an irrigation ID object and its description type.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/irrigation-types/{irrigationId}

Codes and descriptions for irrigation ID objects.

Returns an irrigation ID object and its description type.

Authorizations:
bearerAuth
path Parameters
irrigationId
required
number
Enum: 1 2 3

This field is the irrigation ID object code for irrigation types. If one is entered one irrigation code object is returned. If not then all irrigation code object types are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/lci

Codes and descriptions for livestock, crops, and income.

Returns a livestock and crop data.

Authorizations:
bearerAuth
query Parameters
lci-id
number

Comma separated numerical list of one or more lci id/s one is searching for.

lci-type
string

Comma separated string of one or more lci type/s one is searching for.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/codes/lci/{lciId}

Codes and descriptions for livestock, crops, and income.

Returns a livestock and crop data.

Authorizations:
bearerAuth
path Parameters
lciId
required
number

This field is the numeric primary key for LCI objects. If one is entered one LCI object is returned. If not then all LCI objects are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/lci/groups

Codes and descriptions for livestock, crops, and income.

Returns a livestock and crop data.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/codes/lci/groups/{lciGroupId}

Codes and descriptions for livestock, crops, and income.

Returns a livestock and crop data.

Authorizations:
bearerAuth
path Parameters
lciGroupId
required
number

A numeric key to denote an LCI object's group.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/location-accuracies

Location Accuracy codes and descriptions.

Returns latLonAccuracy codes and descriptions of a given Location Accuracy Code

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/location-accuracies/{locationAccuracyCode}

Location Accuracy codes and descriptions.

Returns latLonAccuracy codes and descriptions of a given Location Accuracy Code

Authorizations:
bearerAuth
path Parameters
locationAccuracyCode
required
string
Enum: "A" "I" "F" "G" "P" "R" "X" "" "5" "7" "9"

This field is the latLonAccuracy Code for latLonAccuracy Code objects. If one is entered one latLonAccuracy code object is returned. If not then all latLonAccuracy code objects are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/producers

Producer codes and descriptions.

Returns producer codes and descriptions of a given Producer Code.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/producers/{producerCode}

Producer codes and descriptions.

Returns producer codes and descriptions of a given Producer Code.

Authorizations:
bearerAuth
path Parameters
producerCode
required
number
Enum: 1 2 3 4

This field is the Producer Code for Producer Code objects. If one is entered one producer code object is returned. If not then all producer code objects are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/seasons

Season codes and descriptions.

Returns calendar years and descriptions of a given Season Code

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/codes/seasons/{seasonCode}

Season codes and descriptions.

Returns calendar years and descriptions of a given Season Code

Authorizations:
bearerAuth
path Parameters
seasonCode
required
string (seasonCode)
Enum: "inseason" "predictive" "currentyear" "lastyear"

This optional field is the season code for season objects. If one is entered one season object is returned. If not then all season objects are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/crops/counties/growth-stages

Crop growth stages.

Returns a list of crops with the crop growth stage and date associated.

Authorizations:
bearerAuth
query Parameters
fips-code
required
string
Example: fips-code=01003,01047,01019

A single fips code value or comma separated list of fips codes.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/facilities

Facilities.

Returns a list of facilities in a radius.

Authorizations:
bearerAuth
query Parameters
lat
required
number (latitude) [ -90 .. 90 ]
Example: lat=39.9191954099076

latitude.

lon
required
number (longitude) [ -180 .. 180 ]
Example: lon=-73.899739925533

longitude.

radius
required
number [ 1 .. 81000 ]

The search radius in meters.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/facilities/{facilityId}

Facility by ID.

Returns facility information associated with a facility ID.

Authorizations:
bearerAuth
path Parameters
facilityId
required
number >= 1

The primary key for facility objects..

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/grainbin

Grain bin storage capacity by ID.

Returns bin information associated with a bin ID.

Authorizations:
bearerAuth
path Parameters
binId
required
number

The primary key for bin objects.

Responses

Response samples

Content type
application/json
{
  • "binId": 123245,
  • "lat": 94.039,
  • "lon": -122.3234,
  • "bushels": 573.2,
  • "landId": 123456
}

/api/v1/grainbin/search

Grain bin storage capacity by list of IDs.

Returns bin information associated with a list of bin IDs.

Authorizations:
bearerAuth
query Parameters
bin-id
number >= 1

A comma separated list of grain bin-ids for a given search.

Request Body schema: application/json
required

DEPRECATED - body parameters will be removed from this endpoint September 1 2024. List of primary keys for bin objects.

binIds
required
Array of numbers[ items >= 1 ]

Responses

Request samples

Content type
application/json
{
  • "binIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/grainbin/search-radius

Grain bin storage capacity by latitude, longitude and radius.

Returns bin information associated with geographic coordinates.

Authorizations:
bearerAuth
query Parameters
lat
required
number (latitude) [ -90 .. 90 ]
Example: lat=39.9191954099076

latitude.

lon
required
number (longitude) [ -180 .. 180 ]
Example: lon=-73.899739925533

longitude.

radius
required
number (radius) [ 1 .. 50000 ]

The search radius in meters.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/geographic-areas/counties

All county information for a the given parameters.

Returns all fips data, fips data for requested fips codes or fips data for one particular state. With or with out poly geom data, as per request.

Authorizations:
bearerAuth
query Parameters
state-codes
string (stateCode) = 2 characters
Example: state-codes=MN

An optional list of two digit state codes delimited by comma, only available when fips-codes is not included.

fips-codes
number

An optional comma separated list of fips codes, only available when state-code is not included.

poly-geom
boolean

A boolean value if polyGeom data is required in the response.

limit
number

The maximum response amount desired, if no limit all matching results will be returned.

offset
number

The offset of the last previously returned pagination results. To be used with limit for pagination.

Responses

Response samples

Content type
application/json
{}

/api/v1/geographic-areas/states

Abbreviation and name of US states, territories, and military zones.

Returns the abbreviation and name of each US state, territory, or military zone. Optionally returns boundary data -- to return boundary data, append '?poly-geom=true' to the route.

Authorizations:
bearerAuth
query Parameters
state-code
string (stateCode) = 2 characters
Example: state-code=MN

An optional list of two digit state codes delimited by comma, only available when state-name is not included.

state-name
string
Example: state-name=Alabama

An optional list of state names delimited by comma, only available when state-code is not included.

poly-geom
boolean

A boolean value if polyGeom data is required in the response.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/geospatial/land

Search for land and coordinate data based on land id.

Returns a list of land data and coordinates for the associated land object.

Authorizations:
bearerAuth
query Parameters
land-id
required
number >= 1

A comma separated list of land ids for a given search.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/geospatial/land/{landId}

Search for land and coordinate data based on landId.

Returns a list of land data and coordinates for the associated land object.

Authorizations:
bearerAuth
path Parameters
landId
required
number >= 1

The primary key for land objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/geospatial/party/{partyId}

Search for land and coordinate data based on partyId.

Returns a list of land data and coordinates for the associated party object.

Authorizations:
bearerAuth
path Parameters
partyId
required
number >= 1

The primary key for party objects.

query Parameters
show-all
boolean

When passed as FALSE, it will filter by land only within the sustainable practices participating states.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/geospatial/party

Search for land and coordinate data based on party id.

Returns a list of land data and coordinates for the associated party object.

Authorizations:
bearerAuth
query Parameters
party-id
required
number >= 1

A comma separated list of party ids for a given search.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land

Get land by fips code or lat, lon, and radius.

Provides two query methods for retreiving land information; fips code or lat, lon, and radius. You cannot provide both query methods in the same request.

Authorizations:
bearerAuth
query Parameters
lat
number (latitude) [ -90 .. 90 ]
Example: lat=39.9191954099076

Latitude (required with lon and radius).

lon
number (longitude) [ -180 .. 180 ]
Example: lon=-73.899739925533

Longitude (required with lat and radius).

radius
number (radius) [ 1 .. 50000 ]

The search radius in meters (required with lat and lon).

fips-code
string

The fips code for the requested search area.

include-properties
string

Flag for which geometric values to be included in the response. Must be of enum - "default", "geom", "poly-geom", "point-geom"

limit
number

The maximum response amount desired, if no limit all matching results will be returned.

offset
number

The offset of the last previously returned pagination results. To be used with limit for pagination.

Responses

Response samples

Content type
application/json
{}

/api/v1/land/carbon-intensity

Get a carbon intensity score for a land.

NOTE: This endpoint is defined but not yet implemented. Returns a carbon intensity score for the associated land with the provided FDCIC inputs, this endpoint accepts one FIPS code per request.

Authorizations:
bearerAuth
query Parameters
fips-code
required
string

The FIPS code associated with the county in which the land resides.

acres
required
number > 0

The number of acres on the land. Must be greater than 0.

crop
required
string
Enum: "Corn" "Soybeans"

The crop harvested on the associated field.

tillage
required
string
Enum: "conventional" "reduced" "no till"

The type of tillage used on the associated field.

cover-crop
required
boolean

Indicates whether the associated field was cover cropped.

harvest-year
required
number
Enum: 2024 2025

The year that the associated crop was harvested.

yield
required
number > 0

The harvest yield of the associated crop (bu/ac). Must be greater than 0.

diesel
required
number >= 0

Diesel used on the associated field (gal/ac).

gasoline
required
number >= 0

Gasoline used on the associated field (gal/ac).

natural-gas
required
number >= 0

Natural Gas used on the associated field (ft3/ac).

liquid-petroleum
required
number >= 0

Liquid Petroleum used on the associated field (gal/ac).

electricity
required
number >= 0

Electricity used on the associated field (kWh/ac).

EEF-NI-NStabilizer
required
boolean

Indicates whether an EEF, nitrification inhibitor, or N stabilizer was used on the associated field.

ammonia
required
number >= 0

Total nitrogen applied on the associated farm using Ammonia fertilizers (lbs N/ac).

urea
required
number >= 0

Total nitrogen applied on the associated farm using Urea fertilizers (lbs N/ac).

ammonium-nitrate
required
number >= 0

Total nitrogen applied on the associated farm using Ammonium Nitrate fertilizers (lbs N/ac).

ammonium-sulphate
required
number >= 0

Total nitrogen applied on the associated farm using Ammonium Sulphate fertilizers (lbs N/ac).

UAN
required
number >= 0

Total nitrogen applied on the associated farm using UAN (Urea Ammonium Nitrate) fertilizers (lbs N/ac).

MAP-Nitrogen
required
number >= 0

Total nitrogen applied on the associated farm using MAP (Monoammonium Phosphate) fertilizers (lbs N/ac).

DAP-Nitrogen
required
number >= 0

Total nitrogen applied on the associated farm using DAP (Diammonium Phosphate) fertilizers (lbs N/ac).

MAP-Phosphorous
required
number >= 0

Total phosphorous applied on the associated farm using MAP (Monoammonium Phosphate) fertilizers (lbs P/ac).

DAP-Phosphorous
required
number >= 0

Total phosphorous applied on the associated farm using DAP (Diammonium Phosphate) fertilizers (lbs P/ac).

insecticide
required
number >= 0

Total insecticide applied on the associated farm (g/ac).

herbicide
required
number >= 0

Total herbicide applied on the associated farm (g/ac).

lime
required
number >= 0

Total lime applied on the associated farm (lbs CaCO3/ac).

potash
required
number >= 0

Total potash applied on the associated farm (lbs K2O/ac).

manure-use
required
boolean

Indicates whether manure was applied to the associated farm.

beef-manure
required
number >= 0

Total beef manure applied on the associated farm (US tons/ac).

dairy-manure
required
number >= 0

Total dairy manure applied on the associated farm (dry US tons/ac).

swine-manure
required
number >= 0

Total swine manure applied on the associated farm (dry US tons/ac).

chicken-manure
required
number >= 0

Total chicken manure applied on the associated farm (dry US tons/ac).

Request Body schema: application/json
required

Land-level FDCIC inputs.

fipsCode
required
string
acres
required
number
crop
required
string
tillage
required
string
coverCrop
required
boolean
cropYear
number
yield
required
number
diesel
required
number
gasoline
required
number
naturalGas
required
number
liquidPetroleum
required
number
electricity
required
number
EEFNINStabilizer
required
boolean
ammonia
required
number
urea
required
number
ammoniumNitrate
required
number
ammoniumSulphate
required
number
UAN
required
number
MAPNitrogen
required
number
DAPNitrogen
required
number
MAPPhosphorous
required
number
DAPPhosphorous
required
number
insecticide
required
number
herbicide
required
number
lime
required
number
potash
required
number
manureUse
required
boolean
beefManure
required
number
dairyManure
required
number
swineManure
required
number
chickenManure
required
number

Responses

Request samples

Content type
application/json
{
  • "fipsCode": "470321",
  • "acres": 17.00389,
  • "crop": "Corn",
  • "tillage": "Conventional",
  • "coverCrop": true,
  • "cropYear": 2024,
  • "yield": 47.87842,
  • "diesel": 7.221682554,
  • "gasoline": 1.275964906,
  • "naturalGas": 3.53759,
  • "liquidPetroleum": 2.133721663,
  • "electricity": 68.66462715,
  • "EEFNINStabilizer": true,
  • "ammonia": 179,
  • "urea": 291,
  • "ammoniumNitrate": 180,
  • "ammoniumSulphate": 174,
  • "UAN": 151,
  • "MAPNitrogen": 93,
  • "DAPNitrogen": 205,
  • "MAPPhosphorous": 107,
  • "DAPPhosphorous": 99,
  • "insecticide": 6.49211707,
  • "herbicide": 1353.240156,
  • "lime": 573.0310878,
  • "potash": 200,
  • "manureUse": true,
  • "beefManure": 11.167,
  • "dairyManure": 15.4233,
  • "swineManure": 10.113,
  • "chickenManure": 2.577
}

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land/intersections

Get a list of land intersection data.

Returns a list of landIds and their calculated polyIntersection, areaIntersection, and percentIntersection

Authorizations:
bearerAuth
query Parameters
limit
number

The maximum response amount desired, if no limit all matching results will be returned.

offset
number

The offset of the last previously returned pagination results. To be used with limit for pagination.

lci-ids
string

A comma separated list of lci ids to filter the results by.

Request Body schema: application/json

The geoJson of an area to search for parties within this location.

type
string
Enum: "MultiPolygon" "Polygon" "Point"
Array of numbers or Array of numbers

An array of coordinates formatted as longitude, latitude

Responses

Request samples

Content type
application/json
{
  • "coordinates": [
    ],
  • "type": "Polygon"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "links": {},
  • "count": 40002
}

/api/v1/land/intersection/parties

Get a list of parties.

Returns a list for parties that intersect with the polygons.

Authorizations:
bearerAuth
query Parameters
lci-ids
string

A comma-delimited list of LCI Ids.

count-only
boolean

When passed, returns a number for all parties with intersected lands.

Request Body schema: application/json
required

The geoJson of an area to search for parties within this location.

type
string
Value: "MultiPolygon"
Array of numbers or Array of numbers

An array of coordinates formatted as longitude, latitude.

Responses

Request samples

Content type
application/json
{
  • "type": "MultiPolygon",
  • "coordinates": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land/{landId}

Get linked land data from landId.

Returns land information associated with a landId.

Authorizations:
bearerAuth
path Parameters
landId
required
number >= 1

Primary key of the land objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land/{landId}/crop

Search land data based on landId and season code.

Returns land data associated with the landId and from the search parameter associated with the given season code.

Authorizations:
bearerAuth
path Parameters
landId
required
number >= 1

The primary key for land objects.

query Parameters
season-code
string (seasonCode)
Enum: "inseason" "predictive" "currentyear" "lastyear"

The crop season code objects associated with the requested data. This parameter is optional and only one of year or season-code may be passed in. Not both.

year
number >= 1

The crop year associated with the requested data. This parameter is optional and only one of year or season-code may be passed in. Not both.

limit
number

The maximum response amount desired, if no limit all matching results will be returned.

offset
number

The offset of the last previously returned pagination results. To be used with limit for pagination.

Responses

Response samples

Content type
application/json
{}

/api/v1/land/{landId}/grainbin

Get linked grainbin data for a land.

Returns a land's grainbin information associated with a landId.

Authorizations:
bearerAuth
path Parameters
landId
required
number >= 1

Primary key of the land objects.

query Parameters
year
number

An array or singular year of data to be returned. If not provided then all available years data will be returned.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/land/{landId}/party

Get party data linked to landId.

Returns party link information associated with landId.

Authorizations:
bearerAuth
path Parameters
landId
required
number >= 1

Primary key for the land objects.

query Parameters
year
number

An array or singular year of data to be returned. If not provided then all available years data will be returned.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

/api/v1/land/{landId}/soil/intersection

Get soil intersection data based on landId.

Returns a list of soil intersection data for the associated landId field.

Authorizations:
bearerAuth
path Parameters
landId
required
number >= 1

The primary key for land objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land/{landId}/soil

Get soil data based on landId.

Returns a list of soil data for the associated landId field.

Authorizations:
bearerAuth
path Parameters
landId
required
number >= 1

The primary key for land objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land/irrigation-types

Land irrigation types.

Returns a list of land irrigation types.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/land/irrigation-types/{typeId}

Land irrigation types.

Returns a list of land irrigation types.

Authorizations:
bearerAuth
path Parameters
typeId
required
number

This field is the numeric primary key for irrigation types objects. If one is entered one irrigation type is returned. If not then all types are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land/fertilizers/methods

IDs and descriptions for fertilizer methods.

Returns a list of fertilizer methods and descriptions.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/land/fertilizers/types

IDs and descriptions for fertilizer types.

Returns a list of fertilizer types and descriptions.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/land/list

Get a list of land objects and their data.

Returns a list of land objects along with the data associated with each land object.

Authorizations:
bearerAuth
query Parameters
land-id
number >= 1

A comma separated list of land ids for a given search.

Request Body schema: application/json
optional

DEPRECATED - body parameters will be removed from this endpoint June 1 2024. List of primary keys for land objects.

landIds
required
Array of numbers[ items >= 1 ]

Responses

Request samples

Content type
application/json
{
  • "landIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/land/search-radius

Land data by latitude, longitude and radius.

Returns a list of land data associated with the specified queries.

Authorizations:
bearerAuth
query Parameters
lat
required
number (latitude) [ -90 .. 90 ]
Example: lat=39.9191954099076

latitude.

lon
required
number (longitude) [ -180 .. 180 ]
Example: lon=-73.899739925533

longitude.

radius
required
number (radius) [ 1 .. 50000 ]

The search radius in meters.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

/api/v1/land/residue

Land residue data by landId.

Returns land residue data associated with landId.

Authorizations:
bearerAuth
query Parameters
land-id
required
number

This field is the numeric primary key for residue objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land/tillage

Land tillage data by landId.

Returns land tillage data associated with landId.

Authorizations:
bearerAuth
query Parameters
land-id
required
number

This field is the numeric primary key for tillage objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/land/{landId}/growth

Get Land Growth

Authorizations:
bearerAuth
path Parameters
landId
string
query Parameters
crop-years
string

Comma delimited list of crop years

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "links": {
    },
  • "count": 0
}

/api/v1/metadata

Data Updates Status

Returns ETL update history for data tables, providing information about when tables were last updated, job status, and metadata.

Authentication Requirements: This endpoint requires the agriculture.core.data.refresh:read scope in addition to standard authentication.

Examples:

  • Single table: ?table-names=pseudo_farm_land_growth
  • Multiple tables: ?table-names=pseudo_farm_land_growth,pseudo_farm_bin_inventory
  • With schema filter: ?table-names=pseudo_farm_land_growth,pseudo_farm_bin_inventory&schema-name=agcore
  • Recent updates only: ?table-names=pseudo_farm_land_growth&max-days-old=30
Authorizations:
bearerAuth
query Parameters
table-names
string non-empty
Example: table-names=pseudo_farm_land_growth,pseudo_farm_bin_inventory

Filter by table name(s). Supports:

  • Single table: 'land_growth_v2'
  • Multiple tables (comma-separated): 'pseudo_farm_land_growth,pseudo_farm_bin_inventory'
  • Pattern matching: 'land_growth_v2' will match 'land_growth_v2_2024', 'land_growth_v2_2025', etc.
schema-name
string non-empty
Example: schema-name=agcore

Filter by database schema name

max-days-old
integer [ 1 .. 3650 ]
Example: max-days-old=30

Only show updates within the last X days (1-3650 days, default shows all)

status
string
Example: status=SUCCESS,COMPLETED

Filter by ETL job status. Can be a single status or comma-separated list. Valid values are COMPLETED, SUCCESS, FAILURE, PARTIAL, STARTED, SKIPPED. Defaults to SUCCESS,COMPLETED.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party

Get party information based on the latitude, longitude and radius.

Returns a list of parties and their information associated with the latitude, longitude and radius parameters.

Authorizations:
bearerAuth
query Parameters
lat
required
number (latitude) [ -90 .. 90 ]
Example: lat=39.9191954099076

latitude

lon
required
number (longitude) [ -180 .. 180 ]
Example: lon=-73.899739925533

longitude

radius
required
number (radius) [ 1 .. 50000 ]

The search radius in meters.

include-properties
string

Comma delimited list of properties to include in response. By default only the partyId is returned.

limit
number

The maximum response amount desired, if no limit all matching results will be returned.

offset
number

The offset of the last previously returned pagination results. To be used with limit for pagination.

Responses

Response samples

Content type
application/json
{}

/api/v1/party/addresses

Get standardized USPS address data.

Returns standardized USPS address using the Redpoint API.

Authorizations:
bearerAuth
query Parameters
address-line
required
string

A street address.

city
string

A city name.

state-code
string (state-code)
Enum: "CT" "WA" "GU" "AS" "MP" "PR" "VI" "ND" "MT" "ME" "WI" "VT" "ID" "MN" "PA" "IA" "NE" "RI" "NY" "MA" "IN" "NV" "CA" "OH" "DC" "DE" "IL" "WV" "SD" "MD" "KY" "KS" "VA" "NJ" "MO" "AZ" "TX" "OK" "NC" "TN" "NM" "AL" "OR" "NH" "LA" "UT" "GA" "HI" "AK" "WY" "SC" "AFA" "AFE" "AFP" "CO" "MS" "AR" "FL" "MI" "ct" "wa" "gu" "as" "mp" "pr" "vi" "nd" "mt" "me" "wi" "vt" "id" "mn" "pa" "ia" "ne" "ri" "ny" "ma" "in" "nv" "ca" "oh" "dc" "de" "il" "wv" "sd" "md" "ky" "ks" "va" "nj" "mo" "az" "tx" "ok" "nc" "tn" "nm" "al" "or" "nh" "la" "ut" "ga" "hi" "ak" "wy" "sc" "afa" "afe" "afp" "co" "ms" "ar" "fl" "mi"

A US state code.

postal-code
required
string

A US postal code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party/channels

Get a list of party address objects.

Returns a list of party address objects containing channels of contact including name, address, phone number and more.

Authorizations:
bearerAuth
query Parameters
limit
number

The maximum response amount desired, if no limit all matching results will be returned.

offset
number

The offset of the last previously returned pagination results. To be used with limit for pagination.

Request Body schema: application/json

The geoJson of an area to search for parties within this location.

type
string
Enum: "MultiPolygon" "Polygon"
coordinates
Array of numbers[ items[ items[ items ] ] ]

An array of coordinates formatted as longitude, latitude

Responses

Request samples

Content type
application/json
{
  • "coordinates": [
    ],
  • "type": "Polygon"
}

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party/confidence-flags

Confidence flag reference data for party data.

Returns a confidence flag reference data.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/party/confidence-flags/{flagId}

Confidence flag reference data for party data.

Returns a confidence flag reference data.

Authorizations:
bearerAuth
path Parameters
flagId
required
number

This field is the numeric primary key for confidence flags. If one is entered one flag object is returned. If not then all flag objects are returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party/{partyId}/grainbin

Get binId associated with partyId.

Returns the binId for each grainbin object associated with the partyId object.

Authorizations:
bearerAuth
path Parameters
partyId
required
number >= 1

The primary key for party objects.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

/api/v1/party/grainbin/search

Get a list of partyId objects and their binId objects.

Returns a list of partyId objects and binId objects where the binId for each grainbin object is associated with the requested partyId objects.

Authorizations:
bearerAuth
query Parameters
party-id
number

Comma separated number list of the primary keys for parties searched.

Request Body schema: application/json
required

DEPRECATED - body parameters will be removed from this endpoint June 1 2024. Please switch to query parameters. List of primary keys for party objects.

partyId
required
Array of numbers[ items >= 1 ]

Responses

Request samples

Content type
application/json
{
  • "partyId": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

/api/v1/party/land/search-radius

Get party information associated with the land.

Returns a list of parties and their information associated with the land inside the radius.

Authorizations:
bearerAuth
query Parameters
lat
required
number (latitude) [ -90 .. 90 ]
Example: lat=39.9191954099076

latitude

lon
required
number (longitude) [ -180 .. 180 ]
Example: lon=-73.899739925533

longitude

radius
required
number (radius) [ 1 .. 50000 ]

The search radius in meters.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/party/name/fips-code/search

Get party information based on the name and fips code.

Returns a list of party information associated with the name and fips code parameters.

Authorizations:
bearerAuth
query Parameters
name
required
string
Example: name=James

The first name, last name, or company name.

fips-code
required
string (fipsCode)
Example: fips-code=01001

Code which uniquely identified counties and county equivalents in the United States.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party/address/{addressId}

Get address data from an addressId.

Returns address data and information associated with the associated addressId.

Authorizations:
bearerAuth
path Parameters
addressId
required
number >= 1

The primary key for address objects in the address table.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party/{partyId}/related

Get linked party data for a party.

Returns party link information associated with a partyId.

Authorizations:
bearerAuth
path Parameters
partyId
required
number >= 1

The primary key for party objects.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/party/{partyId}

Get party information based on the requested partyId.

Returns a party object and the party information associated with the partyId.

Authorizations:
bearerAuth
path Parameters
partyId
required
number >= 1

The primary key for party objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party/{partyId}/consumer

Get party consumer information based on the requested partyId.

Returns a party consumer object associated with the partyId.

Authorizations:
bearerAuth
path Parameters
partyId
required
number >= 1

The primary key for party objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party/{partyId}/land

Get all landIds for the partyId object.

Returns the party object passed through the parameters along with every landId object associated with the partyId.

Authorizations:
bearerAuth
path Parameters
partyId
required
number >= 1

The primary key for party objects.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

/api/v1/party/name/zip-code/search

Get party information based on a last name and postal code.

Returns a list of party objects and information associated with each party related to the last name and postal code request.

Authorizations:
bearerAuth
Request Body schema: application/json
required

An object containing the search parameters.

firstName
string
lastName
string
postalCode
string

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "postalCode": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/party/match

Get party data based on search parameters.

Returns party data associated with a several fields using the Redpoint API.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Object containing Search Parameters.

companyName
string
fullName
string
firstName
string
middleInitial
string
lastName
string
namesuffix
string
address
string
address2
string
city
string
stateCode
string
zipCode
string
phone
string
email
string

Responses

Request samples

Content type
application/json
{
  • "companyName": "string",
  • "fullName": "string",
  • "firstName": "string",
  • "middleInitial": "string",
  • "lastName": "string",
  • "namesuffix": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "stateCode": "string",
  • "zipCode": "string",
  • "phone": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "partyId": 5315772,
  • "primaryContact": true,
  • "producerCode": 2,
  • "companyName": "A1 Farming",
  • "firstName": "BOB",
  • "middleName": "S",
  • "lastName": "BELCHER",
  • "suffix": "jr",
  • "addressId": 3357517,
  • "genderCode": "M"
}

/api/v1/party{partyId}/persona

Get party persona data from partyId.

Returns party persona information associated with a partyId.

Authorizations:
bearerAuth
path Parameters
partyId
required
number >= 1

Primary key of the party objects.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

/api/v1/party/summary-level/crop-year/search

Production details by party or address.

Returns production information associated with a partyId, cropYear and a summaryLevel.

Authorizations:
bearerAuth
query Parameters
party-id
number

The primary key for party objects.

summary-level
string
Enum: "A" "I" "O"

"A" - Retrieves address summary data and "I" - Retrieves party summary data and "O" - Retrieves operations summary data.

logicalCropYear (string) or numericCropYear (number)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

/api/v1/production/yields/county

Get production yields by fips code or state code.

Authorizations:
bearerAuth
query Parameters
fips-code
integer

Fips code for the requested county.

state-code
integer

Return all counties in state.

start-year
required
integer

Start year for requested harvest year. If none is supplied, use the most recent year.

end-year
required
integer

End year for requested harvest year.

lci-ids
Array of integers[ items >= 1 ]

Lifecycle Inventory IDs for the requested data.

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "count": 0,
  • "results": [
    ]
}

/api/v1/production/yields/state

Get production yields by state code

Authorizations:
bearerAuth
query Parameters
state-code
required
Array of strings[ items >= 1 ]

State code for the requested county.

start-year
required
integer

Start year for requested harvest year. If none is supplied, use the most recent year.

end-year
required
integer

End year for requested harvest year.

lci-ids
Array of integers[ items >= 1 ]

Lifecycle Inventory IDs for the requested data.

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "count": 0,
  • "results": [
    ]
}

/api/v1/jobs/{jobId}

Get data or status for given jobId.

Returns data for the given jobId. Job data is cleaned up 24 hours after job completion.

Authorizations:
bearerAuth
path Parameters
jobId
required
integer

The jobId of the request.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}