This guide helps users understand how to use the OneKey provider API to easily build network applications using the Nostr protocol.

OneKey provider API is specified by NIP-07.


1. Download OneKey Wallet

Download the OneKey Wallet. Install the OneKey browser extension.

2. API Injection Explanation

  • The OneKey browser extension injects Provider API into visited websites.

  • Two types of APIs are provided: window.nostr and window.$onekey.nostr.

  • It is recommended to use window.$onekey.nostr.

Both APIs have the same functionality, just different names.

Detecting Provider API support

Before you start using Nostr protocol you need to check for browser support by checking if the variable window.nostr is defined:

const provider = (window.$onekey && window.$onekey.nostr) || window.nostr;

if (!provider) {
  alert("No Provider available.");


Identify required functionalities, call relevant interfaces

More Interfaces: View Details


  • Key Operations: Such as account switching

  • More Information: View More

Last updated