The crypto ecosystem provides the tools to define which exchanges, which assets and which markets you wish to work with.

Crypto Ecosystem

Crypto Exchanges

Crypto Exchange

Exchange Assets

Asset

Exchange Markets

Market

Market Base Asset

Market Quoted Asset

Exchange Accounts

User Account

User Keys

Exchange Account Key

User Assets

Exchange Account Asset

Crypto Ecosystem

The crypto ecosystem is a hierarchy that contains definitions about third-parties, including exchanges and their markets, as well as accounts of users with those third parties.

There is only one crypto ecosystem hierarchy. You will use it to define which exchanges and which markets you wish to work with, as well as the details of your accounts with those exchanges.

Crypto Exchanges

The crypto exchanges node groups definitions of the different exchanges the user may interact with.

Adding a Crypto Exchanges Node

To add a crypto exchanges node, select Add Crypto Exchanges on the crypto ecosystem node menu.

Crypto Exchange

A crypto exchange node holds the definitions of assets and markets in a specific exchange.

Adding a Crypto Exchange Node

To add a crypto exchange, select Add Crypto Exchange on the crypto exchanges node menu. The crypto exchange node is created along with the rest of the basic structure of nodes required to define assets, markets and user accounts.

Configuring the Crypto Exchange

Select Configure Crypto Exchange on the menu to access the configuration.

{
    "codeName": "binance",
    "API": [
        {
            "method": "fetchTrades",
            "fetchType": "by Id",
            "fetchTradesMethod": "publicGetHistoricalTrades",
            "firstId": "f"
        }
    ]
}
  • codeName is the name of the exchange as handled in the code of the system.

  • API holds a series of definitions used only in the case in which the sensor bot fetches trades (using the Historic-Trades process) instead of the OHLCV process that fetches one-minute candles and is the current default. In such a case, finding the right set of parameters to work with a specific exchange may be challenging, nd involves understanding how the exchanges API and the CCXT Library API work. In other words, there is no hard rule as of what each of the values should be. Determining each of this values requires exploring the exchange’s API documentation, as well as the documentation of the CCXT Library.

Exchange Assets

The exchange assets node groups the definitions of assets.

Adding an Exchange Assets Node

To add an exchange assets node, select Add Exchange Assets on the crypto exchanges node menu. The exchange assets node is created along with a first asset.

Configuring the Exchange Assets Node

Select Configure Exchange Assets on the menu to access the configuration.

{ 
"addMissingAssets": { "quotedAsset": "BTC"} 
}
  • addMissingAssets acts as a filter to determine which assets of a (potentially long) list of assets listed at the exchange will be added when the Add Missing Assets option in the menu is used. Because many exchanges do not offer a list of assets, the system fetches assets from actual markets (pairs) listed at the exchange. You may add missing assets filtered by the quotedAsset or by the baseAsset. For example, the above configuration would add all assets listed in markets in which BTC is the quoted asset.

Asset

An asset node is the definition of an asset listed at the corresponding exchange.

Adding an Asset Node

To add an asset, select Add Asset on the exchange assets node menu.

To add assets in bulk, select Add Missing Assets on the exchange assets node menu. Beware that the exchange may handle hundreds of assets. Before using this option you may want to implement a filter using the exchange assets configuration.

Click to learn more about exchange assets

Configuring the Exchange Assets Node

Select Configure Exchange Assets on the menu to access the configuration.

{ 
"addMissingAssets": { "quotedAsset": "BTC"} 
}
  • addMissingAssets acts as a filter to determine which assets of a (potentially long) list of assets listed at the exchange will be added when the Add Missing Assets option in the menu is used. Because many exchanges do not offer a list of assets, the system fetches assets from actual markets (pairs) listed at the exchange. You may add missing assets filtered by the quotedAsset or by the baseAsset. For example, the above configuration would add all assets listed in markets in which BTC is the quoted asset.

Configuring an Asset Node

Select Configure Asset on the menu to access the configuration.

{ 
"codeName": "BTC"
}
  • codeName is the ticker of the asset as listed by the exchange (i.e.: BTC, BTH, ETH, LTC, BNB, USDT, USD, etc.)

Exchange Markets

The exchange markets node groups the definitions of markets.

Adding an Exchange Markets Node

To add an exchange markets node, select Add Exchange Markets on the crypto exchange node menu. The exchange markets node is created along with the basic structure of nodes to define the first market.

Market

A market is the definition of a pair of assets (i.e.: BTC-USDT) listed as a market in the corresponding exchange.

Adding a Market Node

To add a market, select Add Market on the exchange markets node menu. The market node is created along with the basic structure of nodes used to define the market. This option does not generate the super actions required to install and uninstall markets.

To add markets in bulk, select Add Missing Markets on the exchange markets node menu. This option adds all markets listed at the exchange that may result from the combination of assets listed under the exchange assets node, along with the required super actions to intall those markets.

Market Base Asset

The market base asset is the asset in the pair used to provide a quote—a price—for the quoted asset, as listed at the exchange.

A market base asset must reference an asset defined under the exchange assets node.

Adding a Market Base Asset Node

To add a market base asset, select Add Market Base Asset on the market node menu.

Market Quoted Asset

The market quoted asset is the asset in the pair for which a quote is given, denominated in the base asset, as listed at the exchange.

A market quoted asset must reference an asset defined under the exchange assets node.

Adding a Market Quoted Asset Node

To add a market quoted asset, select Add Market Quoted Asset on the market node menu.

Exchange Accounts

The exchange accounts node groups the different accounts the user may have with the corresponding exchange.

Adding an Exchange Accounts Node

To add an exchange accounts node, select Add Exchange Account on the crypto exchange node menu. The exchange account node is created along with the basic structure of nodes used to define keys and user assets with the exchange.

User Account

A user account represents a single account with the corresponding exchange, holding the definitions of user assets, including keys and balances.

Adding a User Account Node

To add a user account, select Add User Account on the exchange accounts node menu. The user account node is created along with the basic structure of nodes used to define keys and user assets with the exchange.

User Keys

The user keys node groups the various exchange account keys the user may have under the corresponding account with the exchange.

Adding a User Keys Node

To add user keys node, select Add User Keys on the user account node menu. The user keys node is created along with the first exchange account key.

Exchange Account Key

The exchange account key holds the definition of the key name and secret provided by the corresponding exchange to access the user account via the exchange API.

Adding an Exchange Account Key Node

To add an exchange account key, select Add Key on the user keys node menu.

Configuring the Exchange Account Key

Select Configure Key on the menu to access the configuration.

{ 
"codeName": "Paste your exchange API name or label here",
"secret": "Paste your exchange API secret key here."
}
  • codeName is the name or label of your key, as supplied by the exchange.

  • secret is the secret key as supplied by the exchange.

User Assets

The user assets node groups the assets the user has at the exchange.

Adding a User Assets Node

To add user assets node, select Add User Assets on the user account node menu. The user assets node is created along with the first exchange account asset.

Exchange Account Asset

The exchange account asset represents a single asset the user has at the exchange.

The exchange account asset is a reference to an asset defined under the exchange assets node.

Adding an Exchange Account Asset Node

To add an exchange account asset node, select Add Asset on the user assets node menu.