Can I connect with the Cool Farm Platform via API?

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 documentation on SwaggerUI here. This is available when logged in to the CFP on the left hand side. From SwaggerUI, you can run demo calls, try out the available endpoints under the “Public” section and see schemas and examples. You will find the data schemas under the relevant endpoints w

If you want to create a programmatic integration with the CFP, you need a specific API app key. You can request this via the "support" form directly in the platform or send an email to support@coolfarmtool.org. In the long run, API keys can be created by authorised member users from Swagger.

    • 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 ...

    • Cool Farm Platform - Perennials Data Input Table

      Find attached a list of all data points required to complete a perennials assessment in the Cool Farm Platform.

    • Cool Farm Guidance Videos

      Perennials Pathway - Cool Farm Platform Sign-up to CFP Top Tips: Helpful features to navigate the Cool Farm Platform Step by step video coming up in 2025 Biodiversity How to use the Cool Farm Biodiversity Metric

    • Cool Farm Tool Quick Start Guide

      Here's a helpful guide for the first steps in the Cool Farm Tool, as well as setting up data sharing and account features with codes exclusive to our members.

    • TOP TIPS that help you navigate the new Cool Farm Platform

      In the below video we give you a preview of the new Cool Farm Platform and explain the structure as well as the main functionalities and features you should look out for when making a perennials assessment. TOP TIPS 1. Knowledge Base & Support Form ...