# bitcore-node

> A blockchain indexing node with extended capabilities using bitcore

Latest version **10.10.15** (published 2025-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install bitcore-node
pnpm add bitcore-node
yarn add bitcore-node
bun add bitcore-node
```

Provides the command `bitcore-node`.

## Health

**Score 25/100 (F)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; stale.

## Facts

| | |
|---|---|
| Version | 10.10.15 |
| Published | 2025-09-03 |
| First published | 2015-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18.0.0 |
| Dependencies | 23 |
| Unpacked size | 8.6 MB |
| Known vulnerabilities | 0 (+10 in 4 direct dependencies) |
| Install scripts | no |
| Author | Justin Langston |
| Maintainers | gasteve, nitsujlangston, unusualbob |
| Keywords | bitcore-node, typescript, bitcoin, bitcoin-cash, ethereum, node |

## Links

- npm: https://www.npmjs.com/package/bitcore-node
- npm.io page: https://npm.io/package/bitcore-node

## Dependencies (23)

- [cors](https://npm.io/package/cors.md) 2.8.4
- [web3](https://npm.io/package/web3.md) 1.7.0
- [xrpl](https://npm.io/package/xrpl.md) 2.6.0
- [lodash](https://npm.io/package/lodash.md) 4.17.11
- [express](https://npm.io/package/express.md) 4.19.2
- [mongodb](https://npm.io/package/mongodb.md) 3.6.12
- [request](https://npm.io/package/request.md) 2.88.0
- [winston](https://npm.io/package/winston.md) 3.2.0
- [secp256k1](https://npm.io/package/secp256k1.md) 4.0.3
- [socket.io](https://npm.io/package/socket.io.md) 4.8.1
- [crypto-rpc](https://npm.io/package/crypto-rpc.md) git+https://github.com/bitpay/crypto-rpc.git#370b201c98f4616b378290dc30486df5c1c769e0
- [abi-decoder](https://npm.io/package/abi-decoder.md) 2.4.0
- [bitcore-lib](https://npm.io/package/bitcore-lib.md) ^10.10.7
- [bitcore-p2p](https://npm.io/package/bitcore-p2p.md) ^10.10.7
- [bitcore-client](https://npm.io/package/bitcore-client.md) ^10.10.15
- [bitcore-lib-ltc](https://npm.io/package/bitcore-lib-ltc.md) ^10.10.5
- [bitcore-lib-cash](https://npm.io/package/bitcore-lib-cash.md) ^10.10.5
- [bitcore-lib-doge](https://npm.io/package/bitcore-lib-doge.md) ^10.10.5
- [bitcore-p2p-cash](https://npm.io/package/bitcore-p2p-cash.md) ^10.10.7
- [bitcore-p2p-doge](https://npm.io/package/bitcore-p2p-doge.md) ^10.10.5
- [crypto-wallet-core](https://npm.io/package/crypto-wallet-core.md) ^10.10.15
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.13
- [bitcore-wallet-client](https://npm.io/package/bitcore-wallet-client.md) ^10.10.15

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 10.10.15 (latest) — 2025-09-03
- 11.5.2 (beta) — 2026-02-05
- 11.5.1 — 2026-01-28
- 11.5.0 — 2026-01-23
- 11.4.7 — 2026-01-06
- 11.4.6 — 2025-12-09
- 11.4.5 — 2025-12-04
- 11.4.4 — 2025-12-02
- 11.4.3 — 2025-11-25
- 11.4.2 — 2025-11-20
- 11.4.1 — 2025-11-18
- 11.4.0 — 2025-10-30
- 11.3.7 — 2025-10-23
- 11.3.6 — 2025-10-10
- 11.3.5 — 2025-10-06
- … 182 more at https://npm.io/package/bitcore-node/versions

## README

# Bitcore Node

**A standardized API to interact with multiple blockchain networks**

Currently supporting:
**[Bitcoin](https://bitcoin.org/), [Bitcoin Cash](https://bitcoincash.org/), [Litecoin](https://litecoin.com/), [Dogecoin](https://dogecoin.com/), [Ripple](https://ripple.com/), [Ethereum](https://ethereum.org/) and [Polygon](https://polygon.technology/)**


## Getting Started

### Requirements

- Trusted P2P Client with an open RPC endpoint
- MongoDB Server >= v3.4
- make g++ gcc 

### Checkout the repo


```sh
git clone git@github.com:bitpay/bitcore.git
git checkout master
npm install
```

## Setup Guide

### 1. Setup Bitcore config

The definition for all the chain configuration can be found in `src/types/Config.ts`

<details>
<summary>Example bitcore.config.json</summary>
<br>

```json
{
  "bitcoreNode": {
    "chains": {
      "BTC": {
        "mainnet": {
          "chainSource": "p2p",
          "trustedPeers": [
            {
              "host": "127.0.0.1",
              "port": 20008
            }
          ],
          "rpc": {
            "host": "127.0.0.1",
            "port": 20009,
            "username": "username",
            "password": "password"
          }
        },
        "regtest": {
          "chainSource": "p2p",
          "trustedPeers": [
            {
              "host": "127.0.0.1",
              "port": 20020
            }
          ],
          "rpc": {
            "host": "127.0.0.1",
            "port": 20021,
            "username": "username",
            "password": "password"
          }
        }
      },
      "BCH": {
        "mainnet": {
          "parentChain": "BTC",
          "forkHeight": 478558,
          "trustedPeers": [
            {
              "host": "127.0.0.1",
              "port": 30008
            }
          ],
          "rpc": {
            "host": "127.0.0.1",
            "port": 30009,
            "username": "username",
            "password": "password"
          }
        },
        "regtest": {
          "chainSource": "p2p",
          "trustedPeers": [
            {
              "host": "127.0.0.1",
              "port": 30020
            }
          ],
          "rpc": {
            "host": "127.0.0.1",
            "port": 30021,
            "username": "username",
            "password": "password"
          }
        }
      }
    }
  }
}
```

</details>

### 2. Setup Your Blockchain Nodes

<details>
<summary>Example Bitcoin Mainnet Config</summary>

```sh
whitelist=127.0.0.1
txindex=0
listen=1
server=1
irc=1
upnp=1

# Make sure port & rpcport matches the
# bitcore.config.json ports for BTC mainnet

# if using Bitcoin Core v0.17+ prefix
# [main]

port=20008
rpcport=20009
rpcallowip=127.0.0.1

rpcuser=username
rpcpassword=password
```

</details>

### 3. Run Your Blockchain Nodes

<details>
<summary>Example Starting a Bitcoin Node</summary>

```sh
# Path to your bitcoin application and path to the config above
/Applications/Bitcoin-Qt.app/Contents/MacOS/Bitcoin-Qt -datadir=/Users/username/blockchains/bitcoin-core/networks/mainnet/
```

</details>

### 4. Start Bitcore

```sh
npm run node
```

Bitcore will begin using your blockchain nodes to synchronize its own database so that you can use standardized queries to get data from each of your supported blockchains.

## API Documentation

- [REST API parameters and example responses](./docs/api-documentation.md)

- [Websockets API namespaces, event names and parameters](./docs/sockets-api.md)

- [Testing Bitcore-node in RegTest](./docs/wallet-guide.md)

## Contributing

See [CONTRIBUTING.md](../../Contributing.md) on the main bitcore repo for information about how to contribute.

## License

Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).

Copyright 2013-2023 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.

---
_Source: https://npm.io/package/bitcore-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
