---
title: "Nimiq Hub"
description: "The secure wallet integration API that lets your users sign transactions, manage accounts, and interact with the blockchain — without you ever touching their private keys."
canonical_url: "https://nimiq.dev/hub"
---
# Nimiq Hub

> The secure wallet integration API that lets your users sign transactions, manage accounts, and interact with the blockchain — without you ever touching their private keys.

## Get started now

Request a payment and get the signed transaction.

<code-group>

```bash [pnpm]
pnpm add @nimiq/hub-api
```

```bash [npm]
npm install @nimiq/hub-api
```

```bash [yarn]
yarn add @nimiq/hub-api
```

```bash [CDN]
<script src="https://cdn.jsdelivr.net/npm/@nimiq/hub-api@latest/dist/standalone/HubApi.standalone.umd.js"></script>
```

</code-group>

<code-group>

```js [Payment Example]
import HubApi from '@nimiq/hub-api'

const hubApi = new HubApi('https://hub.nimiq.com')

const result = await hubApi.checkout({
  appName: 'My Shop',
  recipient: 'NQ07 0000 0000 0000 0000 0000 0000 0000 0000',
  value: 1_000, // 0.01 NIM in Luna
})

console.log('Payment complete:', result.hash)
```

```js [Authentication]
import HubApi from '@nimiq/hub-api'

const hubApi = new HubApi('https://hub.nimiq.com')

const result = await hubApi.signMessage({
  appName: 'My App',
  message: 'Sign in to My App',
})

console.log('Signed by:', result.signer)
// Verify signature on your server
```

```js [Address Selection]
import HubApi from '@nimiq/hub-api'

const hubApi = new HubApi('https://hub.nimiq.com')

const result = await hubApi.chooseAddress({
  appName: 'My App',
})

console.log('Address:', result.address)
console.log('Label:', result.label)
```

</code-group>

<u-page-section description="The Hub provides a unified interface for all Nimiq wallet operations. Your users maintain full control of their keys while you get a simple, powerful API." headline="Why Use Hub API" title="Secure Wallet Integration Made Simple">
<u-page-grid>
<u-page-card description="Private keys never leave the secure Keyguard environment" icon="i-tabler:key-off" title="Zero Key Management" variant="outline">



</u-page-card>

<u-page-card description="Same interface across all Nimiq apps" icon="i-tabler:users" title="Trusted by Users" variant="outline">



</u-page-card>

<u-page-card description="Support for Nimiq today; Bitcoin and Polygon flows require a privileged Hub origin" icon="i-tabler:timeline" title="Multi-Chain Ready" variant="outline">



</u-page-card>

<u-page-card description="CDN or NPM — start in minutes" icon="i-tabler:puzzle" title="Simple Integration" variant="outline">



</u-page-card>

<u-page-card description="Full TypeScript definitions included" icon="i-tabler:code" title="Type-Safe API" variant="outline">



</u-page-card>

<u-page-card description="Popup or redirect flows for all devices" icon="i-tabler:device-mobile" title="Mobile Friendly" variant="outline">



</u-page-card>
</u-page-grid>
</u-page-section>

<callout icon="i-tabler:bulb" to="https://nimiq.dev/hub/guide/concepts">

**How the Hub Architecture Works** — Learn about the Hub-Keyguard relationship, request behaviors, and security model.

</callout>

<u-page-section description="Choose your integration path and start building." headline="Quick Start" title="Jump right in">
<u-page-grid>
<u-page-card description="Install the Hub API and make your first request in 5 minutes" icon="i-tabler:rocket" title="Getting Started Guide" variant="outline" to="https://nimiq.dev/hub/getting-started">



</u-page-card>

<u-page-card description="Complete documentation for all Hub methods and types" icon="i-tabler:book-2" title="API Reference" variant="outline" to="https://nimiq.dev/hub/api-reference">



</u-page-card>

<u-page-card description="Ready-to-use integration boilerplate" icon="i-tabler:code-dots" title="Starter Template" variant="outline" to="https://github.com/onmax/nimiq-starter/tree/main/starters/hub-api-ts">



</u-page-card>
</u-page-grid>
</u-page-section>

<callout icon="i-tabler:arrows-exchange">

**Need Lower-Level Control?** — For advanced use cases requiring direct blockchain access, consider using the [Web Client](https://nimiq.dev/web-client) or [RPC API](https://nimiq.dev/rpc).

</callout>

## Hub Capabilities

Flexible integration options. Choose your integration style, access powerful methods, and support multiple chains.

<callout icon="i-tabler-bulb">

**Security First**

The Hub uses a separate secure origin (Keyguard) to store and manage private keys. Your application **never** has access to user keys — all signing happens in the isolated Keyguard environment.

</callout>

### Choose your integration style

Select how the Hub appears to your users.

### Request behaviour

<u-page-grid>
<u-page-card description="Opens in a centered popup window" icon="i-tabler:window" title="Popup (Default)" variant="outline">



</u-page-card>

<u-page-card description="Full-page redirect for mobile-friendly flows" icon="i-tabler:arrow-back-up" title="Redirect" variant="outline">



</u-page-card>

<u-page-card description="Seamless integration for privileged origins" icon="i-tabler:layout-grid" title="IFrame" variant="outline">



</u-page-card>
</u-page-grid>

### Core Methods

<u-page-grid>
<u-page-card description="Accept NIM with checkout() and signTransaction()" icon="i-tabler:coins" title="Payments" variant="outline">



</u-page-card>

<u-page-card description="Sign messages for secure user login with signMessage()" icon="i-tabler:signature" title="Authentication" variant="outline">



</u-page-card>

<u-page-card description="Create shareable payment links with createCashlink()" icon="i-nimiq:gift" title="Cashlinks" variant="outline">



</u-page-card>
</u-page-grid>

### Multi-Chain Support

<u-page-grid>
<u-page-card description="Sign Bitcoin transactions with signBtcTransaction()" icon="i-nimiq:logos-bitcoin-mono" title="Bitcoin" variant="outline">



</u-page-card>

<u-page-card description="Sign EVM transactions with signPolygonTransaction()" icon="i-tabler:hexagon-letter-p" title="Polygon" variant="outline">



</u-page-card>

<u-page-card description="Trustless cross-chain trading with setupSwap()" icon="i-nimiq:btc-nim-swap" title="Atomic Swaps" variant="outline">



</u-page-card>
</u-page-grid>


## Sitemap

See the full [sitemap](https://nimiq.dev/sitemap.md) for all pages.
