Quickstart

Install the SDK, pair with the device, make your first call. Expect this to take about 5 minutes.

1. Install the desktop application

The SDK talks to a local REST API served by the KeepKey desktop application on http://localhost:1646. Install and launch it first.

Download the latest release → 

Connect your KeepKey hardware device via USB and unlock it.

2. Install the SDK

npm install keepkey-vault-sdk
# or
pnpm add keepkey-vault-sdk
# or
bun add keepkey-vault-sdk

Zero dependencies. Native fetch. Works in browser, Node, Bun, and edge runtimes.

3. Pair your app

Pairing is one button press. Click below — the desktop application will show an approval dialog, you approve, and the API key comes back.

In code, the same flow looks like this:

import { KeepKeySdk } from 'keepkey-vault-sdk'
 
const sdk = await KeepKeySdk.create({
  serviceName: 'My App',
  serviceImageUrl: 'https://example.com/icon.png',
})
 
// Save the key so the next run skips the approval prompt
localStorage.setItem('keepkey-api-key', sdk.apiKey!)

On subsequent runs, pass the saved key back in to skip the approval dialog:

const sdk = await KeepKeySdk.create({
  apiKey: localStorage.getItem('keepkey-api-key') ?? undefined,
  serviceName: 'My App',
})

4. Make your first call

Derive an Ethereum receive address and show it on the device for visual verification:

const { address } = await sdk.address.ethGetAddress({
  address_n: [0x8000002C, 0x8000003C, 0x80000000, 0, 0],
  show_display: true,
})
console.log(address)

Click Run above. The docs will pair with your local desktop application (approve the prompt if it appears), then call the real API. The result comes back below.

Next steps

• Authentication — how pairing, API keys, and device approval work
• SDK — canonical usage patterns for every chain
• SDK Reference — full typed API reference
• REST Reference — interactive OpenAPI explorer