Practical overview
When it fits
Use it when a JavaScript application needs to communicate with a separately configured Bitcoin Core instance through REST or RPC, rather than when you need the node itself or a standalone wallet.
Who it is for
- JavaScript developers integrating applications with Bitcoin Core.
- Teams building administrative tools or interfaces for managing multiple Bitcoin Core wallets.
- Developers whose applications need Bitcoin Core network or blockchain query results.
Documented uses
- Send administrative commands to a Bitcoin Core instance through REST or RPC.
- Direct operations to a selected wallet, including in a multiwallet setup.
- Query Bitcoin network and blockchain information through Bitcoin Core.
Requirements & limits
The repository is public and documents installation with npm or Yarn. The library requires a Bitcoin Core instance for its requests; the README gives `http://localhost:8332` as the default host.
- The library is a client layer; Bitcoin Core must be running separately with its RPC server enabled.
- The client can be configured with host, credentials, timeout, custom headers, version and wallet.
- Named JSON-RPC parameters are enabled by providing a version in the client configuration.
- Large numeric results with more than 15 significant digits are returned as strings to avoid JavaScript precision loss.
- RPC listens on localhost by default according to the README; changing binding or permitted source IPs requires Bitcoin Core configuration.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Configure a client for a Bitcoin Core instance
Set up a client with the connection details needed to send requests to Bitcoin Core.
Before you start
- A Bitcoin Core instance with its RPC server enabled.
- The instance host address and, when configured, RPC username and password.
Steps
Create a client using the library.
Set the host if the instance is not at the documented default
http://localhost:8332.Provide RPC username and password when the server requires them; set a wallet name to target a particular wallet.
Call a client method and handle its returned Promise.
Expected outcome
A configured client can send REST or RPC requests to the Bitcoin Core instance, with method results handled asynchronously.
Guide limitations
- The README's default host is localhost; remote access requires Bitcoin Core RPC binding and source-IP access configuration.
- Named JSON-RPC parameters require specifying a Bitcoin Core version in the client configuration.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 17 October 2026
- Original website title
- ruimarinho/bitcoin-core · Official homepage title · retained in its source language

