Skip to main content
Skip table of contents

getsystems

https://myhs.homeseer.com/getsystems?user=USER&pass=PASSWORD

Returns JSON that describes all the systems that the user has access to. Only the systems that are online are returned. If the user has a premium subscription then multiple systems could be returned, otherwise only a single system is returned.

The "hslocalip" is the IP address of the system HS is running on. The "hswanip" is the WAN IP that HS detects and the "detected_wan_ip" is the WAN ip that the MyHS service detects. If these match, this means the user is on the same network as the HS system and your app can connect using the "hslocalip" rather than use the MyHS service. The "HasSubscription" property reports if the user has a MyHS subscription. The "tunnelip" parameter is the MyHS server that the HS system is connected to. In order to get access to the system described you MUST use the correct tunnel address. HomeSeer will be implementing redundant MyHS servers so it is critical that the correct server is used when issuing MyHS commands. An alternative to using GetSystems is to use the URL:

https://myhs.homeseer.com/json?request=###&user=USER&pass=PASS

This request will automatically direct the request to the correct server.

Example return:

JSON
{
	"response": "ok",
	"responsecode": 200,
	"systems": [
		{
			"license": "12345",
			"friendly_name": "Office",
			"hslocalip": "192.168.2.100:80",
			"hswanip": "some_ip",
			"detected_wan_ip": "some_ip",
			"tunnelip": "connected22.homeseer.com",
			"online": true
		}
	],
	"HasSubscription": true
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.