{ "openapi": "3.0.1", "info": { "title": "Federal Crop Insurance Quoter", "description": "", "version": "1.0" }, "servers": [ { "url": "https://ag-analytics.azure-api.net/FederalCropInsuranceQuoter" } ], "paths": { "/post": { "post": { "summary": "POST Request Federal Crop Insurance Quoter", "description": "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name | \nType | \nDescription | \n
---|---|---|
FIPS | \nint | \nThe FIPS code of a county (e.g. 17019). See county FIPS codes for full listing. | \n
CropCode | \nint | \nThe code for a crop (e.g. corn's crop code is 41). See Crop Codes Summary for full listing. | \n
Type | \nint | \nThe code for the type of a crop (e.g. corn type grain is 16). See Crop Codes Summary for full listing. | \n
Practice | \nint | \nThe code for the practice type of a crop (e.g. non-irrigated is 3). See Crop Codes Summary for full listing. | \n
PreventedPlanning | \nint | \nAn integer in the range [0,2]. 0 = Standard, 1 = Plus 5%, 2 = Plus 1 | \n
UseTAYield | \nint | \nAn integer in the range [0,1]. 1 = Use Trend-Adjusted Yield, 0 = do not use Trend-Adjusted Yield | \n
SharePercentage | \ndouble | \nA float indicating the insured share percent, in the range [0.001, 1] | \n
TrendAdjustedYield | \ndouble | \nA double specifying the Trend-Adjusted Yield | \n
Acres | \ndouble | \nA double specifying the acreage. | \n
Year | \nint | \nAn integer specifying the year that the calculation should take place for. | \n
APHYield | \ndouble | \nA double specifying the Actual Production History Yield | \n
Price | \ndouble | \nA double specifying the projected crop price | \n
Volatility | \ndouble | \nA double specifying the volatility of the crop | \n
ReturnParameters | \nint | \nIf value is 1, parameters for the steps of the premium calculation are included in the response. If value is 0, parameters from the premium calculation are not included in the response. | \n
HighRiskCode | \nString | \nSubcounty high risk code that the insured field is located in, and is relevant to the specified crop, practice, and type (e.g. 'AAA'). | \n
Name | \nType | \nDescription | \n
---|---|---|
Premium | \ndouble[8 , 9] | \nThe eight arrays are for coverage levels 50% - 85%, index corresponding the ascending coverage. Within each array, index values are as shown: double[*, 0] → RP Optional, double[*, 1] → RP Basic, double[*, 2] → RP Enterprise, double[*, 3] → RPHPE Optional, double[*, 4] → RPHPE Basic, double[*, 5] → RPHPE Enterprise, double[*, 6] → YP Optional, double[*, 7] → YP Basic, double[*, 8] → YP Enterprise | \n
PremiumAllAcres | \ndouble[8 , 9] | \nThe premium per acre from the ‘Premium’ value multiplied by the acreage. Has same index structure as ‘Premium’. | \n
Subsidy | \ndouble[8 , 2] | \nThe eight arrays are for coverage levels 50% - 85%, index corresponding the ascending coverage. Within each array, index arrays are as follows: double[* , 0] → Subsidy rate for Basic/Optional units double[* , 1] → Subsidy rate for Enterprise units. | \n
Liability | \ndouble[8 , 1] | \nThe eight arrays are for coverage levels 50% - 85%, index corresponding the ascending coverage. Each value is the liability at that coverage level. | \n
TotalPremium | \ndouble[8 , 9] | \nSame structure as ‘Premium’. Values are the premiums before the subtracting the subsidy. | \n
TotalPremiumAllAcres | \ndouble[8 , 9] | \nThe total premium per acre from ‘TotalPremium’ multiplied by the acreage amount. Has same index structure as ‘Premium’. | \n
SubsidyAmount | \ndouble[8 , 9] | \nSame index structure as ‘Premium’. Values are the dollar amount per acre that are subtracted from the ‘TotalPremium’ to give you the ‘Premium’. | \n
SubsidyAmountAllAcres | \ndouble[8 , 9] | \nThe subsidy amount per acre from ‘SubsidyAmountAllAcres’ multiplied by acreage amount. Has same index structure as ‘Premium’. | \n
Guarantee | \ndouble[8 , 3] | \nThe eight arrays are for 50-85% coverage levels with index corresponding to ascending coverage level. The values in each array are as follows: double[* , 0] → Minimum Revenue Guarantee double[* , 1] → Revenue guarantee double[* , 2] → Yield guarantee | \n
CountyLevelPrem | \ndouble[5, 9] | \nThe five arrays are for coverage levels index corresponding the ascending coverage. The values in each list match the index structure in ‘Premium’. | \n
CountyLevelGuarantee | \ndouble[5 , 3] | \nThe five arrays are for coverage levels index corresponding the ascending coverage. The values in each array are as follows: double[*, 0] → Minimum Revenue Guarantee double[*, 1] → Revenue guarantee double[*, 2] → Yield guarantee | \n
CountyDataAvailable | \nbool | \nIndicates whether county level data is available for the input given. | \n
Plans | \nInt[] | \nArray of unspecified length, indicating what insurance plans are available for the inputs given. | \n
Parameters | \nstring | \nArray of unspecified length, indicating what insurance plans are available for the inputs given. Coverage levels (e.g. ‘50%’) Policy (‘rp’, ‘yp’, ‘rphpe’) Unit (‘Basic’, ‘Optional’, ‘Enterprise’) Parameters (Parameters of the equation) | \n