TradesCallBuilder

TradesCallBuilder

TradesCallBuilder

Constructor

new TradesCallBuilder(serverUrl)

Source:
See:
Parameters:
Name Type Description
serverUrl string

serverUrl Horizon server URL.

Extends

Methods

call() → {Promise}

Triggers a HTTP request using this builder's current configuration.

Inherited From:
Source:
Returns:
Type:
Promise

a Promise that resolves to the server's response.

cursor(cursor) → {object}

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

Inherited From:
Source:
See:
Parameters:
Name Type Description
cursor string

A cursor is a value that points to a specific location in a collection of resources.

Returns:
Type:
object

current CallBuilder instance

forAccount(accountId) → {TradesCallBuilder}

Filter trades for a specific account

Source:
See:
Parameters:
Name Type Description
accountId string

For example: GBYTR4MC5JAX4ALGUBJD7EIKZVM7CUGWKXIUJMRSMK573XH2O7VAK3SR

Returns:
Type:
TradesCallBuilder

current TradesCallBuilder instance

forAssetPair(base, counter) → {TradesCallBuilder}

Filter trades for a specific asset pair (orderbook)

Source:
Parameters:
Name Type Description
base Asset

asset

counter Asset

asset

Returns:
Type:
TradesCallBuilder

current TradesCallBuilder instance

forOffer(offerId) → {TradesCallBuilder}

Filter trades for a specific offer

Source:
Parameters:
Name Type Description
offerId string

ID of the offer

Returns:
Type:
TradesCallBuilder

current TradesCallBuilder instance

limit(number) → {object}

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

Inherited From:
Source:
See:
Parameters:
Name Type Description
number number

Number of records the server should return.

Returns:
Type:
object

current CallBuilder instance

order(direction) → {object}

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Inherited From:
Source:
Parameters:
Name Type Description
direction "asc" | "desc"

Sort direction

Returns:
Type:
object

current CallBuilder instance

stream(optionsopt) → {function}

Creates an EventSource that listens for incoming messages from the server. To stop listening for new events call the function returned by this method.

Inherited From:
Source:
See:
Parameters:
Name Type Attributes Description
options object <optional>

EventSource options.

Name Type Attributes Description
onmessage function <optional>

Callback function to handle incoming messages.

onerror function <optional>

Callback function to handle errors.

reconnectTimeout number <optional>

Custom stream connection timeout in ms, default is 15 seconds.

Returns:
Type:
function

Close function. Run to close the connection and stop listening for new events.