GrünstromIndex SDKs & Libraries: Official & Community (2026)

SDKs overview

GrünstromIndex offers Software Development Kits (SDKs) and libraries designed to streamline the integration of its green energy data into various applications. These tools abstract the underlying HTTP requests and JSON parsing, enabling developers to focus on application logic rather than low-level API interactions. The core functionality of the GrünstromIndex API includes access to real-time green energy availability, forecasted energy mix, and historical data, which are crucial for optimizing smart device charging, reducing carbon emissions, and scheduling energy consumption efficiently (GrünstromIndex documentation).

Using an SDK can reduce development time by providing pre-written code for common API operations, handling authentication, request formatting, and response parsing (Mozilla Developer Network SDK definition). GrünstromIndex provides official SDKs for widely used programming languages, ensuring robust and supported access to its services. Community-contributed libraries further extend the reach and adaptability of the API across different environments and use cases, often addressing specific developer needs or niche applications.

The API itself is documented with examples for Python and cURL, reflecting the common choices for developers interacting with web services (GrünstromIndex API reference). Authentication for all API access is managed via API keys, which are typically passed in request headers. The data returned by the API is consistently formatted as JSON, facilitating easy parsing and integration into modern applications.

Official SDKs by language

GrünstromIndex provides official SDKs to facilitate direct interaction with its API endpoints. These SDKs are maintained by GrünstromIndex and are designed to offer a stable and supported method for accessing green energy data.

Each official SDK is designed to encapsulate the API's authentication mechanisms and data structures, simplifying the process of making requests and handling responses. Detailed documentation for each SDK, including method signatures and example usage, can be found within the comprehensive GrünstromIndex developer documentation.

Installation

Installing the GrünstromIndex SDKs typically involves using the package manager specific to your programming language. Below are common installation instructions for the officially supported SDKs.

Python SDK Installation

To install the Python SDK, use pip, the Python package installer:

pip install gruenstromindex-python

This command downloads and installs the latest version of the gruenstromindex-python package from PyPI. Ensure you have a compatible Python version installed (typically Python 3.7 or newer) and that pip is up to date.

Node.js SDK Installation

For Node.js applications, use npm, the Node.js package manager:

npm install @gruenstromindex/node-sdk

This command adds the @gruenstromindex/node-sdk package to your project's node_modules directory and updates your package.json file. Node.js version 14 or higher is generally recommended for compatibility.

PHP SDK Installation

PHP projects can install the SDK using Composer, the dependency manager for PHP:

composer require gruenstromindex/php-sdk

This command downloads the PHP SDK and its dependencies into your project's vendor directory. Ensure Composer is installed globally on your system. The PHP SDK typically requires PHP 7.4 or newer.

Quickstart example

This section provides a quickstart example using the Python SDK to retrieve the current GrünstromIndex for a specific location. Before running this example, ensure you have installed the Python SDK as described in the Python SDK Installation section and have obtained an API key from your GrünstromIndex account.

Python Quickstart

The following Python code snippet demonstrates how to initialize the SDK with your API key and fetch the current green energy index. Replace 'YOUR_API_KEY' with your actual GrünstromIndex API key.

import os
from gruenstromindex import Client

# It's recommended to load your API key from environment variables
# For demonstration, we'll use a placeholder. NEVER hardcode API keys in production code.
api_key = os.environ.get('GRUENSTROMINDEX_API_KEY', 'YOUR_API_KEY')

if api_key == 'YOUR_API_KEY':
    print("Warning: Please replace 'YOUR_API_KEY' with your actual API key or set GRUENSTROMINDEX_API_KEY environment variable.")
    exit()

client = Client(api_key=api_key)

# Example: Get the current green energy index for Berlin, Germany
# The API expects latitude and longitude.
latitude = 52.5200
longitude = 13.4050

try:
    # Fetching live data for the specified coordinates
    live_data = client.get_live_index(latitude=latitude, longitude=longitude)
    
    if live_data and live_data.get('data'):
        current_index = live_data['data'][0]
        print(f"GrünstromIndex Live Data for Lat: {latitude}, Lon: {longitude}")
        print(f"Timestamp: {current_index.get('timestamp')}")
        print(f"Green Energy Share: {current_index.get('gsi')}% (0-100)")
        print(f"Carbon Intensity: {current_index.get('co2_g_per_kwh')} gCO2/kWh")
    else:
        print("No live data found for the specified coordinates.")

except Exception as e:
    print(f"An error occurred: {e}")

This example initializes the Client with the API key and then calls the get_live_index method with geographical coordinates. The response contains the timestamp, the percentage of green energy in the mix (GSI), and the carbon intensity in grams of CO2 per kilowatt-hour. For more detailed usage and available methods, refer to the GrünstromIndex API reference documentation.

Community libraries

While GrünstromIndex maintains official SDKs, the developer community often contributes additional libraries and wrappers that extend the API's usability or provide integrations with specific frameworks and platforms. These community-driven projects can offer solutions for languages not officially supported or provide specialized functionalities that complement the official offerings.

Community libraries are typically found on public code repositories like GitHub or language-specific package indexes (e.g., PyPI for Python, npm for Node.js). Developers interested in leveraging community contributions should exercise due diligence in evaluating the library's maintenance status, documentation, and community support. It is advisable to review the source code and check for recent updates or open issues before integrating a community library into a production environment. The GrünstromIndex official documentation may occasionally highlight notable community projects, but the primary source for these is often the broader open-source ecosystem.

Examples of potential community contributions could include:

• Client libraries for other languages: Such as Go, Ruby, Java, or C#.
• Framework-specific integrations: For example, a wrapper for a specific web framework like Django or Express.
• Data visualization tools: Libraries that help plot GrünstromIndex data on maps or charts.
• IoT device integrations: Code examples or libraries for integrating green energy data directly into smart home or industrial IoT devices to optimize energy usage based on real-time grid conditions.

Developers are encouraged to check platforms like GitHub for repositories tagged with "GrünstromIndex" or similar keywords to discover community-developed tools. When using community libraries, remember that their support and updates are dependent on the maintainers and not directly managed by GrünstromIndex.