# Frequenz Assets API
[](https://github.com/frequenz-floss/frequenz-api-assets/actions/workflows/ci.yaml)
[](https://pypi.org/project/frequenz-api-assets/)
[](https://frequenz-floss.github.io/frequenz-api-assets/)
## Overview
The Frequenz Platform Assets API allows for the retrieval of platform assets information. Unlike CRUD-centric
APIs, the focus here is on accessing already registered assets ranging from microgrids and gridpools to
individual electrical components within these structures, such as sensors and their respective electrical connections.
## Objective
The main objective is to enable the building of intelligent cloud applications that can orchestrate and manage
microgrids and gridpools for various purposes. This includes discharging batteries in a coordinated manner
across multiple microgrids, optimizing spot market trading based on real-time grid consumption, and more.
## Key Features
- Asset Retrieval: Provides programmatic access to a wide range of platform assets, including microgrids,
gridpools, electrical components, and connections.
- Data-Driven Optimization: Facilitates the development of applications that can read asset information and
statuses for real-time decision making.
- Scheduling Insights: Enables applications to understand and adapt to gridpool schedules for improved spot
market trading.
## Scope and Limitations
- Retrieval of detailed asset data for various entities such as microgrids, gridpools, and their electrical components.
- Enabling advanced analytics and data-driven decisions for cloud applications.
- Read-Only: The API is designed for data retrieval and doesn't support CRUD operations for assets.
- Dependence on Platform: The quality and timeliness of data are dependent on the capabilities of the underlying platform.
## Target Audience
The API is primarily geared towards cloud application developers focused on building intelligent software
solutions for orchestrating microgrid operations or facilitating gridpool trading.
## Contributing
If you want to know how to build this project and contribute to it, please
check out the [Contributing Guide](CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "frequenz-api-assets",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.11",
"maintainer_email": null,
"keywords": "frequenz, python, api, grpc, protobuf, rpc, assets, assets, microgrid, gridpools, components",
"author": null,
"author_email": "Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>",
"download_url": "https://files.pythonhosted.org/packages/40/5b/eb11e10de593534ba06d3cc538804431c52e280d88f0463bf47d787da028/frequenz_api_assets-0.1.0.tar.gz",
"platform": null,
"description": "# Frequenz Assets API\n\n[](https://github.com/frequenz-floss/frequenz-api-assets/actions/workflows/ci.yaml)\n[](https://pypi.org/project/frequenz-api-assets/)\n[](https://frequenz-floss.github.io/frequenz-api-assets/)\n\n## Overview\n\nThe Frequenz Platform Assets API allows for the retrieval of platform assets information. Unlike CRUD-centric \nAPIs, the focus here is on accessing already registered assets ranging from microgrids and gridpools to \nindividual electrical components within these structures, such as sensors and their respective electrical connections.\n\n## Objective\n\nThe main objective is to enable the building of intelligent cloud applications that can orchestrate and manage \nmicrogrids and gridpools for various purposes. This includes discharging batteries in a coordinated manner \nacross multiple microgrids, optimizing spot market trading based on real-time grid consumption, and more.\n\n## Key Features\n\n- Asset Retrieval: Provides programmatic access to a wide range of platform assets, including microgrids, \n gridpools, electrical components, and connections.\n- Data-Driven Optimization: Facilitates the development of applications that can read asset information and \n statuses for real-time decision making.\n- Scheduling Insights: Enables applications to understand and adapt to gridpool schedules for improved spot \n market trading.\n\n## Scope and Limitations\n\n- Retrieval of detailed asset data for various entities such as microgrids, gridpools, and their electrical components.\n- Enabling advanced analytics and data-driven decisions for cloud applications.\n- Read-Only: The API is designed for data retrieval and doesn't support CRUD operations for assets.\n- Dependence on Platform: The quality and timeliness of data are dependent on the capabilities of the underlying platform.\n\n## Target Audience\n\nThe API is primarily geared towards cloud application developers focused on building intelligent software \nsolutions for orchestrating microgrid operations or facilitating gridpool trading. \n\n## Contributing\n\nIf you want to know how to build this project and contribute to it, please\ncheck out the [Contributing Guide](CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Frequenz gRPC API to retrieval platform assets information",
"version": "0.1.0",
"project_urls": {
"Changelog": "https://github.com/frequenz-floss/frequenz-api-assets/releases",
"Documentation": "https://frequenz-floss.github.io/frequenz-api-assets/",
"Issues": "https://github.com/frequenz-floss/frequenz-api-assets/issues",
"Repository": "https://github.com/frequenz-floss/frequenz-api-assets",
"Support": "https://github.com/frequenz-floss/frequenz-api-assets/discussions/categories/support"
},
"split_keywords": [
"frequenz",
" python",
" api",
" grpc",
" protobuf",
" rpc",
" assets",
" assets",
" microgrid",
" gridpools",
" components"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f2ecb577fcbf3e2ce8dbf4084f80e476f7f2c34c3597946877cd70d4027c8794",
"md5": "a236127a1a89c11a2107148b1576bcdb",
"sha256": "d31e14e83ac4cf15666d6d458b433bf91e5b56564c530d55373cfcdc7397e511"
},
"downloads": -1,
"filename": "frequenz_api_assets-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a236127a1a89c11a2107148b1576bcdb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.11",
"size": 11100,
"upload_time": "2025-10-07T10:37:46",
"upload_time_iso_8601": "2025-10-07T10:37:46.538709Z",
"url": "https://files.pythonhosted.org/packages/f2/ec/b577fcbf3e2ce8dbf4084f80e476f7f2c34c3597946877cd70d4027c8794/frequenz_api_assets-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "405beb11e10de593534ba06d3cc538804431c52e280d88f0463bf47d787da028",
"md5": "e4a126e354318efa879cb5a0710ab287",
"sha256": "7e893bb550d420c3938e2620a0e5eff2843b25d6fd7169c39140ba8641925cbe"
},
"downloads": -1,
"filename": "frequenz_api_assets-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e4a126e354318efa879cb5a0710ab287",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.11",
"size": 69851,
"upload_time": "2025-10-07T10:37:47",
"upload_time_iso_8601": "2025-10-07T10:37:47.819333Z",
"url": "https://files.pythonhosted.org/packages/40/5b/eb11e10de593534ba06d3cc538804431c52e280d88f0463bf47d787da028/frequenz_api_assets-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-07 10:37:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "frequenz-floss",
"github_project": "frequenz-api-assets",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "frequenz-api-assets"
}
JSON
