# FoxCloud OpenAPI
## Docs
- [What's New & Milestones](https://tzfvg9zm63.apifox.cn/9208154m0.md):
- Getting Started [1. Overview & Integration Scope](https://tzfvg9zm63.apifox.cn/9092113m0.md):
- Getting Started [2. Environments & Prerequisites](https://tzfvg9zm63.apifox.cn/9104489m0.md):
- End-User Enrollment & OAuth Flow [0. Introduction](https://tzfvg9zm63.apifox.cn/9136207m0.md):
- End-User Enrollment & OAuth Flow [1. The User Authorization Journey](https://tzfvg9zm63.apifox.cn/9092116m0.md):
- End-User Enrollment & OAuth Flow [2. OAuth Token Operating Model](https://tzfvg9zm63.apifox.cn/9092117m0.md):
- End-User Enrollment & OAuth Flow [3. Implementation Guide](https://tzfvg9zm63.apifox.cn/9103767m0.md):
- API Technical Specifications [1. Universal Request Rules](https://tzfvg9zm63.apifox.cn/9136181m0.md):
- API Technical Specifications [2. Rate Limiting Strategy](https://tzfvg9zm63.apifox.cn/9136224m0.md):
- API Technical Specifications [3. Response Structure](https://tzfvg9zm63.apifox.cn/9136241m0.md):
- API Technical Specifications [4. Error Code Reference](https://tzfvg9zm63.apifox.cn/9136183m0.md):
- Telemetry & Data Acquisition [1. Data Pipeline & Scaling Strategy](https://tzfvg9zm63.apifox.cn/9092119m0.md):
- Telemetry & Data Acquisition [2. Telemetry Data Query (Real-time)](https://tzfvg9zm63.apifox.cn/9103771m0.md):
- Telemetry & Data Acquisition [4. Telemetry Variable Dictionary](https://tzfvg9zm63.apifox.cn/9136328m0.md):
- Telemetry & Data Acquisition [5. System Performance & SLA](https://tzfvg9zm63.apifox.cn/9144334m0.md):
- Telemetry & Data Acquisition [3. Device Configuration & Settings: Pre-Dispatch State Awareness](https://tzfvg9zm63.apifox.cn/9104353m0.md):
- Control Commands & Dispatch [1. Core Dispatch Architecture: Scheduler V3](https://tzfvg9zm63.apifox.cn/9092120m0.md):
- Control Commands & Dispatch [2. Scheduler V3 Operations](https://tzfvg9zm63.apifox.cn/9105033m0.md):
- Control Commands & Dispatch [3. Real-time Device Settings](https://tzfvg9zm63.apifox.cn/9105034m0.md):
- Control Commands & Dispatch [4. Strategic Roadmap: Scaling for Massive Fleets](https://tzfvg9zm63.apifox.cn/9105035m0.md):
- FAQ [Troubleshooting Quick Guide](https://tzfvg9zm63.apifox.cn/9140871m0.md):
## API Docs
- Power Station [Get power station list](https://tzfvg9zm63.apifox.cn/481057931e0.md): Obtain the list of power stations to which this account belongs
- Power Station [Get power station detail](https://tzfvg9zm63.apifox.cn/481057927e0.md): Obtain details about a power station based on the power station ID
- Power Station [Create power station](https://tzfvg9zm63.apifox.cn/481057928e0.md): request body example:
- Power Station [Delete power station](https://tzfvg9zm63.apifox.cn/481057929e0.md): request body example:
- Power Station [Edit power station](https://tzfvg9zm63.apifox.cn/481057930e0.md): request body example:
- VPP [authorization code mode offboard by sn](https://tzfvg9zm63.apifox.cn/481057933e0.md):
- VPP [client mode offboard](https://tzfvg9zm63.apifox.cn/481057935e0.md):
- VPP [client mode onboard](https://tzfvg9zm63.apifox.cn/481057936e0.md):
- Inverter-V1 [Get device setting capabilities](https://tzfvg9zm63.apifox.cn/507151470e0.md): Call this endpoint before GET or SET. It returns only the setting groups and fields supported by the specified device.
- Inverter-V1 [Read device settings](https://tzfvg9zm63.apifox.cn/507152103e0.md): Capability-first workflow:
- Inverter-V1 [Write device settings](https://tzfvg9zm63.apifox.cn/507151472e0.md): Capability-first workflow:
- Inverter-V1 [Get device detail](https://tzfvg9zm63.apifox.cn/481057942e0.md): Obtain inverter details
- Inverter-V1 [Get device real-time data](https://tzfvg9zm63.apifox.cn/481057944e0.md): Get the latest real-time data of the inverter. The sn array is mandatory and returns only the result set belonging to the current user. If no variable is specified, all variables are queried
- Inverter [Get device list](https://tzfvg9zm63.apifox.cn/481057945e0.md): Obtain the list of inverters owned by this account
- Inverter [Get device detail (Deprecated)](https://tzfvg9zm63.apifox.cn/481057946e0.md): Obtain inverter details
- Inverter [Get available variables](https://tzfvg9zm63.apifox.cn/481057947e0.md): Obtain variable tables for use by real-time data and historical data interfaces
- Inverter [Get error code information](https://tzfvg9zm63.apifox.cn/481057948e0.md): Obtain error code information
- Inverter [Get device real-time data (Deprecated)](https://tzfvg9zm63.apifox.cn/481057949e0.md): Get the latest real-time data of the inverter, and get the real-time data of all devices under the name without specifying the SN
- Inverter [Get device history data](https://tzfvg9zm63.apifox.cn/481057950e0.md): The historical data within the specified 24 hours can be obtained（The begin time and end time are required). If no time period is specified, you can obtain the historical data of the last three days.
- Inverter [Get device production report](https://tzfvg9zm63.apifox.cn/481057951e0.md): Obtain the inverter electricity consumption report. Calculated according to the time zone of the power station to which the inverter belongs.The monthly electricity consumption of the year is obtained, the daily electricity consumption of the month is obtained, and the hourly electricity consumption of the day is obtained
- Inverter [Get device power generation](https://tzfvg9zm63.apifox.cn/481057952e0.md): Returns the device power generation: today / month / cumulative (kWh). Reads the inverter AC generation ledger (energy_type=2). A field returns -1 when its data is not generated yet (posting not finished, device offline or newly installed, or cache unavailable) - retry later; 0 is a genuine zero value.
- Inverter [Get the minimum soc settings for the battery of device ](https://tzfvg9zm63.apifox.cn/481057953e0.md): Obtain the inverter battery soc Settings
- Inverter [Set the minmum soc for the battery of the device ](https://tzfvg9zm63.apifox.cn/481057954e0.md): Set the minmum soc for the battery of the device
- Inverter [Get the setting of battery charging time](https://tzfvg9zm63.apifox.cn/481057955e0.md): Obtain the setting of battery charging time
- Inverter [Set the battery charging time](https://tzfvg9zm63.apifox.cn/481057956e0.md): Set the battery charging time. The period must be two periods. Both periods must be delivered
- Inverter [Get the device settings item](https://tzfvg9zm63.apifox.cn/481057957e0.md): Obtain the device settings
- Inverter [Set the device settings item](https://tzfvg9zm63.apifox.cn/481057958e0.md): Deliver device settings
- Inverter [Get the device time](https://tzfvg9zm63.apifox.cn/481057959e0.md):
- Inverter [Set the device time](https://tzfvg9zm63.apifox.cn/481057960e0.md): Modify the device time
- Inverter [Get the device peakshaving settings](https://tzfvg9zm63.apifox.cn/481057961e0.md):
- Inverter [Set the device peakshaving settings](https://tzfvg9zm63.apifox.cn/481057962e0.md):
- Inverter [Get the Meter Reader](https://tzfvg9zm63.apifox.cn/481057963e0.md):
- Inverter [Set the Meter Reader](https://tzfvg9zm63.apifox.cn/481057964e0.md):
- Inverter [Get battery heating Parameter](https://tzfvg9zm63.apifox.cn/481057965e0.md): response body example:
- Inverter [Set battery heating Parameter](https://tzfvg9zm63.apifox.cn/481057966e0.md): response body example:
- Inverter [Get display sleep Paeameter](https://tzfvg9zm63.apifox.cn/481057967e0.md): response body example:
- Inverter [Set display sleep Paeameter](https://tzfvg9zm63.apifox.cn/481057968e0.md):
- Inverter [Get the device third party PV Integration status](https://tzfvg9zm63.apifox.cn/481057970e0.md): Indicates if a third-party PV system is integrated based on data from the last 24 hours. **Rate Limit:** 1 request per hour due to high calculation overhead.
- Inverter [Get Device Fault History](https://tzfvg9zm63.apifox.cn/481057971e0.md): Query the fault history of an inverter.
- Inverter [Get device PV power generation](https://tzfvg9zm63.apifox.cn/518858522e0.md): Query the PV power generation point (PVEnergyTotal) of an inverter: today / month / cumulative values, in the time zone of the power station to which the inverter belongs.
- Scheduler-V3 [Get the time segment information](https://tzfvg9zm63.apifox.cn/481057973e0.md): Get timing mode segment information
- Scheduler-V3 [Set the time segment information](https://tzfvg9zm63.apifox.cn/481057974e0.md): Set the time segment information of the timing mode
- Scheduler-V3 [Batch set the time segment information](https://tzfvg9zm63.apifox.cn/481057975e0.md): This API is used to batch configure Scheduler V3 time segment settings for multiple devices asynchronously.
- Scheduler-V2 [Get the time segment information](https://tzfvg9zm63.apifox.cn/481057976e0.md): Get timing mode segment information
- Scheduler-V2 [Set the time segment information](https://tzfvg9zm63.apifox.cn/481057977e0.md): Set the time segment information of the timing mode
- Scheduler-V1 [Get the main switch status](https://tzfvg9zm63.apifox.cn/481057978e0.md): Obtain the timing mode switch status
- Scheduler-V1 [Set the main switch status](https://tzfvg9zm63.apifox.cn/481057979e0.md): Set the timing mode switch
- Scheduler-V1 [Get the time segment information](https://tzfvg9zm63.apifox.cn/481057980e0.md): Get timing mode segment information
- Scheduler-V1 [Set the time segment information](https://tzfvg9zm63.apifox.cn/481057981e0.md): Set the time segment information of the timing mode
- Scheduler (Deprecated) [Get the main switch status (Deprecated)](https://tzfvg9zm63.apifox.cn/481057982e0.md): Obtain the timing mode switch status
- Scheduler (Deprecated) [Get the time segment information (Deprecated)](https://tzfvg9zm63.apifox.cn/481057983e0.md): Get timing mode segment information
- Scheduler (Deprecated) [Set the main switch status (Deprecated)](https://tzfvg9zm63.apifox.cn/481057984e0.md): Set the timing mode switch
- Scheduler (Deprecated) [Set the time segment information (Deprecated)](https://tzfvg9zm63.apifox.cn/481057985e0.md): Set the time segment information of the timing mode
- Data Logger [Get Data Logger list](https://tzfvg9zm63.apifox.cn/481057986e0.md): Obtain the collector list of this account
- Data Logger [Get Data Logger Details](https://tzfvg9zm63.apifox.cn/481057987e0.md):
- Data Logger [Get Data Logger Signal](https://tzfvg9zm63.apifox.cn/481057988e0.md):
- Data Logger [Get Data Logger Wifi Info](https://tzfvg9zm63.apifox.cn/481057990e0.md):
- Data Logger [Get Data Logger Lan Info](https://tzfvg9zm63.apifox.cn/481057991e0.md):
- EMS [Get Ems list](https://tzfvg9zm63.apifox.cn/481057992e0.md): Obtain the ems list of this account
- EMS [Get Ems real-time data](https://tzfvg9zm63.apifox.cn/481057993e0.md): Get the latest real-time data of the inverter. The sn array is mandatory and returns only the result set belonging to the current user. If no variable is specified, all variables are queried
- EMS [Get Ems history data](https://tzfvg9zm63.apifox.cn/481057994e0.md): Get the latest real-time data of the inverter. The sn array is mandatory and returns only the result set belonging to the current user. If no variable is specified, all variables are queried
- EMS [Get Ems System Setting](https://tzfvg9zm63.apifox.cn/481057995e0.md):
- EMS [Set Ems System Setting](https://tzfvg9zm63.apifox.cn/481057996e0.md):
- EMS [Get Ems Rate Setting](https://tzfvg9zm63.apifox.cn/481057997e0.md):
- EMS [Set Ems Rate Setting](https://tzfvg9zm63.apifox.cn/481057998e0.md):
- EMS [Set Ems Ac Output Control Setting](https://tzfvg9zm63.apifox.cn/481057999e0.md):
- EMS [Get Ems Ac Output Control Setting](https://tzfvg9zm63.apifox.cn/481058000e0.md):
- EMS [Set Ems Power Limit Control Setting](https://tzfvg9zm63.apifox.cn/481058001e0.md):
- EMS [Get Ems Power Limit Control Setting](https://tzfvg9zm63.apifox.cn/481058002e0.md):
- EMS [Set Ems More Setting](https://tzfvg9zm63.apifox.cn/481058003e0.md):
- EMS [Get Ems More Setting](https://tzfvg9zm63.apifox.cn/481058004e0.md):
- EMS [Set Ems Gen Setting](https://tzfvg9zm63.apifox.cn/481058005e0.md):
- EMS [Get Ems Gen Setting](https://tzfvg9zm63.apifox.cn/481058006e0.md):
- Meter [Get meter list](https://tzfvg9zm63.apifox.cn/481058007e0.md):
- Meter [Get the device settings item](https://tzfvg9zm63.apifox.cn/481058008e0.md):
- Meter [Set the device settings item](https://tzfvg9zm63.apifox.cn/481058009e0.md):
- Heat [genericControlsGet](https://tzfvg9zm63.apifox.cn/481058013e0.md):
- Heat [genericControlsSet](https://tzfvg9zm63.apifox.cn/481058014e0.md):
- Heat [heatingControlsGet](https://tzfvg9zm63.apifox.cn/481058015e0.md):
- Heat [heatingControlsSet](https://tzfvg9zm63.apifox.cn/481058016e0.md):
- Heat [heatingCircuitsControlsGet](https://tzfvg9zm63.apifox.cn/481058017e0.md):
- Heat [heatingCircuitsControlsSet](https://tzfvg9zm63.apifox.cn/481058018e0.md):
- Heat [dhwControlsGet](https://tzfvg9zm63.apifox.cn/481058019e0.md):
- Heat [dhwControlsSet](https://tzfvg9zm63.apifox.cn/481058020e0.md):
- Heat [heatAssetList-OAuth flow unsupported](https://tzfvg9zm63.apifox.cn/507592728e0.md):
- Heat [changeKafkaPushStatus-OAuth flow unsupported](https://tzfvg9zm63.apifox.cn/507592729e0.md):
## Schemas
- [CapabilityRequest](https://tzfvg9zm63.apifox.cn/308373031d0.md):
- [batteryList](https://tzfvg9zm63.apifox.cn/290244695d0.md):
- [HeatAssetListParam](https://tzfvg9zm63.apifox.cn/290244712d0.md):
- [CapabilityResponse](https://tzfvg9zm63.apifox.cn/308373032d0.md):
- [Result](https://tzfvg9zm63.apifox.cn/290244696d0.md):
- [CapabilityResult](https://tzfvg9zm63.apifox.cn/308373033d0.md):
- [CapabilityGroup](https://tzfvg9zm63.apifox.cn/308373034d0.md):
- [WeComLoginRequest](https://tzfvg9zm63.apifox.cn/290244698d0.md):
- [CapabilityField](https://tzfvg9zm63.apifox.cn/308373035d0.md):
- [ResponseInfo](https://tzfvg9zm63.apifox.cn/290244699d0.md):
- [ValueRange](https://tzfvg9zm63.apifox.cn/308373036d0.md):
- [Holiday](https://tzfvg9zm63.apifox.cn/290244700d0.md):
- [SettingGetRequest](https://tzfvg9zm63.apifox.cn/308373037d0.md):
- [DailyTimer](https://tzfvg9zm63.apifox.cn/290244701d0.md):
- [SettingGetResponse](https://tzfvg9zm63.apifox.cn/308373038d0.md):
- [GenericControlsData](https://tzfvg9zm63.apifox.cn/290244702d0.md):
- [SettingGetResult](https://tzfvg9zm63.apifox.cn/308373039d0.md):
- [GenericControlsParam](https://tzfvg9zm63.apifox.cn/290244703d0.md):
- [SettingSetRequest](https://tzfvg9zm63.apifox.cn/308373040d0.md):
- [WeekTimerItem](https://tzfvg9zm63.apifox.cn/290244704d0.md):
- [SettingSetResponse](https://tzfvg9zm63.apifox.cn/308373041d0.md):
- [HeatingControlsData](https://tzfvg9zm63.apifox.cn/290244705d0.md):
- [HeatingControlsParam](https://tzfvg9zm63.apifox.cn/290244706d0.md):
- [CircuitActivation](https://tzfvg9zm63.apifox.cn/290244707d0.md):
- [CircuitType](https://tzfvg9zm63.apifox.cn/290244708d0.md):
- [HeatingCircuitsControlsParam](https://tzfvg9zm63.apifox.cn/290244709d0.md):
- [DhwControlsData](https://tzfvg9zm63.apifox.cn/290244710d0.md):
- [DhwControlsParam](https://tzfvg9zm63.apifox.cn/290244711d0.md):
- [HolidayAway](https://tzfvg9zm63.apifox.cn/290244713d0.md):
- [HolidayHome](https://tzfvg9zm63.apifox.cn/290244714d0.md):
- [HeatKafkaPushStatusParam](https://tzfvg9zm63.apifox.cn/290244715d0.md):
- [TimerItem](https://tzfvg9zm63.apifox.cn/290244716d0.md):
- [DailyTimerTimerItem](https://tzfvg9zm63.apifox.cn/290244717d0.md):
- [DhwTimerItem](https://tzfvg9zm63.apifox.cn/290244718d0.md):
- [DailyTimerDhwTimerItem](https://tzfvg9zm63.apifox.cn/290244719d0.md):
- [TimerItem](https://tzfvg9zm63.apifox.cn/290244720d0.md):
- [DailyTimer](https://tzfvg9zm63.apifox.cn/290244721d0.md):
- [WeeklyTimer](https://tzfvg9zm63.apifox.cn/290244722d0.md):
- [DailyTimerTimerItem](https://tzfvg9zm63.apifox.cn/290244723d0.md):
- [BivalencePoint](https://tzfvg9zm63.apifox.cn/290244724d0.md):
- [DhwTimerItem](https://tzfvg9zm63.apifox.cn/290244725d0.md):
- [AuxiliaryHeaterSettings](https://tzfvg9zm63.apifox.cn/290244726d0.md):
- [DailyTimerDhwTimerItem](https://tzfvg9zm63.apifox.cn/290244727d0.md):
- [WeeklyTimerWeekTimerItem](https://tzfvg9zm63.apifox.cn/290244728d0.md):
- [BaseWeekTimerItem](https://tzfvg9zm63.apifox.cn/290244729d0.md):
- [WeeklyTimerBaseWeekTimerItem](https://tzfvg9zm63.apifox.cn/290244730d0.md):
- [CureSetting](https://tzfvg9zm63.apifox.cn/290244731d0.md):
- [HeatingCurves](https://tzfvg9zm63.apifox.cn/290244732d0.md):
- [HeatingCircuitsControlsData](https://tzfvg9zm63.apifox.cn/290244733d0.md):
- [TimerItem](https://tzfvg9zm63.apifox.cn/290244734d0.md):
- [DailyTimer](https://tzfvg9zm63.apifox.cn/290244735d0.md):
- [BivalencePoint](https://tzfvg9zm63.apifox.cn/290244736d0.md):
- [AuxiliaryHeaterSettings](https://tzfvg9zm63.apifox.cn/290244737d0.md):