API - Version 1 (current)

You can communicate with the Cool Farm Tool (CFT) using HTTP, allowing applications or scripts you write to:

• NEW Added optional parameter irrigation_calculation_type which is used to determine whether to use the default or IPCC 2013 calculations (see: Calculating using the CFT) for irrigation events.

• BETA save assessments and use them in the features of the tool, for example aggregation or reporting. (see Saving assessments using the CFT)

• fetch input and emissions data stored in the CFT for visualisation or further analysis (see Retrieving information with the API),

• send input data, and receive immediate emissions estimates (see Calculating using the CFT)

• pre-fill information for a product assessment (see Sending information to the CFT with the API).

Follow the Quick Start Guide to start exchanging information with the CFT immediately.

Contents:

• What’s new in CFT 1.0
  • Useful resources
  • Dropped support for APIv0
  • Crop API - calculate & create endpoints
  • Dairy API - calculate & create endpoints
• What’s new in CFT 2.0
  • Useful resources
  • Farm Object update
  • Crop API - calculate & create endpoints
  • Dairy API
  • Miscellaneous
  • Reference data tables updated
• Authentication
  • Application-level API keys
  • User-level API keys
  • Registering a new account
• Retrieving information with the API
  • Using the farm endpoint (deprecated)
  • Using the farms endpoint
  • Using the farms endpoint with a slug
  • Retrieving calculation data for your assessments
• Calculating using the CFT
  • Crop assessment
  • Dairy assessment
  • Water assessment
  • JSON export
• Sending information to the CFT with the API
• Saving assessments using the CFT
  • Crop assessment
  • Dairy assessment
• Data schemas
  • Crop “Calculate”
  • Dairy “Calculate”
  • Water “Calculate”