The Cecil SDK is a Python 3 library that allows you to use our data services. The SDK integrates with our internal API using standard HTTP authentication, methods, and response codes. Our data resources use RFC 3339 timestamps and universally unique identifiers (UUID v4).
Install the Cecil SDK in your project virtual environment.
pip install cecil
Configure the SDK with your API key. Make sure to store your API key in an encrypted vault 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
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.
import cecil
client = cecil.Client()
client.list_aois()
The area of interest (AOI) represents a geographic area anywhere globally.
<aside> <img src="/icons/info-alternate_gray.svg" alt="/icons/info-alternate_gray.svg" width="40px" />
Some datasets have specific AOI restrictions such as a minimum size in hectares or maximum number of vertices. You can see the specific AOI restrictions for each dataset on the details page of available datasets.
</aside>
| Property | Type | Default value | Description |
|---|---|---|---|
id |
uuid | 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 useful for cost tracking. |
created_at |
datetime | Current system time | Timestamp in UTC when the AOI was created. |
created_by |
uuid | Authenticated user ID | User who created the AOI. |
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 | Nested array of coordinates. |