Welcome to the Nimiq Developer Center!

Dive into the Nimiq Ecosystem documentation with links to resources, tutorials, and assets.

Nimiq: the Blockchain for JS Devs!

Nimiq is the first browser blockchain. That means apps based on Nimiq can run directly in the browser of the user, locally, installation-free, without the need of a server-side application. And if you have a server-side application, you can use the Nimiq Node.js client. This way, it can be easily integrated into any existing app. Syncing with Nimiq requires seconds, not hours and it works on low-bandwidth. Ideal for mobile and progressive web-apps.

Start building blockchain-enabled apps with your JS skills using the resources of Nimiq:

This is a living document and will be updated as the Nimiq Ecosystem evolves. Make sure to to check back regularly and join the developer community to get the latest updates.

Get Started

Build your own Nimiq-enabled app. Step by step with code snippets and a full running example at the end of each tutorial.


You can set up a Nimiq node within your browser that will connect to the Nimiq network and reach consensus in basically three lines of JavaScript code:

<script type="text/javascript" src="https://cdn.nimiq.com/nimiq.js"></script>
    Nimiq.init(async function() {

        // Configure for testing / otherwise main()

        // Getting a Nimiq Nano Client instance
        const consensus = await Nimiq.Consensus.nano();

        // Connecting to the network

But there is more! Learn in the tutorials below how to build a small webapp with JavaScript, HTML, and CSS that manages a wallet, send and receive transactions, and looks neat using Nimiq's look & feel.

Nimiq Basics: Nano Client, Nimiq Style, and Iqons

Nimiq Nano Client: Learn how to build a small app that can manage a wallet, send and receive transactions, and looks neat using Nimiq’s look & feel and Iqons in five short tutorials.

Nimiq Payment Plugin

More to come. Want to contribute? Please get in touch.

Run a node

The minimum example: On Linux and Mac, all you need is an IP and an open or forwarded port to run a full node.

git clone https://github.com/nimiq/core-js.git nimiq && cd nimiq
yarn && yarn build
clients/nodejs/nimiq --host=IP --port=PORT --protocol=ws

Note: For further details and instructions for Windows users, refer to the Nimiq Core Documentation.

Run a miner: just add configuration for threads and address

--miner=auto --wallet-address=ADDRESS

For more details, see:

Integrate checkout

Coming soon. Team Nimiq is preparing to release a plugin to integrate Nimiq with WooCommerce in Q1 2019. Together with this we plan to publish detailed instructions on how to use it here.

API Documentation

Nuts and bolts of Nimiq. Detailed documentation of front-end, core and community-provided APIs and frameworks.


Bits and bytes. Browse through Nimiq's source code. New to Nimiq's look & feel? Checkout Nimiq's Style Guide and download brand assets such as logos and signets.

Nimiq Style

The Nimiq CSS framework to give your webapp or website the Nimiq look & feel.

Source Code

The Nimiq Source Code (Blockchain, node, core library, Nimiq apps, CSS, Vue.js components…) is hosted on GitHub.