Global

Type Definitions


Account

A container that holds tokens in a ledger.

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

Type:
  • Object
Properties:
Name Type Description
id String

Unique identifier of the account.

keyIds Array.<String>

The list of IDs for the keys that control the account.

quorum Number

The number of keys required to sign transactions that transfer or retire tokens from the account.

tags Object

User-specified tag structure for the account.


Action

Each transaction contains one or more actions. Action queries are designed to provide insights into those actions. There are two types of queries you can run against them; one is "List", one is "Sum". A list query returns a list of Action objects that match the filter; a sum query sums over the amount fields based on the filter and the groupBy param and returns ActionSum objects. Different from other regular API objects, the amount field in ActionSum represents the summation of the amount fields of those matching actions, and all other fields represent the parameters by which to group actions.

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

Type:
  • Object
Properties:
Name Type Description
amount Number

Summation of action amounts

type String

The type of the action. Currently, there are three options: "issue", "transfer", "retire".

id String

A unique ID.

transactionId String

The ID of the transaction in which the action appears.

accountId String

The account containing the tokens.

timestamp Time

Time of the action.

flavorId String

The ID of the flavor held by the action.

snapshot Object

A copy of the associated tags (flavor, source account, destination account, action, and token) as they existed at the time of the transaction.

sourceAccountId String

The ID of the source account executing the action.

destinationAccountId String

The ID of the destination account affected by the action.

tags Object

User-specified key-value data embedded in the action.


Flavor

A taxonomy used to differentiate different types of tokens in a ledger.

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

Type:
  • Object
Properties:
Name Type Description
id String

Unique identifier of the flavor.

keyIds Array.<String>

The list of IDs for the keys that control the flavor.

quorum Number

The number of keys required to sign transactions that issue tokens of the flavor.

tags Object

User-specified tag structure for the flavor.


Key

Cryptographic private keys are the primary authorization mechanism on a blockchain.

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

Type:
  • Object
Properties:
Name Type Description
id String

Unique identifier of the key.


Stats

Summary information about a ledger.

Type:
  • Object
Properties:
Name Type Description
flavorCount Number
accountCount Number
txCount Number
ledgerType String

TokenGroup

Type:
  • Object
Properties:
Name Type Description
amount Number

The amount of tokens in the group.

flavorId String

The flavor of the tokens in the group.

flavorTags Object

The tags of the flavor of the tokens in the group.

accountId String

The account containing the tokens.

accountTags Object

The tags of the account containing the tokens.

tags Object

The tags of the tokens in the group.


TokenSum

Type:
  • Object
Properties:
Name Type Argument Description
amount Number

The amount of tokens in the group.

flavorId String <optional>

The flavor of the tokens in the group.

flavorTags Object <optional>

The tags of the flavor of the tokens in the group.

accountId String <optional>

The account containing the tokens.

accountTags Object <optional>

The tags of the account containing the tokens.

tags Object <optional>

The tags of the tokens in the group.


Transaction

A blockchain consists of an immutable set of cryptographically linked transactions. Each transaction contains one or more actions.

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

Type:
  • Object
Properties:
Name Type Description
id String

Unique transaction identifier.

timestamp String

Time of transaction, RFC3339 formatted.

sequenceNumber Number

Sequence number of the transaction.

actions Array.<Action>

List of specified actions for a transaction.

tags Object

User-specified key-value data embedded in the transaction.