# Hanchu ESS API

**Canonical:** https://apis.io/apis/hanchu-ess/hanchu-ess-api/  
**Provider:** Hanchu ESS — https://apis.io/providers/hanchu-ess/  
**Base URL:** https://idaas-sandbox.hanchuess.com  
**Documentation:** https://docs.hanchuess.com/home/api-reference/user/get-user-detail.md

Hanchu ESS API is published by [Hanchu ESS](https://apis.io/providers/hanchu-ess/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Hanchu ESS API as documented publicly: 19 operations. Contract generated from the documentation by API Evangelist (2026-11-17); not the provider's own document.

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/users/link` | Link Generation |
| POST | `/api/v1/station/list` | Get your power plant |
| POST | `/portal/oauth/revoke` | Grant withdraw (Optional) |
| GET | `/portal/oauth/token` | GET /portal/oauth/token |
| POST | `/portal/oauth/token` | POST /portal/oauth/token |
| POST | `/portal/users/link` | User Link |
| POST | `/v1/account/detail` | Get User Detail |
| POST | `/v1/device/battery/charge-discharge-records` | Obtain charge or discharge records in your battery with default interval of 30m. |
| POST | `/v1/device/detail` | Obtain device detail by device ID. |
| POST | `/v1/device/inverter/historical` | Obtain inverter historical data by device ID. |
| POST | `/v1/device/inverter/realtime` | Obtain inverter realtime data by device ID. |
| POST | `/v1/device/list` | Obtain device list by station ID. |
| POST | `/v1/oem/resubscribe` | Modify your subscriptions. |
| POST | `/v1/oem/subscribe` | Register partner webhookUrl to HanChuESS under specified event types. |
| POST | `/v1/oem/subscriptions` | Get your subscription list. |
| POST | `/v1/oem/subscriptions/test` | Test your subscription and active its status when succeeded. |
| DELETE | `/v1/oem/{oem}/unsubscribe/{subscriptionid}` | Unsubscribe oem webhookUrl which already registered in HanChuESS. |
| POST | `/v1/station/detail` | Get plant detail |
| POST | `/v1/station/list` | OObtain station list created by user who had logged in HanchuESS. |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/hanchu-ess/openapi/_ae-authored/hanchu-ess-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/hanchu-ess/json-schema/hanchu-ess-post-v1-device-inverter-historical-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hanchu-ess/json-schema/hanchu-ess-post-v1-account-detail-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hanchu-ess/json-schema/hanchu-ess-post-v1-device-battery-charge-discharge-records-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hanchu-ess/json-schema/hanchu-ess-post-v1-oem-resubscribe-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hanchu-ess/json-schema/hanchu-ess-post-v1-device-inverter-historical-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hanchu-ess/json-schema/hanchu-ess-post-v1-oem-subscribe-request-schema.json
- **APIsJSON** — https://artifacts.apis.io/hanchu-ess/apis.yml

## Use this from code or an agent

- **REST, no key:** `GET https://apis.io/api/v1/providers/hanchu-ess` returns the provider's full profile as JSON.
- **MCP:** `https://apis.io/mcp` (Streamable HTTP) — search the catalog, read any provider, compare providers, check agent readiness.
- **Free API key** for catalog-wide search, ratings and comparisons: sign in with GitHub, Google or LinkedIn at https://apis.io/developer/account/ (plans: https://apis.io/developer/plans/).

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hanchu-ess/hanchu-ess-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hanchu-ess/.
