getYieldForecastPlanet API

getYieldForecastPlanet

The getYieldForecast API provides Barchart proprietary grain yield forecast data. Yield Index data can be filtered by commodity, by indexGroup, by state, by district, and by county. The unit is in Bushel per Acre.

View All APIs

Contact Us to Get Access

First Name^*

Last Name^*

Email Address^*

Phone^*

Company^*

Role^*

Industry^*

Country^*

What you are looking for?^*

Please provide as much information as possible (e.g. exchanges, markets or other data sources), the APIs you are interested in (e.g. getQuote, getHistory, getChart, getCorporateActions, etc.), and your use case.

Here are some examples: Example #1, Example #2, Example #3.

By submitting this form you are opting in to receive email communications from Barchart for related product, service or company information, updates and announcements. You can unsubscribe at anytime. View our Privacy Policy.

Inputs

country^required

The ISO-2 country code to further refine the instruments.

Type

enum (A type which includes a list of valid possible values.)

Example

US

Default

US

Valid Values

US

state^optional

An ANSI-2 state abbreviation to define the state that yield forecast index will be returned for.

Type

list (A comma or semi-colon delimited string.)

Example

IL

stateFips^optional

A valid 2-digits state fips code used to define the state that yield forecast index will be returned for. Please click here to get a list of possible values.

Type

string (A sequence of characters. (example: GOOG))

Example

17

districtCode^optional

A valid 2-digit district code used to define the district that yield forecast index will be returned for. Please click here to get a list of possible values.

Type

string (A sequence of characters. (example: GOOG))

Example

50

county^optional

A county name to define the county that yield forecast index will be returned for.

Type

string (A sequence of characters. (example: GOOG))

Example

Champaign County

countyFips^optional

A valid 3-digits county fips code to define the county that yield forecast index will be returne for. Please click here to get a list of possible values.

Type

string (A sequence of characters. (example: GOOG))

Example

019

crop^optional

A commodity name to filter yield forecast index.

Type

enum (A type which includes a list of valid possible values.)

Example

corn

Valid Values

corn, soybean

indexGroup^optional

A valid index aggregate level to filter yield forecast index.

Type

enum (A type which includes a list of valid possible values.)

Example

district

Valid Values

national, state, district, county

fields^optional

Additional output fields requested. Requested fields should be separated by a comma.

Type

list-enum (A comma or semi-colon delimited string that must match a list of valid possible values.)

Example

shortName

Valid Values

shortName

Outputs

symbol
always returned

A unique symbol that identifies the data series.

string
A sequence of characters. (example: GOOG)

name
always returned

The name of the data series.

string
A sequence of characters. (example: GOOG)

shortName

The short name of the data series.

string
A sequence of characters. (example: GOOG)

indexGroup
always returned

An index aggregate level (National, State, Crop Reporting District, County).

string
A sequence of characters. (example: GOOG)

crop
always returned

The crop name.

string
A sequence of characters. (example: GOOG)

country
always returned

The ISO-2 country code abbreviation associated with the indexing area.

string
A sequence of characters. (example: GOOG)

state
always returned

The 2-char abbreviation of the state associated with the indexing area.

string
A sequence of characters. (example: GOOG)

stateFipsCode
always returned

The -digit FIPS code of state associated with the indexing area.

string
A sequence of characters. (example: GOOG)

district
always returned

2-digit district code of crop reporting district that is associated with the indexing area.

string
A sequence of characters. (example: GOOG)

county
always returned

The name of the county that is associated with the indexing area.

string
A sequence of characters. (example: GOOG)

countyFipsCode
always returned

3-digit FIPS code of the county is associated with the indexing area.

string
A sequence of characters. (example: GOOG)

lastUpdated
always returned

The date of the index last updated.

date
A date in the format of YYYY-MM-DD.

Status Code Responses

200

OK

Success

400

Bad Request

The request was invalid, please see the message for more information.

500

Internal Server Error

Something is not working correctly, please contact support.

JSON

GET

GET https://ondemand.websol.barchart.com/getYieldForecastPlanet.json?apikey=YOUR_API_KEY&country=US&state=IL&stateFips=17&districtCode=50&county=Champaign+County&countyFips=019&crop=corn&indexGroup=district&fields=shortName
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getYieldForecastPlanet.json
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&country=US&state=IL&stateFips=17&districtCode=50&county=Champaign+County&countyFips=019&crop=corn&indexGroup=district&fields=shortName

Response

{
    "status": {
        "code": 204,
        "message": "Success, but no content to return."
    },
    "results": []
}

XML

GET

GET https://ondemand.websol.barchart.com/getYieldForecastPlanet.xml?apikey=YOUR_API_KEY&country=US&state=IL&stateFips=17&districtCode=50&county=Champaign+County&countyFips=019&crop=corn&indexGroup=district&fields=shortName
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getYieldForecastPlanet.xml
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&country=US&state=IL&stateFips=17&districtCode=50&county=Champaign+County&countyFips=019&crop=corn&indexGroup=district&fields=shortName

Response

<?xml version="1.0" encoding="utf-8"?>
<getYieldForecastPlanet>
  <status>
    <code>204</code>
    <message>Success, but no content to return.</message>
  </status>
</getYieldForecastPlanet>

CSV

GET

GET https://ondemand.websol.barchart.com/getYieldForecastPlanet.csv?apikey=YOUR_API_KEY&country=US&state=IL&stateFips=17&districtCode=50&county=Champaign+County&countyFips=019&crop=corn&indexGroup=district&fields=shortName
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getYieldForecastPlanet.csv
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&country=US&state=IL&stateFips=17&districtCode=50&county=Champaign+County&countyFips=019&crop=corn&indexGroup=district&fields=shortName

Response

PHP

<?php

$ondemand = new SoapClient('https://ondemand.websol.barchart.com/service?wsdl');

$params = [
    'apikey' => 'YOUR_API_KEY',
    'country' => 'US',
    'state' => 'IL',
    'stateFips' => '17',
    'districtCode' => '50',
    'county' => 'Champaign County',
    'countyFips' => '019',
    'crop' => 'corn',
    'indexGroup' => 'district',
    'fields' => 'shortName',
];

$result = $ondemand->getYieldForecastPlanet($params);
var_dump($result);

Classic ASP

Dim ondemand
Dim result

Set ondemand = Server.CreateObject("MSSOAP.SoapClient30")
ondemand.ClientProperty("ServerHTTPRequest") = True
ondemand.MSSoapInit("https://ondemand.websol.barchart.com/service?wsdl")

Set result = ondemand.getYieldForecastPlanet("YOUR_API_KEY", "US", "IL", "17", "50", "Champaign County", "019", "corn", "district", "shortName")

Perl

use SOAP::Lite;
use SOAP::WSDL;

my $ondemand = SOAP::Lite
    -> service('https://ondemand.websol.barchart.com/service?wsdl');

my $result = $ondemand->getYieldForecastPlanet('YOUR_API_KEY', 'US', 'IL', '17', '50', 'Champaign County', '019', 'corn', 'district', 'shortName');

print $result;

Python

from suds.client import Client
ondemand = Client('https://ondemand.websol.barchart.com/service?wsdl')

result = ondemand.service.getYieldForecastPlanet('YOUR_API_KEY', 'US', 'IL', '17', '50', 'Champaign County', '019', 'corn', 'district', 'shortName')

print(result)

Ruby

require 'savon'

ondemand = Savon.client(wsdl: 'https://ondemand.websol.barchart.com/service?wsdl')

response = ondemand.call(
    :getYieldForecastPlanet,
    message: {
        apikey: 'YOUR_API_KEY',
        country: 'US',
        state: 'IL',
        stateFips: '17',
        districtCode: '50',
        county: 'Champaign County',
        countyFips: '019',
        crop: 'corn',
        indexGroup: 'district',
        fields: 'shortName',
    }
)

response.body