Verdantix Platform Documentation
Welcome to the official documentation for the Verdantix Green Tech Platform. This guide covers everything from initial setup to advanced API integration, carbon footprint analytics, and renewable energy system management.
Verdantix v3.2 introduces real-time IoT telemetry streaming and expanded EU compliance reporting. Check the Changelog for breaking changes.
Platform Overview
The Verdantix platform provides a unified interface for monitoring, analyzing, and optimizing renewable energy infrastructure. Key capabilities include:
- Real-time Energy Telemetry: Sub-second data ingestion from solar arrays, wind turbines, and smart grids
- Carbon Footprint Analytics: Automated Scope 1, 2, and 3 emissions tracking with ISO 14064 compliance
- Device Orchestration: Secure OCPP 1.6/2.0 and Modbus TCP integration for edge hardware
- ESG Reporting: One-click generation of audit-ready sustainability reports
System Requirements
| Component | Minimum Version | Notes |
|---|---|---|
| Node.js | 18.x+ | LTS recommended for production |
| PostgreSQL | 14.x+ | Required for time-series data storage |
| Redis | 7.x+ | Caching and pub/sub for telemetry |
| Docker | 24.x+ | Recommended for local development |
Authentication
All API requests require a bearer token. Tokens are scoped to specific organizational projects and expire after 3600 seconds by default.
import { VerdantixClient } from '@verdantix/sdk';
const client = new VerdantixClient({
apiKey: process.env.VERDANTIX_API_KEY,
environment: 'eu-west-1' // or 'us-east-1'
});
const token = await client.auth.exchangeCredentials({
clientId: 'proj_solar_array_alpha',
scope: ['telemetry:read', 'carbon:write']
});
console.log(token.expiresIn); // 3600
Core Concepts
1. Energy Streams
Data flows through Verdantix via Stream objects. Each stream represents a physical data source (inverter, meter, sensor) and supports configurable sampling rates up to 100Hz.
2. Carbon Calculations
Emissions are calculated using region-specific grid emission factors. The engine automatically applies the latest IPCC and EPA methodologies based on your deployment zone.
3. Edge Agents
For offline-capable installations, deploy the Verdantix Edge Agent. It buffers telemetry locally and syncs when connectivity is restored, guaranteeing zero data loss.
Use the batch endpoint for high-frequency telemetry. It supports up to 5000 data points per request and reduces network overhead by ~40%.
Next Steps
- Follow the Quick Start Guide to deploy your first monitoring node
- Explore the Energy Data API for raw telemetry endpoints
- Review Security & Compliance for production hardening