Configuration

Choosing an endpoint and transport

The default endpoint is https://api.steemit.com over HTTP (JSON-RPC). Change it with setOptions:

// HTTP / JSON-RPC (recommended)
steem.api.setOptions({ url: 'https://api.steemit.com' });

// WebSocket
steem.api.setOptions({ url: 'wss://some.node:port' });

The transport is chosen from the URL scheme:

URL scheme	Transport
http:// or https://	HTTP JSON-RPC
ws:// or wss://	WebSocket

A few capabilities are HTTP-only — notably the raw call / signedCall methods, which throw if you are connected over WebSocket.

config.get / config.set

steem.config holds the chain parameters. The defaults target Steem mainnet:

steem.config.get('address_prefix'); // 'STM'
steem.config.get('chain_id');       // mainnet chain id
steem.config.set('address_prefix', 'STM');

To target a different chain (for example, an alternative network), set its prefix and chain id explicitly:

steem.api.setOptions({ url: 'wss://ws.example.io' });
steem.config.set('address_prefix', 'XYZ');
steem.config.set('chain_id', '<chain id hex>');

Testnet

steem.api.setOptions({
  address_prefix: 'TST',
  chain_id: '46d82ab7d8db682eb1959aed0ada039a6d49afa1602491f93dde9cac3e8e6c32',
  useTestNet: true,
});

Passing useTestNet: true to setOptions also flips address_prefix to TST. The chain id can change between testnet launches; check the relevant announcement if signing fails.

Other setOptions keys

Option	Purpose
url	Endpoint; also selects the transport
useTestNet	Convenience flag; sets the TST address prefix
logger	A function (…args) or an object with a .log method, used to trace requests/responses
transport	Force a transport: 'http', 'ws', or a custom transport class

steem.api.setWebSocket(url) and steem.api.setUri(url) are thin shortcuts over setOptions.

Raw RPC calls

Over HTTP you can issue arbitrary JSON-RPC calls without a generated wrapper:

steem.api.call('condenser_api.get_accounts', [['ned']], (err, res) => {});

// Signed (authenticated) RPC call:
steem.api.signedCall(method, params, account, wif, (err, res) => {});

Both have …Async promise variants (callAsync, signedCallAsync).

Multiple instances

The default export is a ready-to-use singleton. To run more than one connection, construct your own:

const { Steem } = require('@steemit/steem-js');
const node = new Steem({ url: 'https://api.steemit.com' });