Volume-only Irrigation via the API (irrigationCalculationType = 2)

Volume-only Irrigation via the API (irrigationCalculationType = 2)

How do I use volume-only irrigation via the API?
Set:

irrigationCalculationType = 2

and provide the total volume of water added.

What controls the calculation when irrigationCalculationType = 2 is set?
The calculation is driven only by total water added. Pumping depth and horizontal distance are not used.

Why are pumping depth and horizontal distance present at all?
We recognise this is confusing.

When using volume-only irrigation, these fields:

  • are not available or editable in the web UI

  • do not influence the calculation

  • still appear in the exported JSON due to shared/legacy schema

This is not conceptually required for volume-only irrigation and is a known inconsistency.

Why does the API still require depth/distance units?
This is also unintuitive and not ideal.

Although the values for depth and distance are ignored, the API currently still requires the unit fields to be populated for the request to validate. This is a technical limitation rather than a reflection of the calculation logic.

What should API users do for now?
Until this is improved:

  • set irrigationCalculationType = 2

  • provide total water added

  • set depth and distance values to 0

  • include valid units for those fields

    • Related Articles

    • I am interested in connecting my software to the CFT via API. What is needed for that?

      Ensure you are reading the guidance for the correct Tool. We have guidance that varies based on whether you are using the CFT or CFP, outlined below. Cool Farm Tool In the https://app.coolfarmtool.org/ at the end of the page you can find the API ...

    • How do I classify 'hose and pump' irrigation systems?

      Remember that details on irrigation are not required. This section only needs to be filled out if you want help from the tool in calculating the amount of energy use involved in irrigation (and therefore GHG). Since the Cool Farm Tool does not have ...

    • Can I connect with the Cool Farm Platform via API?

      You can indeed connect with the Cool Farm Platform via API. This is only available to Members, and temporarily for project-users, and for a fee dependent on predicted calls. If you have a signed CFP API licence agreement, you can access the API ...

    • CFA API Licence Agreement

      Please find the API licence agreement below. All API use needs to be covered by a separate API Licence agreement which comes with additional fees, on top on the membership/ project fees. The API fees are based on your predicted API call volume as ...

    • CFA API Licence Agreement - for Corporate Groups

      Please find the Corporate Group API Licence Agreement below: