{"id":16965323,"url":"https://github.com/magicmonkey/givenergy_api_python_client","last_synced_at":"2025-03-21T17:28:18.003Z","repository":{"id":206090412,"uuid":"715801758","full_name":"magicmonkey/givenergy_api_python_client","owner":"magicmonkey","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-08T22:51:53.000Z","size":171,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-26T12:27:56.446Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/magicmonkey.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-07T21:29:56.000Z","updated_at":"2023-11-07T21:31:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"79c30db0-b704-4322-be41-4ab89f64df51","html_url":"https://github.com/magicmonkey/givenergy_api_python_client","commit_stats":null,"previous_names":["magicmonkey/givenergy_api_python_client"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicmonkey%2Fgivenergy_api_python_client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicmonkey%2Fgivenergy_api_python_client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicmonkey%2Fgivenergy_api_python_client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicmonkey%2Fgivenergy_api_python_client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magicmonkey","download_url":"https://codeload.github.com/magicmonkey/givenergy_api_python_client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244837338,"owners_count":20518612,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T23:45:41.307Z","updated_at":"2025-03-21T17:28:17.983Z","avatar_url":"https://github.com/magicmonkey.png","language":"Python","readme":"# openapi-client\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.6\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport openapi_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport openapi_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport openapi_client\nfrom openapi_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.givenergy.cloud/v1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = openapi_client.Configuration(\n    host = \"https://api.givenergy.cloud/v1\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: default\nconfiguration = openapi_client.Configuration(\n    access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith openapi_client.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = openapi_client.AccountApi(api_client)\n    user_id = '1234' # str | The ID of the user.\n    page = 1 # int | Page number to return (optional)\n    page_size = 56 # int | Number of items to return in a page. Defaults to 15 (optional)\n    authorization = 'Bearer {YOUR_API_KEY}' # str |  (optional)\n\n    try:\n        # Get Account Children Information by ID\n        api_response = api_instance.get_account_children_information_by_id(user_id, page=page, page_size=page_size, authorization=authorization)\n        print(\"The response of AccountApi-\u003eget_account_children_information_by_id:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling AccountApi-\u003eget_account_children_information_by_id: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.givenergy.cloud/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AccountApi* | [**get_account_children_information_by_id**](docs/AccountApi.md#get_account_children_information_by_id) | **GET** /account-children/{user_id} | Get Account Children Information by ID\n*AccountApi* | [**get_account_dongles_by_id**](docs/AccountApi.md#get_account_dongles_by_id) | **GET** /account/{user_username}/devices | Get Account Dongles by ID\n*AccountApi* | [**get_account_information_by_id**](docs/AccountApi.md#get_account_information_by_id) | **GET** /account/{user_id} | Get Account Information by ID\n*AccountApi* | [**get_account_information_by_username**](docs/AccountApi.md#get_account_information_by_username) | **GET** /account/search/{user_username} | Get Account Information by Username\n*AccountApi* | [**get_your_account_children_information**](docs/AccountApi.md#get_your_account_children_information) | **GET** /account-children | Get Your Account Children Information\n*AccountApi* | [**get_your_account_information**](docs/AccountApi.md#get_your_account_information) | **GET** /account | Get Your Account Information\n*CommunicationDeviceApi* | [**get_communication_device_information_by_serial_number**](docs/CommunicationDeviceApi.md#get_communication_device_information_by_serial_number) | **GET** /communication-device/{communicationDevice_serial_number} | Get Communication Device Information by Serial Number\n*EVChargerApi* | [**evget_data_points**](docs/EVChargerApi.md#evget_data_points) | **GET** /ev-charger/{charger_uuid}/meter-data | Get Data Points\n*EVChargerApi* | [**get_charging_sessions**](docs/EVChargerApi.md#get_charging_sessions) | **GET** /ev-charger/{charger_uuid}/charging-sessions | Get Charging Sessions\n*EVChargerApi* | [**get_command_data**](docs/EVChargerApi.md#get_command_data) | **GET** /ev-charger/{charger_uuid}/commands/{command_id} | Get Command Data\n*EVChargerApi* | [**get_ev_charger_by_uuid**](docs/EVChargerApi.md#get_ev_charger_by_uuid) | **GET** /ev-charger/{charger_uuid} | Get EV Charger by UUID\n*EVChargerApi* | [**get_supported_commands**](docs/EVChargerApi.md#get_supported_commands) | **GET** /ev-charger/{charger_uuid}/commands | Get Supported Commands\n*EVChargerApi* | [**get_your_ev_chargers**](docs/EVChargerApi.md#get_your_ev_chargers) | **GET** /ev-charger | Get Your EV Chargers\n*EVChargerApi* | [**send_command**](docs/EVChargerApi.md#send_command) | **POST** /ev-charger/{charger_uuid}/commands/{command_id} | Send Command\n*EnergyFlowDataApi* | [**get_energy_flow_data**](docs/EnergyFlowDataApi.md#get_energy_flow_data) | **POST** /inverter/{inverter_serial_number}/energy-flows | Get Energy Flow Data\n*InverterControlApi* | [**get_setting_presets**](docs/InverterControlApi.md#get_setting_presets) | **GET** /inverter/{inverter_serial_number}/presets | Get Setting Presets\n*InverterControlApi* | [**get_settings_list**](docs/InverterControlApi.md#get_settings_list) | **GET** /inverter/{inverter_serial_number}/settings | Get Settings List\n*InverterControlApi* | [**modify_preset**](docs/InverterControlApi.md#modify_preset) | **POST** /inverter/{inverter_serial_number}/presets/{preset} | Modify Preset\n*InverterControlApi* | [**modify_setting**](docs/InverterControlApi.md#modify_setting) | **POST** /inverter/{inverter_serial_number}/settings/{setting_id}/write | Modify Setting\n*InverterControlApi* | [**modify_setting_multiple**](docs/InverterControlApi.md#modify_setting_multiple) | **POST** /multi-control/write | Modify Setting (Multiple)\n*InverterControlApi* | [**read_setting**](docs/InverterControlApi.md#read_setting) | **POST** /inverter/{inverter_serial_number}/settings/{setting_id}/read | Read Setting\n*InverterControlApi* | [**read_setting_multiple**](docs/InverterControlApi.md#read_setting_multiple) | **POST** /multi-control/read | Read Setting (Multiple)\n*InverterDataApi* | [**get_data_points**](docs/InverterDataApi.md#get_data_points) | **GET** /inverter/{inverter_serial_number}/data-points/{date} | Get Data Points\n*InverterDataApi* | [**get_events**](docs/InverterDataApi.md#get_events) | **GET** /inverter/{inverter_serial_number}/events | Get Events\n*InverterDataApi* | [**get_latest_meter_data**](docs/InverterDataApi.md#get_latest_meter_data) | **GET** /inverter/{inverter_serial_number}/meter-data/latest | Get Latest Meter Data\n*InverterDataApi* | [**get_latest_system_data**](docs/InverterDataApi.md#get_latest_system_data) | **GET** /inverter/{inverter_serial_number}/system-data/latest | Get Latest System Data\n*SmartDeviceApi* | [**create_smart_device_data_point**](docs/SmartDeviceApi.md#create_smart_device_data_point) | **POST** /smart-device/{smartDevice_uuid}/data | Create Smart Device Data Point\n*SmartDeviceApi* | [**get_smart_device_by_id**](docs/SmartDeviceApi.md#get_smart_device_by_id) | **GET** /smart-device/{smartDevice_uuid} | Get Smart Device by ID\n*SmartDeviceApi* | [**get_smart_device_data_points_by_id**](docs/SmartDeviceApi.md#get_smart_device_data_points_by_id) | **GET** /smart-device/{smartDevice_uuid}/data | Get Smart Device Data Points by ID\n\n\n## Documentation For Models\n\n - [CreateSmartDeviceDataPoint200Response](docs/CreateSmartDeviceDataPoint200Response.md)\n - [CreateSmartDeviceDataPoint200ResponseDataInner](docs/CreateSmartDeviceDataPoint200ResponseDataInner.md)\n - [CreateSmartDeviceDataPointRequest](docs/CreateSmartDeviceDataPointRequest.md)\n - [EvgetDataPoints200Response](docs/EvgetDataPoints200Response.md)\n - [EvgetDataPoints200ResponseDataInner](docs/EvgetDataPoints200ResponseDataInner.md)\n - [EvgetDataPoints200ResponseDataInnerMeasurementsInner](docs/EvgetDataPoints200ResponseDataInnerMeasurementsInner.md)\n - [GetAccountChildrenInformationByID200Response](docs/GetAccountChildrenInformationByID200Response.md)\n - [GetAccountChildrenInformationByID200ResponseDataInner](docs/GetAccountChildrenInformationByID200ResponseDataInner.md)\n - [GetAccountDonglesByID200Response](docs/GetAccountDonglesByID200Response.md)\n - [GetAccountDonglesByID200ResponseDataInner](docs/GetAccountDonglesByID200ResponseDataInner.md)\n - [GetAccountDonglesByID200ResponseDataInnerInverter](docs/GetAccountDonglesByID200ResponseDataInnerInverter.md)\n - [GetAccountDonglesByID200ResponseDataInnerInverterConnections](docs/GetAccountDonglesByID200ResponseDataInnerInverterConnections.md)\n - [GetAccountDonglesByID200ResponseDataInnerInverterConnectionsBatteriesInner](docs/GetAccountDonglesByID200ResponseDataInnerInverterConnectionsBatteriesInner.md)\n - [GetAccountDonglesByID200ResponseDataInnerInverterConnectionsBatteriesInnerCapacity](docs/GetAccountDonglesByID200ResponseDataInnerInverterConnectionsBatteriesInnerCapacity.md)\n - [GetAccountDonglesByID200ResponseDataInnerInverterFirmwareVersion](docs/GetAccountDonglesByID200ResponseDataInnerInverterFirmwareVersion.md)\n - [GetAccountDonglesByID200ResponseDataInnerInverterInfo](docs/GetAccountDonglesByID200ResponseDataInnerInverterInfo.md)\n - [GetAccountDonglesByID200ResponseDataInnerInverterInfoBattery](docs/GetAccountDonglesByID200ResponseDataInnerInverterInfoBattery.md)\n - [GetAccountDonglesByID200ResponseDataInnerInverterWarranty](docs/GetAccountDonglesByID200ResponseDataInnerInverterWarranty.md)\n - [GetAccountInformationByID200Response](docs/GetAccountInformationByID200Response.md)\n - [GetAccountInformationByID200ResponseData](docs/GetAccountInformationByID200ResponseData.md)\n - [GetAccountInformationByUsername200Response](docs/GetAccountInformationByUsername200Response.md)\n - [GetAccountInformationByUsername200ResponseData](docs/GetAccountInformationByUsername200ResponseData.md)\n - [GetChargingSessions200Response](docs/GetChargingSessions200Response.md)\n - [GetChargingSessions200ResponseDataInner](docs/GetChargingSessions200ResponseDataInner.md)\n - [GetChargingSessionsRequest](docs/GetChargingSessionsRequest.md)\n - [GetCommandData200Response](docs/GetCommandData200Response.md)\n - [GetCommandData200ResponseData](docs/GetCommandData200ResponseData.md)\n - [GetCommunicationDeviceInformationBySerialNumber200Response](docs/GetCommunicationDeviceInformationBySerialNumber200Response.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseData](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseData.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverter](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverter.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnections](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnections.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnectionsBatteriesInner](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnectionsBatteriesInner.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnectionsBatteriesInnerCapacity](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnectionsBatteriesInnerCapacity.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterFirmwareVersion](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterFirmwareVersion.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterInfo](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterInfo.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterInfoBattery](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterInfoBattery.md)\n - [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterWarranty](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterWarranty.md)\n - [GetDataPoints200Response](docs/GetDataPoints200Response.md)\n - [GetDataPoints200ResponseDataInner](docs/GetDataPoints200ResponseDataInner.md)\n - [GetDataPoints200ResponseDataInnerPower](docs/GetDataPoints200ResponseDataInnerPower.md)\n - [GetDataPoints200ResponseDataInnerPowerBattery](docs/GetDataPoints200ResponseDataInnerPowerBattery.md)\n - [GetDataPoints200ResponseDataInnerPowerConsumption](docs/GetDataPoints200ResponseDataInnerPowerConsumption.md)\n - [GetDataPoints200ResponseDataInnerPowerGrid](docs/GetDataPoints200ResponseDataInnerPowerGrid.md)\n - [GetDataPoints200ResponseDataInnerPowerInverter](docs/GetDataPoints200ResponseDataInnerPowerInverter.md)\n - [GetDataPoints200ResponseDataInnerPowerSolar](docs/GetDataPoints200ResponseDataInnerPowerSolar.md)\n - [GetDataPoints200ResponseDataInnerPowerSolarArraysInner](docs/GetDataPoints200ResponseDataInnerPowerSolarArraysInner.md)\n - [GetDataPoints200ResponseDataInnerToday](docs/GetDataPoints200ResponseDataInnerToday.md)\n - [GetDataPoints200ResponseDataInnerTodayBattery](docs/GetDataPoints200ResponseDataInnerTodayBattery.md)\n - [GetDataPoints200ResponseDataInnerTodayGrid](docs/GetDataPoints200ResponseDataInnerTodayGrid.md)\n - [GetDataPoints200ResponseDataInnerTotal](docs/GetDataPoints200ResponseDataInnerTotal.md)\n - [GetDataPoints200ResponseDataInnerTotalBattery](docs/GetDataPoints200ResponseDataInnerTotalBattery.md)\n - [GetDataPoints200ResponseDataInnerTotalGrid](docs/GetDataPoints200ResponseDataInnerTotalGrid.md)\n - [GetEVChargerByUUID200Response](docs/GetEVChargerByUUID200Response.md)\n - [GetEVChargerByUUID200ResponseData](docs/GetEVChargerByUUID200ResponseData.md)\n - [GetEnergyFlowDataRequest](docs/GetEnergyFlowDataRequest.md)\n - [GetEvents200Response](docs/GetEvents200Response.md)\n - [GetEvents200ResponseDataInner](docs/GetEvents200ResponseDataInner.md)\n - [GetEventsRequest](docs/GetEventsRequest.md)\n - [GetLatestMeterData200Response](docs/GetLatestMeterData200Response.md)\n - [GetLatestMeterData200ResponseData](docs/GetLatestMeterData200ResponseData.md)\n - [GetLatestMeterData200ResponseDataToday](docs/GetLatestMeterData200ResponseDataToday.md)\n - [GetLatestMeterData200ResponseDataTodayBattery](docs/GetLatestMeterData200ResponseDataTodayBattery.md)\n - [GetLatestMeterData200ResponseDataTodayGrid](docs/GetLatestMeterData200ResponseDataTodayGrid.md)\n - [GetLatestMeterData200ResponseDataTotal](docs/GetLatestMeterData200ResponseDataTotal.md)\n - [GetLatestMeterData200ResponseDataTotalBattery](docs/GetLatestMeterData200ResponseDataTotalBattery.md)\n - [GetLatestMeterData200ResponseDataTotalGrid](docs/GetLatestMeterData200ResponseDataTotalGrid.md)\n - [GetLatestSystemData200Response](docs/GetLatestSystemData200Response.md)\n - [GetLatestSystemData200ResponseData](docs/GetLatestSystemData200ResponseData.md)\n - [GetLatestSystemData200ResponseDataBattery](docs/GetLatestSystemData200ResponseDataBattery.md)\n - [GetLatestSystemData200ResponseDataGrid](docs/GetLatestSystemData200ResponseDataGrid.md)\n - [GetLatestSystemData200ResponseDataInverter](docs/GetLatestSystemData200ResponseDataInverter.md)\n - [GetLatestSystemData200ResponseDataSolar](docs/GetLatestSystemData200ResponseDataSolar.md)\n - [GetLatestSystemData200ResponseDataSolarArraysInner](docs/GetLatestSystemData200ResponseDataSolarArraysInner.md)\n - [GetSettingsList200Response](docs/GetSettingsList200Response.md)\n - [GetSettingsList200ResponseDataInner](docs/GetSettingsList200ResponseDataInner.md)\n - [GetSmartDeviceByID200Response](docs/GetSmartDeviceByID200Response.md)\n - [GetSmartDeviceByID200ResponseDataInner](docs/GetSmartDeviceByID200ResponseDataInner.md)\n - [GetSmartDeviceByID200ResponseDataInnerOtherData](docs/GetSmartDeviceByID200ResponseDataInnerOtherData.md)\n - [GetSmartDeviceDataPointsByID200Response](docs/GetSmartDeviceDataPointsByID200Response.md)\n - [GetSmartDeviceDataPointsByID200ResponseDataInner](docs/GetSmartDeviceDataPointsByID200ResponseDataInner.md)\n - [GetSupportedCommands200Response](docs/GetSupportedCommands200Response.md)\n - [GetYourAccountChildrenInformation200Response](docs/GetYourAccountChildrenInformation200Response.md)\n - [GetYourAccountChildrenInformation200ResponseDataInner](docs/GetYourAccountChildrenInformation200ResponseDataInner.md)\n - [GetYourAccountInformation200Response](docs/GetYourAccountInformation200Response.md)\n - [GetYourAccountInformation200ResponseData](docs/GetYourAccountInformation200ResponseData.md)\n - [GetYourEVChargers200Response](docs/GetYourEVChargers200Response.md)\n - [GetYourEVChargers200ResponseDataInner](docs/GetYourEVChargers200ResponseDataInner.md)\n - [ModifyPreset200Response](docs/ModifyPreset200Response.md)\n - [ModifyPreset200ResponseData](docs/ModifyPreset200ResponseData.md)\n - [ModifySetting200Response](docs/ModifySetting200Response.md)\n - [ModifySetting200ResponseData](docs/ModifySetting200ResponseData.md)\n - [ModifySettingMultipleRequest](docs/ModifySettingMultipleRequest.md)\n - [ReadSetting200Response](docs/ReadSetting200Response.md)\n - [ReadSetting200ResponseData](docs/ReadSetting200ResponseData.md)\n - [ReadSettingMultipleRequest](docs/ReadSettingMultipleRequest.md)\n - [SendCommand200Response](docs/SendCommand200Response.md)\n - [SendCommand200ResponseData](docs/SendCommand200ResponseData.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n\u003ca id=\"default\"\u003e\u003c/a\u003e\n### default\n\n- **Type**: Bearer authentication\n\n\n## Author\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagicmonkey%2Fgivenergy_api_python_client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagicmonkey%2Fgivenergy_api_python_client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagicmonkey%2Fgivenergy_api_python_client/lists"}