@stacks/blockchain-api-client NPM | npm.io

7.10.0 • Published 23 hours ago

Install

Weekly downloads

669

License

GPL-3.0

Repository

Last release

23 hours ago

@stacks/blockchain-api-client

A JS Client for the Stacks Blockchain API

Features

This package provides the ability to:

Execute REST API requests against the Stacks Blockchain API
Subscribe to WebSockets for real-time Stacks updates (for addresses or transactions)
Full type safety for WebSocket and API requests and responses

Installation

You can install this package using NPM:

npm install --save-dev @stacks/blockchain-api-client

Usage

Here is an example code that connects with the WebSocket server and subscribes to updates for a specific Stacks address:

import { connectWebSocketClient } from '@stacks/blockchain-api-client';

// for mainnet, replace with ws://stacks-node-api.testnet.stacks.co/
const client = await connectWebSocketClient('wss://stacks-node-api.mainnet.stacks.co/');

const sub = await client.subscribeAddressTransactions('ST3GQB6WGCWKDNFNPSQRV8DY93JN06XPZ2ZE9EVMA', event =>
  console.log(event);
  /*
    {
      address: 'ST3GQB6WGCWKDNFNPSQRV8DY93JN06XPZ2ZE9EVMA',
      tx_id: '0x8912000000000000000000000000000000000000000000000000000000000000',
      tx_status: 'success',
      tx_type: 'token_transfer',
    }
  */
);

await sub.unsubscribe();

Documentation

You can find full references here.

Known Issues

The TypeScript definitions for several objects involving type unions, including transactions, are incorrectly specified as only object.

@stacks/stacks-blockchain-api-types @types/ws cross-fetch eventemitter3 jsonrpc-lite socket.io-client ws

@stacks/cli @infinitebrahmanuniverse/nolb-_stac @everything-registry/sub-chunk-863 risidio-pay stxmap-address-rank-cli @fungible-systems/sip-12 sip-12 @stacks/rx @clarigen/core

23 hours ago

9 days ago

13 days ago

16 days ago

17 days ago

17 days ago

23 days ago

27 days ago

7.10.0-nakamoto.7

28 days ago

7.10.0-nakamoto.6

30 days ago

7.10.0-nakamoto.5

1 month ago

7.10.0-nakamoto.4

1 month ago

7.10.0-nakamoto.3

1 month ago

7.10.0-nakamoto.2

1 month ago

7.10.0-nakamoto.1

1 month ago

7.9.0-nakamoto.9

1 month ago

1 month ago

7.9.0-nakamoto.8

1 month ago

7.9.0-nakamoto.6

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

7.9.0-nakamoto.5

2 months ago

7.9.0-nakamoto.4

3 months ago

3 months ago

7.9.0-nakamoto.2

3 months ago

7.9.0-nakamoto.1

3 months ago

7.9.0-nakamoto.3

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

7.6.0-nakamoto.1

4 months ago

7.6.0-nakamoto.2

4 months ago

7.6.0-nakamoto.3

4 months ago

4 months ago

7.4.0-nakamoto.12

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

7.4.0-nakamoto.11

4 months ago

7.4.0-nakamoto.10

4 months ago

4 months ago

7.4.0-nakamoto.9

4 months ago

7.4.0-nakamoto.8

4 months ago

7.4.0-nakamoto.7

4 months ago

7.4.0-nakamoto.5

5 months ago

7.4.0-nakamoto.6

5 months ago

7.4.0-nakamoto.4

5 months ago

7.4.0-nakamoto.3

5 months ago

5 months ago

5 months ago

8 months ago

10 months ago

7.4.0-nakamoto.2

6 months ago

7.4.0-nakamoto.1

6 months ago

6 months ago

6 months ago

8 months ago

12 months ago

12 months ago

11 months ago

1 year ago

7.1.11-stacks-2.4.1

12 months ago

12 months ago

11 months ago

11 months ago

11 months ago

1 year ago

7.1.0-subnets.1

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

7.0.0-stacks-2.1.2

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

4.2.0-stacks-2.1.1

1 year ago

7.0.0-stacks-2.1.1

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

2 years ago

1 year ago

1 year ago

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago