Operation Commands

Commands Overview

Below are the available commands in the current Orion Broker release.

connect

Add API keys to exchanges.

connect [ exchange ]

Connect to an exchange by adding API keys.

>  connect binance

Enter your Binance API key
> abc123

Enter your Binance secret
> abc123

You are now connected to binance.

Replace existing API keys to an exchange connection.

>  connect binance

Would you like to replace your existing binance API key ...abc1 (Yes/No)?
> Yes

Enter your Binance API key
> abc123

Enter your Binance secret
> abc123

privatekey

Set your ETH wallet private key.

privatekey [ privatekey ]

This key will be stored securely encrypted. Please note that you need to add 0x in the beginning of key, if it's not already so.

> privatekey

Enter your ETH wallet private key
> 0x0000000000000000000000000000000000000000000000000000000000000000

You have successfully set the private key for your ETH wallet.

approve

Allows the transfer of specified token between Orion Smart Contract and broker address.

Please note that you should enter the alias of asset, not a token contract address. List of available assets (please refer to assetToAddress section) is available via public API

> approve 10000000000 USDT

For your convenience, you can specify a deliberately large amount - in this case, the accept method can be called only once (during the initial configuration of the broker or addition of a new token).

deposit

Transfers a specified token amount to Orion Smart Contract. Use this method for an initial deposit, or when you want to deposit additional collateral funds.

Please note that you should enter the alias of asset, not a token contract address. List of available assets is available via public API

> deposit 100000 ORN

The transfered funds will be used for a settlement for executed orders routed via your broker address.
In case of ORN you should also stake some amount, if you haven't already done so.

stake

Increases the staked amount of ORN.

> stake 100
> stake 100

Subsequent calls increases the amount of staking. In the example above the total staked amount of ORN would be equal to 200 (given that it was 0 before first call).

exwithdraw

Withdraws the specified amount of specified token from specified exchange to broker address.

> exwithdraw bitmax 100 USDT

This method is just for convenience. During normal operation, the withdraw will be generated automatically, if necessary.

help

List available commands.

> help
usage: {connect,help,privatekey,emulator,exit}
..

positional arguments:
  {connect,help,privatekey,emulator,exit}
    connect             Add API keys to exchanges
    help                List available commands
    privatekey             Set your ETH wallet private key
    emulator            Turn on/off emulator
    exit                Exit app (outstanding orders will be continued after the next launch)

help [ command_name ]

Displays command usage and function.

>  help connect

usage:  connect [-h] [{binance,bitmax,kucoin}]

positional arguments:
  {binance,bitmax,kucoin}
                        Name of the exchange that you want to connect

emulator

Turn on/off emulator

>  emulator

You have successfully changed the emulator mode.

exit

Exit app (outstanding orders will be continued after the next launch).

>  exit

Winding down...
All outstanding orders will be continued after the next launch.