GuidesAPI ReferenceOpenNode
Guides

Overview

This page will help you get started with OpenNode. You'll be up and running in a jiffy!

Overview

OpenNode offers a powerful REST API that supports bitcoin lightning network and standard on-chain operations with action events associated allowing you to receive and send microtransactions instantly.

Our API uses HTTP response codes and returns all error responses in JSON. To explore the API as much as possible, we offer a developer environment in addition to production. Any operations made in the development environment use the Bitcoin's testnet network as well as Lightning infrastructure connected to testnet full nodes.

Development and production environments require separate API Keys that can be generated in your personal dashboard settings.

We provide libraries for the following languages/frameworks: - PHP, NodeJS

There are other non-official libraries developed by the community that you might find useful.

Language/FrameworkOfficialLink
NodeJS✅GitHub
PHP✅GitHub
Java❌GitHub
Elixir❌GitHub
Haskell❌GitHub
Scala❌GitHub

This is currently a beta of our documentation. Let us know how we can improve our API documentation to provide the smoothest experience.

Steps to get started

  1. Read the documentation
    We recommend that you read the API documentation and familiarize yourself with functionalities. If you need help verifying if our solution matches your business needs, contact us at [email protected]
  2. Register an account on development environment and generate API Keys
    You can register a development environment account here. Generate your API credentials on your dashboard (please refer to the table below if you need assistance).
InvoicesRead-onlyWithdrawals
Create charge & fetch charge info✅✅✅
Fetch charge info & withdrawal info❌✅✅
Initiate withdrawal❌❌✅
  1. Technical assistance

Sometimes, things do not run as we expect. If you need technical assistance please contact us at [email protected] and we will dedicate an engineer to assist you free of charge.

  1. Testing is done 🎉 Register your production account

You are now ready to launch your application. Create an account on the production environment and generate new API credentials. Update your application API endpoint to https://api.opennode.com .

  1. You are ready to go ⚡️

You are now ready to receive & send Bitcoin. Let us know what you built and we will do our part in spreading the word.

Updated over 1 year ago