Dataset Endpoints

Store and manage your energy data with support for static datasets, live data feeds, and both time series and geospatial data types.

POST /datasets/timeseries-static

Creates a static time series dataset with pre-loaded data.

# Create a static time series dataset
dataset = client.datasets.create_timeseries_static(
    name="Wind Farm Production Data",
    data=[...],
    description="Historical wind farm production data"
)

POST /datasets/timeseries-live

Creates a live time series dataset that fetches data from external APIs.

# Create a live time series dataset
dataset = client.datasets.create_timeseries_live(
    name="Live Wind Data",
    url="https://api.windfarm.com/data",
    params={...},
    data_format="json",
    aliases={...}
)

POST /datasets/geospatial-static

Creates a static geospatial dataset with point, line, or polygon data.

# Create a static geospatial dataset
dataset = client.datasets.create_geospatial_static(
    name="Wind Turbine Locations",
    data=[...],
    coordinate_system="EPSG:4326",
    geometry_type="Point"
)

GET /datasets

Retrieves all datasets for the authenticated user.

# List all datasets
datasets = client.datasets.list_datasets()

GET /datasets/

Retrieves a specific dataset by ID.

# Get a specific dataset by ID string
dataset = client.datasets.get_dataset("dataset_123")

# Or if you have a dataset object
dataset = client.datasets.get_dataset(dataset.id)

GET /datasets//data

Retrieves dataset data with optional time filtering for live datasets.

# Get dataset data with time filtering by ID string
data = client.datasets.get_dataset_data(
    "dataset_456",
    start="2024-01-01T00:00:00Z",
    end="2024-01-02T00:00:00Z"
)

# Or if you have a dataset object
data = client.datasets.get_dataset_data(
    dataset.id,
    start="2024-01-01T00:00:00Z",
    end="2024-01-02T00:00:00Z"
)

PUT /datasets/

Updates a dataset’s basic properties (name, description, metadata).

# Update a dataset by ID string
updated_dataset = client.datasets.update_dataset(
    "dataset_123",
    name="Updated Wind Farm Production Data",
    description="Updated historical wind farm production data",
    metadata={...}
)

# Or if you have a dataset object
updated_dataset = client.datasets.update_dataset(
    dataset.id,
    name="Updated Wind Farm Production Data",
    description="Updated historical wind farm production data",
    metadata={...}
)

DELETE /datasets/

Permanently deletes a dataset and all its associated data.

# Delete a dataset by ID string
client.datasets.delete_dataset("dataset_123")

# Or if you have a dataset object
client.datasets.delete_dataset(dataset.id)

Dataset Types

Time Series Datasets

timeseries-static - Pre-loaded historical data
timeseries-live - Real-time data from external APIs

Geospatial Datasets

geospatial-static - Point, line, or polygon data

Required Fields

Time Series Data

Required: timestamp field (ISO 8601 format)
Optional: Any additional numeric or string fields

Geospatial Data

Geometry: GeoJSON format (Point, LineString, Polygon)
Properties: Additional metadata for each feature
Coordinate System: EPSG:4326 (WGS84) by default

Live Dataset Configuration

Data Formats: JSON, CSV, XML
Authentication: Bearer Token, API Key, Basic Auth
Time Filtering: start, end parameters (ISO 8601 format)

Overview

Endpoints

Documentation Index