Module: FeedsApi

API for interacting with feeds. You can use feeds to process actions/transactions as they arrive on the blockchain. This is helpful for real-time applications such as notifications or live-updating interfaces.

More info: https://dashboard.seq.com/docs/feeds

Methods


<inner> create(params)

Create a new feed.

Parameters:
Name Type Description
params module:FeedsApi~createRequest

Parameters for feed creation.

Returns:

Newly created feed.

Type
Promise.<Feed>

<inner> delete(params)

Deletes a feed.

Parameters:
Name Type Description
params module:FeedsApi~deleteRequest

Parameters for feed deletion.

Returns:

Promise resolved on success.

Type
Promise

<inner> get(params)

Retrieves a single feed.

Parameters:
Name Type Description
params module:FeedsApi~getRequest

Parameters for feed retrieval.

Returns:

Requested feed.

Type
Promise.<Feed>

<inner> list()

Query a list of feeds.

Returns:

Query to retrieve results.

Type
Query

Type Definitions


createRequest

Type:
  • Object
Properties:
Name Type Description
id String

Unique identifier of the feed.

type String

Type of feed, "action" or "transaction".

filter String

The query filter used to select matching items.

filterParams Array.<(string|number)>

A list of values that will be interpolated into the filter expression.


deleteRequest

Type:
  • Object
Properties:
Name Type Description
id String

Unique identifier of the feed.


getRequest

Type:
  • Object
Properties:
Name Type Description
id String

Unique identifier of the feed.