salzburgnetz 0.0.1

API Client for the Serviceportal of Salzburg Netz GmbH

py-salzburgnetz

An asynchronous Python API client for the Salzburg Netz GmbH Serviceportal. This library allows you to access smart meter data, including consumption profiles, equipment information, and contract details.

Important Links

• Service Portal
• Serviceportal FAQ
• Programmierschnittstelle (API) zum automatisierten Abruf von Daten
• API Documentation (offline PDF)

Features

• Asynchronous: Built on aiohttp for efficient non-blocking I/O.
• Type-safe: Uses Pydantic models for data validation and IDE autocompletion.
• Comprehensive: Supports various endpoints:
  • Load profiles (standard and energy communities)
  • Installation (Anlagen) information
  • Equipment and meter details
  • Partner and outage information
  • Meter readings
  • Contract accounts (Vertragskonto)
• Flexible Formats: Supports JSON (default), CSV, and XML response formats.

Installation

pip install salzburgnetz

Note: Replace with actual installation command if hosted on PyPI or use pip install git+https://github.com/DavidProdinger/py-salzburgnetz.git for GitHub.

Usage

You need a Token and your Customer ID from the Salzburg Netz Serviceportal to use this API.

Basic Example

import asyncio
from salzburgnetz.api import SalzburgNetzApi

async def main():
    # Authentication details from Salzburg Netz Serviceportal
    TOKEN = "your_api_token"
    CUSTOMER_ID = 12345678

    async with SalzburgNetzApi(token=TOKEN, customer=CUSTOMER_ID) as api:
        # Get all installations
        anlagen = await api.anlage()
        for anlage in anlagen:
            print(f"Anlage: {anlage.Anlage}, Zählpunkt: {anlage.Zählpunkt}")
            
            # Fetch consumption profile for a specific Zählpunkt
            profile = await api.profile(zaehlpunkt=anlage.Zählpunkt)
            for entry in profile:
                print(f"Time: {entry.timestamp}, Value: {entry.Wert} {entry.Einheit}")

if __name__ == "__main__":
    asyncio.run(main())

Advanced Usage

Fetching specific formats

You can request data in JSON (parsed to models), CSV, or XML (as strings).

from salzburgnetz.const import ApiFormat

# Returns a string in CSV format
csv_data = await api.profile(zaehlpunkt="...", response_format=ApiFormat.CSV)

# Returns a string in XML format
xml_data = await api.profile(zaehlpunkt="...", response_format=ApiFormat.XML)

Energy Communities (Energiegemeinschaft)

profile_eg = await api.profile_eg(zaehlpunkt="...")

Data Models

The library maps API responses to Pydantic models:

• Anlage: Installation details.
• Equipment: Meter and device information.
• Profile: Consumption data points with helper properties like timestamp.
• Partner: Customer profile and outage notifications.
• Reading: Historical meter readings.

Requirements

• Python 3.9+
• aiohttp
• pydantic

Development

Running Tests

Tests require environment variables for authentication:

export SALZBURGNETZ_TOKEN="your_token"
export SALZBURGNETZ_CUSTOMER="your_customer_id"
export SALZBURGNETZ_ZP1="your_test_zaehlpunkt"
pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.

Disclaimer

This project is not affiliated with, maintained by, or endorsed by Salzburg Netz GmbH. It is an independent community project.