Get started with Igloohome Locks

Learn how to connect and control your Igloohome locks with the Seam API.


Seam provides a universal API to connect and control many brands of locks, including Igloohome. This guide provides a rapid introduction to connecting and controlling your Igloohome locks using the Seam API. To learn more about other device brands supported by the Seam API, such as Yale, Schlage, and August, head over to our integration page.

1 — Install Seam SDK

Seam provides client libraries for many languages, such as JavaScript, Python, Ruby, PHP, and others, as well as a Postman collection and OpenAPI spec.

npm i seam

Once installed, sign-up for Seam to get your API key, and export it as an environment variable:

$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw

This guide uses a Sandbox Workspace. Only virtual devices can be connected. If you need to connect a real Igloohome device, use a non-sandbox workspace and API key.

To control your Igloohome locks via the Seam API, you must first authorize your Seam workspace against your Igloohome account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your Igloohome devices.

Request a Connect Webview

from seamapi import Seam

seam = Seam()

webview = seam.connect_webviews.create(accepted_providers=["igloohome"])

assert webview.login_successful is False

# Send the webview URL to your user

Authorize Your Workspace

Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Igloohome sandbox test accounts credentials below:

  • email:

  • password: 1234

Confirm the Connect Webview was successful by querying its status:

updated_webview = seam.connect_webviews.get(webview.connect_webview_id)

assert updated_webview.login_successful # true

3 — Retrieve Igloohome Devices

After an Igloohome account is linked with Seam, you can retrieve devices for this Igloohome account. The Seam API exposes most of the device's properties such as battery level.

all_locks = seam.locks.list()

some_lock = all_locks[0]

assert["online"] is True
assert["battery_level"] is True

# Device(device_id='60d0f1b6-26ae-4366-8d1b-d20ad0d6a62e', device_type='igloohome_lock', location=None, properties={'locked': False, 'online': True, 'manufacturer': 'igloohome', 'battery_level': 0.86, 'igloohome_metadata': {'device_id': '545636388', 'device_name': 'Office Lock'}, 'max_active_codes_supported': 100, 'supported_code_lengths': [6], 'name': 'Office Lock'}, capabilities_supported=['access_code', 'lock'], errors=[])

4 — Locking & Unlocking a Door

Next, you can perform the basic action of locking and unlocking a door.

Unlock a door


Request Body




# lock the door
updated_lock = seam.locks.get(some_lock.device_id)
assert["locked"] is True

# Now unlock the door
updated_lock = seam.locks.get(some_lock.device_id)
assert["locked"] is False

5 — Setting Access Code on Igloohome Lock

Most Igloohome locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Igloohome lock.

The Seam API makes it easy to program both ongoing codes and timebound codes on an Igloohome lock. You can find out more about Igloohome lock access code in our core concept section on access codes.

Igloohome pins have to be 4-6 digits long, and for time bound access codes, start date can't be on the past.

# create an ongoing code
  name="Personal Access Code")

# create a timebound code
  name="My Temp Access Code",

# you can use a device or a device_id as the "device" parameter

Next Steps

Now that you've completed this guide, you can try to connect a real Igloohome device. To do so, make sure to switch to a non-sandbox workspace and API key as real devices cannot be connected to sandbox workspaces.

In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources:

If you have any questions or want to report an issue, email us at

Last updated


Š Seam Labs, Inc. All rights reserved.