FranklinWH API Endpoints Mapping¶

A complete mapping of the internal franklinwh-cloud Python methods to their corresponding Cloud API HTTP endpoints.

Account¶

Python Method	Arguments	HTTP	Cloud API Endpoint	Cookbook Sample
`get_home_gateway_list()`	—	GET	`/{dynamic_url}`	View Examples
`get_entrance_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_unread_count()`	—	GET	`/{dynamic_url}`	View Examples
`get_notifications()`	`pageNum, pageSize`	GET	`/{dynamic_url}`	View Examples
`get_notification_settings()`	—	GET	`/{dynamic_url}`	View Examples
`get_site_and_device_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_warranty_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_equipment_location()`	—	GET	`/{dynamic_url}`	View Examples
`get_user_resources()`	—	GET	`/{dynamic_url}`	View Examples
`get_alarm_codes_list()`	—	GET	`/{dynamic_url}`	View Examples
`get_programme_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_benefit_info()`	`data_type, day_time`	GET	`/{dynamic_url}`	View Examples
`get_gateway_alarm()`	—	GET	`/{dynamic_url}`	View Examples
`get_grid_profile_info()`	`requestType`	GET	`/{dynamic_url}`	View Examples
`get_geography_list()`	`countryId`	GET	`/{dynamic_url}`	View Examples
`get_backup_history()`	`requestType, pageNum, pageSize`	GET	`/{dynamic_url}`	View Examples
`smart_assistant()`	`requestType, query`	POST	`/{dynamic_url}`	View Examples
`get_electric_data()`	`data_type, day_time`	GET	`/{dynamic_url}`	View Examples
`get_charge_history()`	`page_num, page_size`	GET	`/{dynamic_url}`	View Examples

Python Method	Arguments	HTTP	Cloud API Endpoint	Cookbook Sample
`get_accessories()`	`option`	GET	`/{dynamic_url}`	View Examples
`get_power_cap_config_list()`	—	GET	`/{dynamic_url}`	View Examples
`get_device_run_log_list()`	—	GET	`/{dynamic_url}`	View Examples
`get_device_composite_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_agate_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_apower_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_device_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_span_settings()`	`requestType`	GET	`/{dynamic_url}`	View Examples
`get_span_setting()`	—	GET	`/{dynamic_url}`	View Examples
`get_generator_info()`	—	GET	`/{dynamic_url}`	View Examples
`set_generator_mode()`	`mode`	POST	`/{dynamic_url}`	View Examples
`get_site_detail()`	`site_id`	GET	`/{dynamic_url}`	View Examples
`get_device_detail()`	—	GET	`/{dynamic_url}`	View Examples
`get_device_overall_info()`	—	GET	`/{dynamic_url}`	View Examples

Python Method	Arguments	HTTP	Cloud API Endpoint	Cookbook Sample
`set_mode()`	`requestedOperatingMode, requestedSOC, reqbackupForeverFlag, reqnextWorkMode, reqdurationMinutes`	POST	`/{dynamic_url}`	View Examples
`update_soc()`	`requestedSOC, workMode, electricityType`	POST	`/{dynamic_url}`	View Examples

Python Method	Arguments	HTTP	Cloud API Endpoint	Cookbook Sample
`set_grid_status()`	`status, soc`	POST	`/{dynamic_url}`	View Examples
`get_grid_status()`	—	GET	`/{dynamic_url}`	View Examples
`get_power_control_settings()`	—	GET	`/{dynamic_url}`	View Examples
`set_power_control_settings()`	`globalGridDischargeMax, globalGridChargeMax`	POST	`/{dynamic_url}`	View Examples
`get_pcs_hintinfo()`	`dispatchIdList`	POST	`/{dynamic_url}`	View Examples

Python Method	Arguments	HTTP	Cloud API Endpoint	Cookbook Sample
`get_runtime_data()`	—	GET	`/{dynamic_url}`	View Examples
`get_power_by_day()`	`dayTime`	GET	`/{dynamic_url}`	View Examples
`get_power_details()`	`type, timeperiod`	GET	`/{dynamic_url}`	View Examples

Python Method	Arguments	HTTP	Cloud API Endpoint	Cookbook Sample
`get_storm_list()`	`pageNum, pageSize`	GET	`/{dynamic_url}`	View Examples
`get_progressing_storm_list()`	—	GET	`/{dynamic_url}`	View Examples
`get_weather()`	—	GET	`/{dynamic_url}`	View Examples
`get_storm_settings()`	—	GET	`/{dynamic_url}`	View Examples
`set_storm_settings()`	`stormEn, setAdvanceBackupTime, advanceTime, stormNoticeEn`	POST	`/{dynamic_url}`	View Examples

Python Method	Arguments	HTTP	Cloud API Endpoint	Cookbook Sample
`get_gateway_tou_list()`	—	POST	`/{dynamic_url}`	View Examples
`get_charge_power_details()`	—	GET	`/{dynamic_url}`	View Examples
`save_tou_dispatch()`	`payload`	POST	`/{dynamic_url}`	View Examples
`get_tou_dispatch_detail()`	—	GET	`/{dynamic_url}`	View Examples
`get_utility_companies()`	`country_id, province_id, page_num, page_size, latitude, longitude`	POST	`/{dynamic_url}`	View Examples
`get_tariff_list()`	`company_id, page_num, page_size, latitude, longitude, search_key`	GET	`/{dynamic_url}`	View Examples
`get_tariff_detail()`	`tariff_id`	GET	`/{dynamic_url}`	View Examples
`get_tou_detail_by_id()`	`tou_id, from_type`	POST	`/{dynamic_url}`	View Examples
`get_custom_dispatch_list()`	`strategy_list`	POST	`/{dynamic_url}`	View Examples
`get_bonus_info()`	—	GET	`/{dynamic_url}`	View Examples
`get_vpp_tip()`	—	GET	`/{dynamic_url}`	View Examples
`get_recommend_dispatch_list()`	`strategy_list`	POST	`/{dynamic_url}`	View Examples
`calculate_expected_earnings()`	`template`	POST	`/{dynamic_url}`	View Examples
`apply_tariff_template()`	`template_id, name, work_mode, electricity_type, strategy_detail_custom`	POST	`/{dynamic_url}`	View Examples