The Cecil SDK is a Python 3 library that allows you to use our data services. The SDK uses our internal API with standard HTTP authentication, methods, and response codes. Our data resources use RFC 3339 timestamps and universally unique identifiers (UUID).

Installation

Install the Cecil SDK in your project virtual environment.

pip install cecil

Authentication

Make sure to store your API key in an encrypted vault, password, or secrets manager. Never store API keys in your code or plain/text files.

export CECIL_API_KEY="my-api-key"

set CECIL_API_KEY=my-api-key

Account security

We recommend you to automatically rotate your API key on a regular basis. You can also recover your API key via email in case it’s been lost.

Rotate API key

Recover API key

Usage

import cecil

client = cecil.Client()

client.list_aois()

AOI

The area of interest (AOI) represents a geographic area anywhere globally.

Property Type Default value Description
id string Generated by Cecil Unique identifier.
name required string Human readable name.
geometry required object GeoJSON geometry object in EPSG:4326 delimiting the boundary.
hectares float Derived from the geometry Total size in hectares. This is derived from the geometry and used for cost tracking.
created_at datetime Current time Current system time in UTC when the AOI is created.
created_by string Provided by Cecil Authenticated user ID who created the AOI.

Geometry

The GeoJSON geometry object in EPSG:4326 delimiting the boundary of the AOI.

Property Type Default value Description
type required string Polygon or MultiPolygon.
coordinates required list of coordinates Maximum of 1,500 vertices.

Create AOI