hiveengine CLI¶

Commands¶

hiveengine¶

hiveengine [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options

-d, --no-broadcast¶: Do not broadcast

-v, --verbose <verbose>¶: Verbosity

--version¶: Show the version and exit.

balance¶

Show token balance and value

hiveengine balance [OPTIONS]

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

buy¶

Put a buy-order for a token to the hive-engine market

hiveengine buy [OPTIONS] AMOUNT TOKEN PRICE

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

Arguments

AMOUNT¶: Required argument

TOKEN¶: Required argument

PRICE¶: Required argument

buybook¶

Returns the buy book for the given token

hiveengine buybook [OPTIONS] [TOKEN]

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

Arguments

TOKEN¶: Optional argument

cancel¶

Cancel a buy/sell order

order_type is either sell or buy

hiveengine cancel [OPTIONS] ORDER_TYPE [ORDER_ID]

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

-y, --yes¶: Answer yes to all questions

Arguments

ORDER_TYPE¶: Required argument

ORDER_ID¶: Optional argument

cancel-unstake¶

unstake a token

hiveengine cancel-unstake [OPTIONS] TRX_ID

Options

-a, --account <account>¶: Transfer from this account

Arguments

TRX_ID¶: Required argument

collection¶

Return NFT collection for an account

hiveengine collection [OPTIONS] ACCOUNT [SYMBOL]...

Options

-s, --sort-by-id¶: Sort NFTs by their ID

Arguments

ACCOUNT¶: Required argument

SYMBOL¶: Optional argument(s)

deposit¶

Deposit HIVE to market in exchange for SWAP.HIVE.

hiveengine deposit [OPTIONS] AMOUNT

Options

-a, --account <account>¶: withdraw from this account

Arguments

AMOUNT¶: Required argument

info¶

Show basic blockchain info

General information about hive-engine, a block, an account, a token, and a transaction id

hiveengine info [OPTIONS] [OBJECTS]...

Arguments

OBJECTS¶: Optional argument(s)

issue¶

Issue a token

hiveengine issue [OPTIONS] TO AMOUNT TOKEN

Options

-a, --account <account>¶: Transfer from this account

Arguments

TO¶: Required argument

AMOUNT¶: Required argument

TOKEN¶: Required argument

nft¶

Returns information about an NFT ID

hiveengine nft [OPTIONS] SYMBOL [NFTID]...

Arguments

SYMBOL¶: Required argument

NFTID¶: Optional argument(s)

nftbuy¶

Buy nfts from the market

hiveengine nftbuy [OPTIONS] SYMBOL [NFT_IDS]...

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

-m, --market_account <market_account>¶: Market account which will receive the fee (defaults to “nftmarket”)

-y, --yes¶: Answer yes to all questions

Arguments

SYMBOL¶: Required argument

NFT_IDS¶: Optional argument(s)

nftcancel¶

Cancel a nft sell order

hiveengine nftcancel [OPTIONS] SYMBOL [NFT_IDS]...

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

-y, --yes¶: Answer yes to all questions

Arguments

SYMBOL¶: Required argument

NFT_IDS¶: Optional argument(s)

nftchangeprice¶

Cancel a nft sell order

hiveengine nftchangeprice [OPTIONS] SYMBOL [NFT_IDS]... NEWPRICE

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

-y, --yes¶: Answer yes to all questions

Arguments

SYMBOL¶: Required argument

NFT_IDS¶: Optional argument(s)

NEWPRICE¶: Required argument

nftinfo¶

Returns information about an NFT symbol

hiveengine nftinfo [OPTIONS] [SYMBOL]...

Arguments

SYMBOL¶: Optional argument(s)

nftlist¶

Show list of all NFTs

hiveengine nftlist [OPTIONS]

nftopen¶

Returns the open interest book for the given symbol

hiveengine nftopen [OPTIONS] SYMBOL

Options

-g, --grouping <grouping>¶: Can be set to a grouping parameter, or to parameter.value

-v, --value <value>¶: Set property value, can be used when grouping is set to a property parameter

-s, --price-symbol <price_symbol>¶: Limit to this price symbol

Arguments

SYMBOL¶: Required argument

nftparams¶

Show params of all NFTs

hiveengine nftparams [OPTIONS]

nftsell¶

Create a sell order on the market

hiveengine nftsell [OPTIONS] SYMBOL [NFT_IDS]... PRICE PRICE_SYMBOL

Options

-a, --account <account>¶: Buy with this account (uses the beem default account when not set)

-f, --fee <fee>¶: Market fee 500 -> 5% (defaults is 500)

-y, --yes¶: Answer yes to all questions

Arguments

SYMBOL¶: Required argument

NFT_IDS¶: Optional argument(s)

PRICE¶: Required argument

PRICE_SYMBOL¶: Required argument

nftsellbook¶

Returns the sell book for the given symbol

hiveengine nftsellbook [OPTIONS] SYMBOL

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

-g, --grouping <grouping>¶: Can be set to a grouping parameter, or to parameter.value

-v, --value <value>¶: Set property value, can be used when grouping is set to a property parameter

-s, --price-symbol <price_symbol>¶: Limit to this price symbol

-n, --nft-id <nft_id>¶: Limit to this nft id

-c, --cheapest-only¶: Show only the cheapest open sell for each type

-m, --min-hive <min_hive>¶: Show only NFT which have a higher price

-l, --limit <limit>¶: Limit to shown entries

-i, --interactive¶: Show only the cheapest open sell for each type

Arguments

SYMBOL¶: Required argument

nfttrades¶

Returns the trades history

hiveengine nfttrades [OPTIONS] [SYMBOL]

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

Arguments

SYMBOL¶: Optional argument

richlist¶

Shows the richlist of a token

hiveengine richlist [OPTIONS] SYMBOL

Options

-t, --top <top>¶: Show only the top n accounts

Arguments

SYMBOL¶: Required argument

sell¶

Put a sell-order for a token to the hive-engine market

hiveengine sell [OPTIONS] [AMOUNT] [TOKEN] [PRICE]

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

Arguments

AMOUNT¶: Optional argument

TOKEN¶: Optional argument

PRICE¶: Optional argument

sellbook¶

Returns the sell book for the given token

hiveengine sellbook [OPTIONS] [TOKEN]

Options

-a, --account <account>¶: Buy with this account (defaults to “default_account”)

Arguments

TOKEN¶: Optional argument

stake¶

stake a token / all tokens

hiveengine stake [OPTIONS] [AMOUNT] [TOKEN]

Options

-a, --account <account>¶: Stake token from this account

-r, --receiver <receiver>¶: Stake to this account (default is sender account)

Arguments

AMOUNT¶: Optional argument

TOKEN¶: Optional argument

tokenlist¶

Show list of all tokens

hiveengine tokenlist [OPTIONS]

transfer¶

Transfer a token

hiveengine transfer [OPTIONS] TO [AMOUNT] [TOKEN] [MEMO]

Options

-m, --memos <memos>¶: Can be used when all tokens should be send

-a, --account <account>¶: Transfer from this account

Arguments

TO¶: Required argument

AMOUNT¶: Optional argument

TOKEN¶: Optional argument

MEMO¶: Optional argument

unstake¶

unstake a token / all tokens

hiveengine unstake [OPTIONS] [AMOUNT] [TOKEN]

Options

-a, --account <account>¶: Transfer from this account

Arguments

AMOUNT¶: Optional argument

TOKEN¶: Optional argument

withdraw¶

Widthdraw SWAP.HIVE to account as HIVE.

hiveengine withdraw [OPTIONS] AMOUNT

Options

-a, --account <account>¶: withdraw from this account

Arguments

AMOUNT¶: Required argument