HTTP API Reference

Last Updated: 2025-02-21

Integrate our robust climate forecasting data and engine into your workflows with a developer-friendly interface.

Choose your client

Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, Koi offers clients for JavaScript and Python. In the following example, you can see how to install each client.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

After picking your preferred client, you are ready to make your first call to the Koi API. Below, you can see how to send a GET request to the Models endpoint to get a list of all your models. In the cURL example, results are limited to ten models, the default page length for each client.

curl -G https://api.koi.eco/v1/models \
  -H "Authorization: Bearer {token}" \
  -d limit=10

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Koi API:

• Grab your API key from the Koi dashboard
• Check out the available endpoints
• Learn about the different error messages in Koi