Barchart Other Data API

openapi: 3.2.0
info:
  title: OnDemand Other Data API
  version: 1.0.1
  description: Barchart features a diverse set of market and information APIs that can be easily integrated into your website. Whether you're looking for a small, medium, large or enterprise solution, we'll create a custom package for you that exceeds your expectations.
  contact:
    name: onDemand API Support
    url: https://www.barchart.com/ondemand
    email: support@barchart.com
  termsOfService: https://www.barchart.com/solutions/company/terms-and-privacy
servers:
- url: https://ondemand.websol.barchart.com
tags:
- name: Other Data
paths:
  /getWeather.json:
    get:
      tags:
      - Other Data
      summary: getWeather
      operationId: get-getWeather
      description: Barchart OnDemand's getWeather API provides current conditions and forecasts based on zip code. As well as weather maps based on type or region.
      parameters:
      - in: query
        name: apikey
        description: Enter the secret API key.
        required: true
        schema:
          type: string
          example: YOUR_API_KEY
      - in: query
        name: weatherType
        description: 'The type of weather requested. Includes: Current Conditions ("CC") and Forecast ("F").

          '
        required: false
        schema:
          type: string
          enum:
          - CC
          - F
          - MAP
          example: CC
      - in: query
        name: zipCode
        description: The zip code of the location as a 5-digit numeric value.
        required: false
        schema:
          type: string
          example: '60606'
      - in: query
        name: fields
        description: The fields requested.
        required: false
        schema:
          type: string
          example: windDirection,windSpeed,humidity,dewpoint,forcastedDay,forcastedPrecipitation
      - in: query
        name: mapType
        description: The type of map required. Only valid when using the "MAP" weatherType.
        required: false
        schema:
          type: string
          enum:
          - localRadarAnimation
          - usRadarSatellite
          - usRadarSatelliteAnimation
          - todaysWeatherMap
          - currentWindConditions
          - todaysPrecipitationAccumulation
          - dailyPrecipitation
          - usSoilMoisture
          - usCurrentTemperatures
      - in: query
        name: mapRegion
        description: The region of map required.
        required: false
        schema:
          type: string
          enum:
          - centralPlains
          - dakotas
          - californiaArizona
          - colorado
          - deepSouth
          - delta
          - farWest
          - florida
          - greatBasin
          - greatLakes
          - midAtlantic
          - montana
          - northEast
          - ohioValley
          - pacificNorthwest
          - rockyMountains
          - southAtlantic
          - southPlains
          - southTexas
          - southWest
      - in: query
        name: mapWidth
        description: The width of the map.
        required: false
        schema:
          type: integer
          example: 255
      - in: query
        name: mapHeight
        description: The height of the map.
        required: false
        schema:
          type: integer
          example: 220
      responses:
        '200':
          description: OK (Success)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    description: The status object when an error occurs or when a response is successful.
                    required:
                    - code
                    - message
                    properties:
                      code:
                        description: The status code of the response.
                        type: integer
                        example: 200
                      message:
                        description: The status message corresponding to the status code.
                        type: string
                        example: Success.
                  results:
                    description: The results object of the API operation.
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      properties:
                        weatherType:
                          description: 'The type of weather requested. Includes: Current Conditions ("CC") or Forecast ("F").

                            '
                          type:
                          - string
                          - 'null'
                          example: F
                        zipCode:
                          description: The zip code of the location.
                          type:
                          - string
                          - 'null'
                          example: '60606'
                        location:
                          description: The city or town related to the zip code.
                          type:
                          - string
                          - 'null'
                          example: Chicago, Illinois
                        currentCondition:
                          description: The descriptive of the current condition.
                          type:
                          - string
                          - 'null'
                          example: Few Clouds
                        currentConditionIcon:
                          description: The condition icon's URL.
                          type:
                          - string
                          - 'null'
                          example: https://shared.websol.barchart.com/images/weather/pcldyicon.jpg
                        currentTemperature:
                          description: The current temperature.
                          type:
                          - string
                          - 'null'
                          example: 43\u0026deg;F
                        currentPressure:
                          description: The current atmospheric pressure in Hg.
                          type:
                          - string
                          - 'null'
                          example: 29.77 in. Hg
                        feelsLike:
                          description: The current feels like temperature.
                          type:
                          - string
                          - 'null'
                          example: 33.8\u0026deg;F
                        windDirection:
                          description: The current wind direction.
                          type:
                          - string
                          - 'null'
                          example: Northwest
                        windSpeed:
                          description: The current wind speed.
                          type:
                          - string
                          - 'null'
                          example: 9 mph
                        humidity:
                          description: The current level of humidity.
                          type:
                          - string
                          - 'null'
                          example: 81%
                        dewpoint:
                          description: The current dew point.
                          type:
                          - string
                          - 'null'
                          example: 31\u0026deg;F
                        forecastedDay:
                          description: The name of the day of the week forecasted.
                          type:
                          - string
                          - 'null'
                          example: Wednesday
                        forcastedPrecipitation:
                          description: The amount of forecasted precipitation in inches.
                          type:
                          - string
                          - 'null'
                          example: 0.01 in.
                        chancePrecipitationDay:
                          description: The daytime chance of precipitation.
                          type:
                          - string
                          - 'null'
                          example: 14%
                        chancePrecipitationNight:
                          description: The nighttime chance of precipitation.
                          type:
                          - string
                          - 'null'
                          example: '%'
                        windchill:
                          description: The forecasted windchill temperature.
                          type:
                          - string
                          - 'null'
                          example: 33.8\u0026deg;F
                        dewFrostWeight:
                          description: The dew/frost weight.
                          type:
                          - string
                          - 'null'
                          example: Frost
                        hoursSun:
                          description: The hours of sunlight for today.
                          type:
                          - string
                          - 'null'
                          example: '3.9'
                        soilMoisture:
                          description: The current soil moisture.
                          type:
                          - string
                          - 'null'
                          example: '2.05'
                        evaporation:
                          description: The current level of evaporation.
                          type:
                          - string
                          - 'null'
                          example: '0.25'
                        dryingIndex:
                          description: The current drying index.
                          type:
                          - string
                          - 'null'
                          example: Excellent
                        solarRadiation:
                          description: The current level of solar radiation.
                          type:
                          - string
                          - 'null'
                          example: '3960'
                        livestockSafteyIndex:
                          description: The current livestock safety index.
                          type:
                          - string
                          - 'null'
                          example: Alert
                        cumulativeHDD:
                          description: The cumulative heating degree days.
                          type:
                          - string
                          - 'null'
                          example: '31'
                        cumulativeGDD:
                          description: The cumulative growing degree days.
                          type:
                          - string
                          - 'null'
                          example: '173'
                        forecastDayCondition:
                          description: A descriptive of the weather forecasted for the day.
                          type:
                          - string
                          - 'null'
                          example: Mostly Cloudy
                        forecastDayConditionIcon:
                          description: The condition icon's URL.
                          type:
                          - string
                          - 'null'
                          example: https://shared.websol.barchart.com/images/weather/mcldyicon.jpg
                        forecastNightCondition:
                          description: A descriptive of the weather forecasted for the night.
                          type:
                          - string
                          - 'null'
                          example: Cloudy
                        forecastNightConditionIcon:
                          description: The condition icon's URL.
                          type:
                          - string
                          - 'null'
                          example: https://shared.websol.barchart.com/images/weather/cldyicon.jpg
                        forecastHighTemperature:
                          description: The forecasted high temperature for the day.
                          type:
                          - string
                          - 'null'
                          example: 39\u0026deg;F
                        forecastLowTemperature:
                          description: The forecasted low temperature for the day.
                          type:
                          - string
                          - 'null'
                          example: 27\u0026deg;F
                        mapRegion:
                          description: The map region.
                          type:
                          - string
                          - 'null'
                          example: 'null'
                        mapType:
                          description: The map type.
                          type:
                          - string
                          - 'null'
                          example: localRadarAnimation
                        mapUrl:
                          description: The map image's URL.
                          type:
                          - string
                          - 'null'
                          example: https://shared.websol.barchart.com/weather/weathermap.php/interrad?zipcode=60606\u0026width=560\u0026height=440
                      required:
                      - weatherType
                      - zipCode
                      - location
                      - currentCondition
                      - currentConditionIcon
                      - currentTemperature
                      - currentPressure
                      - feelsLike
                      - mapRegion
                      - mapType
                      - mapUrl
        '204':
          description: No Content
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
  /getGrainBids.json:
    get:
      tags:
      - Other Data
      summary: getGrainBids
      operationId: get-getGrainBids
      description: The getGrainBids API provides cashbid data for 30 closest locations in relation to the requested zip code. Learn more about Barchart's proprietary <a href="https://www.barchart.com/cmdty" target="_blank">commodity data</a> and grain <a href="https://www.barchart.com/cmdty/indexes" target="_blank">cmdtyIndexes</a>.
      parameters:
      - in: query
        name: apikey
        description: Enter the secret API key.
        required: true
        schema:
          type: string
          example: YOUR_API_KEY
      - in: query
        name: requestType
        description: The type of request that is being requested in order to determine the type of data to be returned.
        required: false
        schema:
          type: string
          enum:
          - commodities
          - locations
          - bids
      - in: query
        name: location
        description: 'A location id or a code identifies a or multiple grain buying location(s) that cash bid will be returned for. A valid code consist of multiple location ids separated by a comma, and the code can contain up to 100 locations. A list of valid location ids can be retrieved by using this API with input: requestType = location. location and several other inputs -geographic coordinates, zipCode, maxDistance, county, totalLocations- are mutually exclusive.

          '
        required: false
        schema:
          type: string
      - in: query
        name: latitude
        description: The latitude of a valid geographic coordinates to define the center of area that cashbid will be returned for. Geographic coordinates and Zipcode are mutually exclusive.
        required: false
        schema:
          type:
          - number
          - 'null'
          format: double
      - in: query
        name: longitude
        description: The longitude of a valid geographic coordinates to define the center of area that cashbid will be returned for. Geographic coordinates and Zipcode are mutually exclusive.
        required: false
        schema:
          type:
          - number
          - 'null'
          format: double
      - in: query
        name: zipCode
        description: A valid US or Canadian zip code to define the area that cash bids orginate from.
        required: false
        schema:
          type: string
          example: '60606'
      - in: query
        name: maxDistance
        description: The maximum distance from searched zipcode or the requested geo coordinates in miles. This input helps to define the area that cash bids will be returned from. Maximum value is 250.
        required: false
        schema:
          type:
          - number
          - 'null'
          format: double
      - in: query
        name: county
        description: A valid string code which represents the concatenation of county name and state code seperated by a hyphen.
        required: false
        schema:
          type: string
          example: BOONE COUNTY-IA
      - in: query
        name: fipsCode
        description: A concatenation of state FIPS code and county FIPS code without separator to define the county that cash bids will be returned for. Please click <a target="_blank" href="https://www.nass.usda.gov/Data_and_Statistics/County_Data_Files/Frequently_Asked_Questions/county_list.txt">here</a> to get a list of possible values.
        required: false
        schema:
          type: integer
          example: 17053
      - in: query
        name: commodityName
        description: 'A standard commodity name or a name list that separated by pipe (|) to filter cashbid. Note that the input need to be encoded in UTF-8. A list of valid commodity names can be retrieved by using this API with input: requestType = commodities.

          '
        required: false
        schema:
          type: string
          example: Soybeans|Corn (#2 Yellow)
      - in: query
        name: totalLocations
        description: The maximum number of locations to be returned based of the zip code provided by the user. Default value is 30.
        required: false
        schema:
          type: integer
          example: 1
      - in: query
        name: getAllBids
        description: Return all cash bids for each location.
        required: false
        schema:
          type: string
      - in: query
        name: bidsPerCom
        description: The maximum number of cash bids to be returned for each commodity per location. This parameter should be set to the maximum number of cash bids the user wishes to be returned.
        required: false
        schema:
          type: integer
          example: 2
      - in: query
        name: numOfDecimals
        description: The level of precision in decimal places of price and basis to be returned.
        required: false
        schema:
          type: integer
          example: 2
      - in: query
        name: companyName
        description: Name of the applicable grain buying elevator.
        required: false
        schema:
          type: string
      - in: query
        name: getAllLocations
        description: Return all locations based of the searched zip code.
        required: false
        schema:
          type: integer
      - in: query
        name: rawDistance
        description: Remove the appended string, "mile away", from output:distance.
        required: false
        schema:
          type: string
      - in: query
        name: fields
        description: Additional as per-requested fields that the user can define. Requested fields should be separated by a comma.
        required: false
        schema:
          type: string
      - in: query
        name: deliveryStart
        description: The start date for the delivery period for qualified bids.
        required: false
        schema:
          type: string
      - in: query
        name: deliveryEnd
        description: The end date for the delivery period for qualified bids.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK (Success)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    description: The status object when an error occurs or when a response is successful.
                    required:
                    - code
                    - message
                    properties:
                      code:
                        description: The status code of the response.
                        type: integer
                        example: 200
                      message:
                        description: The status message corresponding to the status code.
                        type: string
                        example: Success.
                  results:
                    description: The results object of the API operation.
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      properties:
                        bids:
                          description: A list of cash bids from a grain buying location. Each cash bid contains the meta and price data applicable to that location.
                          type:
                          - array
                          - 'null'
                          items:
                            anyOf:
                            - type: object
                              example:
                                id: 43423878
                                commodity: CORN
                                symbol: ZCH21
                                delivery_start: 2021-02-21 00:00:00
                                delivery_end: 2021-02-28 23:59:59
                                basis: 4.0
                                notes: null
                                active: true
                                sym_root: ZC
                                commodity_id: 121541
                                customer_commodity_id: 10269
                                commodity_display_name: Corn (#2 Yellow)
                                unitvalue: 1
                                unitweight: 56
                                currency: USD
                                deliveryMonth: Feb21
                                deliveryYear: 2021
                                basismonth: Mar 2021
                                timestamp: 1614186100
                                as_of: 661
                                price: 5.64
                                pricecwt: 10.071429
                                basiscwt: 7.14
                                pricetonne: 222.036729
                                basistonne: 157.47
                                change: 0.0625
                                rawchange: 0.0625
                                pctchange: 1.12
                                cashprice: 5.64
                                cashpricetonne: 222.036729
                                delivery_sort: 2021-02-21 00:00:00
                                delivery_start_raw: 2021-02-21 00:00:00
                                delivery_end_raw: 2021-02-28 23:59:59
                                basisSymbol: ZCBG21L-58118-10269.CM
                                cashPriceSymbol: ZCPG21L-58118-10269.CM
                        distance:
                          description: Distance of the elevator in miles from the input zip code.
                          type:
                          - string
                          - 'null'
                          example: 13 miles away
                        company:
                          description: Name of the applicable grain buying elevator.
                          type:
                          - string
                          - 'null'
                          example: Elburn Coop
                        elevatorId:
                          description: The elevator id.
                          type:
                          - integer
                          - 'null'
                          example: 390
                        locationId:
                          description: The location id.
                          type:
                          - integer
                          - 'null'
                          example: 58118
                        location:
                          description: Name of location that grain bid originated from.
                          type:
                          - string
                          - 'null'
                          example: Ingredion
                        facility_type:
                          description: The type of facility.
                          type:
                          - string
                          - 'null'
                          example: Export Terminal
                        address:
                          description: The street address of the location.
                          type:
                          - string
                          - 'null'
                          example: 6400 S Archer Rd
                        city:
                          description: City associated with the underlying grain bid.
                          type:
                          - string
                          - 'null'
                          example: Bedford Park
                        state:
                          description: 2-char abbreviation of the state that contains the applicable cash bid.
                          type:
                          - string
                          - 'null'
                          example: IL
                        lng:
                          description: The longitude of the location.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: -87.826071
                        lat:
                          description: The latitude of the location.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 41.775032
                        phone:
                          description: The phone number for the location.
                          type:
                          - string
                          - 'null'
                          example: 815-899-8964
                        url:
                          description: The public website of the grain company.
                          type:
                          - string
                          - 'null'
                          example: www.chselburn.com
                        zip:
                          description: The zip code for the location.
                          type:
                          - string
                          - 'null'
                          example: '60501'
                        county:
                          description: The name of the county containing the applicable cash bid.
                          type:
                          - string
                          - 'null'
                          example: Cook County
                        county_code:
                          description: Concatenation of stateFipsCode, countyFipsCode, and classFipsCode.
                          type:
                          - string
                          - 'null'
                          example: IL-17-031-H1
                        fips_code:
                          description: FIPS code for the county. Concatenation of stateFipsCode and countyFipsCode.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 17031
                        crop_district:
                          description: District code of crop reporting district that is associated with the applicable cash bid.
                          type:
                          - string
                          - 'null'
                          example: D20
                        basisTimestamp:
                          description: Time when basis was last updated for given elevator.
                          type:
                          - string
                          - 'null'
                          example: '2021-02-24T09:00:30-06:00'
                        commodities:
                          description: The commodity names.
                          type:
                          - array
                          - 'null'
                          items:
                            anyOf:
                            - type: string
                              example: Barley
                            - type: string
                              example: Beans
                            - type: string
                              example: Beans (Garbonzo)
                            - type: string
                              example: Beans (Lentil)
                            - type: string
                              example: Beans (Pinto)
                        basisTimestampRaw:
                          description: Unix timestamp when basis was last updated for the given elevator.
                          type:
                          - integer
                          - 'null'
                          example: 1614178830
                      required:
                      - bids
                      - distance
                      - company
                      - locationId
                      - location
                      - facility_type
                      - address
                      - city
                      - state
                      - lng
                      - lat
                      - phone
                      - url
                      - zip
                      - county
                      - basisTimestamp
                      - basisTimestampRaw
        '204':
          description: No Content
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
  /getUSDAGrainPrices.json:
    get:
      tags:
      - Other Data
      summary: getUSDAGrainPrices
      operationId: get-getUSDAGrainPrices
      description: Barchart OnDemand's getUSDAGrainPrices API provides daily cash grain bids and prices for grain buying locations throughout the United States covering corn, wheat, oats and soybeans sourcing from USDA reports. This API refreshes on an hourly basis, so bids and prices from USDA reports would be available within an hour after the report is released.
      parameters:
      - in: query
        name: apikey
        description: Enter the secret API key.
        required: true
        schema:
          type: string
          example: YOUR_API_KEY
      - in: query
        name: commodityTypes
        description: 'The type of commodity. Includes: Corn ("C"), Corn Crude Oil ("CCO"), Crude Soybean Oil ("CSO"), DNS/NS Wheat 14% ("WDN"), HRW Wheat ("HRW"), HRW Wheat 11.5% ("HRW11"), Oats ("O"), Ord HRW Wheat ("HRWORD"), Soybean Meal 48% ("SM"), Soybeans ("S"), SRW Wheat ("SRW"), SWW Wheat ("SWW").<br/>Available values (multiple values separated by a comma may be used): *C, CCO, CSO, WDN, HRW, HRW11, O, HRWORD, SM, S, SRW, SWW*.

          '
        required: false
        schema:
          type: string
          example: C
      - in: query
        name: bidTypes
        description: 'The type of bid. Includes: Export ("E"), Processor ("P"), River ("R"), Terminal ("T") and Barge Loading ("B").<br/>Available values (multiple values separated by a comma may be used): *E, P, R, T, B*.

          '
        required: false
        schema:
          type: string
          example: E
      responses:
        

# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/barchart/refs/heads/main/openapi/barchart-other-data-api-openapi.yml