description
Seam makes it easy to integrate IoT devices with your applications!

🎉 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. →		seam-api-key.png	https://console.seam.co/
Quick Start (5 mins)	Learn how to connect a device and issue your first API call. →		seam-quick-start-light.png	quickstart.md

{% embed url="https://youtu.be/XzzJ7gMPOGE" %}

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)

{% tabs %} {% tab title="JavaScript" %}

npm i seam

{% endtab %}

{% tab title="Python" %}

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

{% endtab %}

{% tab title="Ruby" %}

bundle add seamapi

{% endtab %}

{% tab title="PHP" %}

composer require seamapi/seam

{% endtab %}

{% tab title="Java" %} Gradle:

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

Maven:

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

{% endtab %}

{% tab title="C#" %} Install using nuget. {% endtab %}

{% tab title="Go" %}

go get github.com/seamapi/go

{% endtab %} {% endtabs %}

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 →	smart-locks-16-9.png		smart-locks
Thermostats API	Get started →	thermostats-16-9.png		thermostats
Noise Sensors API	Get started →	sensors-16-9.png		noise-sensors

Brand Guides

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

August Locks	Connect and control August locks. →	august-getting-started-guide-cover.jpg	get-started-with-august-locks.md	get-started-with-august-locks.md
Yale Locks	Connect and control Yale locks. →	yale-getting-started-guide-cover.jpg	get-started-with-yale-locks.md	get-started-with-yale-locks.md
Schlage Locks	Connect and control Schlage locks. →	schlage-getting-started-guide-cover.jpg	get-started-with-schlage-locks.md	get-started-with-schlage-locks.md
Kwikset Locks	Connect and control Kwikset locks. →	kwikset-getting-started-guide-cover.jpg	get-started-with-kwikset-wifi-locks.md	get-started-with-kwikset-wifi-locks.md
Salto Locks	Connect and control Salto locks and devices. →	salto-getting-started-guide-cover.jpg	get-started-with-salto-locks.md	get-started-with-salto-locks.md
TTLock	Connect and control TTLock devices. →	ttlock-getting-started-seo-cover.png	get-started-with-ttlock-devices.md	get-started-with-ttlock-devices.md
Nuki Locks	Connect and control Nuki devices. →	nuki-getting-seo-cover.jpg	get-started-with-nuki-locks.md	get-started-with-nuki-locks.md
Minut Sensors	Connect and control Minut sensors. →	minut-getting-seo-cover.jpg	get-started-with-minut-sensors.md	get-started-with-minut-sensors.md
NoiseAware Sensors	Connect and control NoiseAware sensors. →	noiseaware-getting-seo-cover.jpg	get-started-with-noiseaware-sensors.md	get-started-with-noiseaware-sensors.md
2N Intercom	Connect and control 2N devices. →	2n-getting-started-seo-cover.png	get-started-with-2n-intercoms.md	get-started-with-2n-intercoms.md
ecobee Thermostats	Connect and control ecobee thermostats. →	ecobee-getting-seo-cover (1).png
igloohome Locks	Connect and control igloohome locks. →	igloo-getting-seo-cover.png		get-started-with-igloo-locks.md