🎉Seam Documentation

We have integrated many door locks, thermostats, and other device brands, and we have created simple application programming interfaces (APIs) for interacting with these devices.

To get started quickly with Seam, follow the Quick Start to create an API key and then connect and control your first device.

Getting Started

Get API Key (free)

Sign up for the Seam Console and get your API keys. →

Quick Start (5 mins)

Learn how to connect a device and issue your first API call. →

Install an SDK

Use one of the following methods to install the Seam software development kit (SDK) in the programming language of your choice:

• JavaScript / TypeScript (npm, GitHub)

• Python (pip, GitHub)

• Ruby Gem (rubygem, GitHub)

• PHP (packagist, GitHub)

• Java (GitHub)

• C# (nuget, GitHub)

• Go (GitHub)

npm i seam

pip install seamapi
# For some development environments, use pip3 in this command instead of pip.

bundle add seamapi

composer require seamapi/seam

// build.gradle
dependencies {
    implementation 'io.github.seamapi:java:0.x.x'
}

<!-- pom.xml -->
<dependency>
    <groupId>io.github.seamapi</groupId>
    <artifactId>java</artifactId>
    <version>0.x.x</version>
</dependency>

go get github.com/seamapi/go

Create and Export Your Seam API Key

Create your Seam API key using the Seam Console. Then, make sure to export this key so that the installed SDK can use it.

$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw

Device APIs

Explore our device API guides to start connecting and controlling specific device categories.

Door Locks API

Get started →

Thermostats API

Get started →

Noise Sensors API

Get started →

Brand Guides

Explore our in-depth guides to get started with specific devices or brands.

August Locks

Connect and control August locks. →

Yale Locks

Connect and control Yale locks. →

Schlage Locks

Connect and control Schlage locks. →

Kwikset Locks

Connect and control Kwikset locks. →

Salto Locks

Connect and control Salto locks and devices. →

TTLock

Connect and control TTLock devices. →

Nuki Locks

Connect and control Nuki devices. →

Minut Sensors

Connect and control Minut sensors. →

NoiseAware Sensors

Connect and control NoiseAware sensors. →

2N Intercom

Connect and control 2N devices. →

ecobee Thermostats

Connect and control ecobee thermostats. →

igloohome Locks

Connect and control igloohome locks. →