#API Documentation

#ConnectionManager

#connect()

1public connect(host: string, name = "main")

Connect to the given connection.

#Parameters

#Return Value

Connection

#disconnect()

1public disconnect(name?: string)

Disconnect from the given connection.

#Parameters

#Return Value

void

#connection()

1public connection(name?: string)

Get a connection instance.

#Parameters

#Return Value

Connection

#getDefaultConnection()

1public getDefaultConnection()

Get the default connection name.

#Return Value

string

#setDefaultConnection()

1public setDefaultConnection(name: string)

Set the default connection name.

#Parameters

#Return Value

void

#getConnections()

1public getConnections()

Return all of the created connections.

#Return Value

Record<string, Connection>

#Connection

#constructor()

1public constructor(private readonly host: string)

Create a new Connection class instance.

#Parameters

#api()

1public api<T = any>(name: string)

Instantiate new Api.

#Parameters

#Return Value

T

#withOptions()

1public withOptions(opts: Record<string, any>)

Apply options to future connection requests.

#Parameters

#Return Value

this

#get()

1public async get<T = any>(url: string, opts?: Record<string, any>)

Send a GET request with query parameters.

#Parameters

#Return Value

Promise<IResponse<T>>

#post()

1public async post<T = any>(url: string, opts?: Record<string, any>): Promise<IResponse<T>>

Send a POST request with JSON-encoded parameters.

#Parameters

#Return Value

Promise<IResponse<T>>

#RequestError

#constructor()

1public constructor(error)

Create a new RequestError class instance.

#Parameters

#Resources\Blocks

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all blocks.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(id: string)

Get a block by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#transactions()

1public async transactions<T = any>(id: string, query?: Record<string, any>)

Get all transactions by the given block.

#Parameters

#Return Value

Promise<IResponse<T>>

#search()

1public async search<T = any>(payload?: Record<string, any>)

Filter all blocks by the given parameters.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Bridgechains

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all bridgechains.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(id: string)

Get a bridgechain by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#search()

1public async search<T = any>(payload?: Record<string, any>)

Search for a bridgechain with the given payload.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Businesses

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all businesses.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(id: string)

Get a business by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#bridgechains()

1public async bridgechains<T = any>(id: string, query?: Record<string, any>)

Get all bridgechains for a business.

#Parameters

#Return Value

Promise<IResponse<T>>

#search()

1public async search<T = any>(payload?: Record<string, any>)

Search for a business with the given payload.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Locks

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all locks.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(id: string)

Get a lock by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#search()

1public async search<T = any>(payload?: Record<string, any>)

Search for locks with given payload.

#Parameters

#Return Value

Promise<IResponse<T>>

#unlocked()

1public async unlocked<T = any>(payload?: Record<string, any>)

Search for unlocked locks.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Delegates

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all accounts.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(id: string)

Get a delegate by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#blocks()

1public async blocks<T = any>(id: string, query?: Record<string, any>)

Get all blocks for the given delegate.

#Parameters

#Return Value

Promise<IResponse<T>>

#voters()

1public async voters<T = any>(id: string, query?: Record<string, any>)

Get all voters for the given delegate.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Node

#configuration()

1public async configuration<T = any>()

Get the node configuration.

#Return Value

Promise<IResponse<T>>

#status()

1public async status<T = any>()

Get the node status.

#Return Value

Promise<IResponse<T>>

#syncing()

1public async syncing<T = any>()

Get the node syncing status.

#Return Value

Promise<IResponse<T>>

#crypto()

1public async crypto<T = any>()

Get the node crypto configuration.

#Return Value

Promise<IResponse<T>>

#fees()

1public async fees<T = any>(days: number)

Get the node fee statistics.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Peers

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all peers.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(ip: string)

Get a peer by the given IP address.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Rounds

#delegates()

1public async delegates<T = any>(id: number)

Get delegates for a round.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Transactions

#create()

1public async create<T = any>(payload: object[])

Create a new transaction.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(id: string)

Get a transaction by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all transactions.

#Parameters

#Return Value

Promise<IResponse<T>>

#allUnconfirmed()

1public async allUnconfirmed<T = any>(query?: Record<string, any>)

Get all unconfirmed transactions.

#Parameters

#Return Value

Promise<IResponse<T>>

#getUnconfirmed()

1public async getUnconfirmed<T = any>(id: string)

Get an unconfirmed transaction by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#search()

1public async search<T = any>(payload: Record<string, any>)

Filter all transactions by the given parameters.

#Parameters

#Return Value

Promise<IResponse<T>>

#types()

1public async types<T = any>()

Get a list of valid transaction types.

#Return Value

Promise<IResponse<T>>

#fees()

1public async fees<T = any>(): Promise<IResponse<T>>

Get the node fee statistics.

#Return Value

Promise<IResponse<T>>

#Resources\Votes

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all votes.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(id: string)

Get a vote by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#Resources\Wallets

#all()

1public async all<T = any>(query?: Record<string, any>)

Get all wallets.

#Parameters

#Return Value

Promise<IResponse<T>>

#get()

1public async get<T = any>(id: string)

Get a wallet by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#locks()

1public async locks<T = any>(id: string, query?: Record<string, any>)

Get a wallet by the given id.

#Parameters

#Return Value

Promise<IResponse<T>>

#transactions()

1public async transactions<T = any>(id: string, query?: Record<string, any>)

Get all transactions for the given wallet.

#Parameters

#Return Value

Promise<IResponse<T>>

#transactionsReceived()

1public async transactionsReceived<T = any>(id: string, query?: Record<string, any>)

Get all transactions received by the given wallet.

#Parameters

#Return Value

Promise<IResponse<T>>

#transactionsSent()

1public async transactionsSent<T = any>(id: string, query?: Record<string, any>)

Get all transactions sent by the given wallet.

#Parameters

#Return Value

Promise<IResponse<T>>

#votes()

1public async votes<T = any>(id: string)

Get all votes by the given wallet.

#Parameters

#Return Value

Promise<IResponse<T>>

#top()

1public async top<T = any>(query?: Record<string, any>)

Get all wallets sorted by balance in descending order.

#Parameters

#Return Value

Promise<IResponse<T>>

#search()

1public async search<T = any>(payload: Record<string, any>)

Filter all wallets by the given parameters.

#Parameters

#Return Value

Promise<IResponse<T>>