Trading Calls
Trading Calls
sell_asset
Place a limit order attempting to sell one asset for another.
Buying and selling are the same operation on Graphene; if you want to buy BTS with USD, you should sell USD for BTS.
The blockchain will attempt to sell the symbol_to_sell
for as much symbol_to_receive
as possible, as long as the price is at least min_to_receive
/ amount_to_sell
.
In addition to the transaction fees, market fees will apply as specified by the issuer of both the selling asset and the receiving asset as a percentage of the amount exchanged.
If either the selling asset or the receiving asset is whitelist restricted, the order will only be created if the seller is on the whitelist of the restricted asset type.
Market orders are matched in the order they are included in the block chain.
seller_account
: the account providing the asset being sold, and which will receive the proceeds of the sale.amount_to_sell
: the amount of the asset being sold to sell (in nominal units)symbol_to_sell
: the name or id of the asset to sellmin_to_receive
: the minimum amount you are willing to receive in return for selling the entire amount_to_sellsymbol_to_receive
: the name or id of the asset you wish to receivetimeout_sec
: if the order does not fill immediately, this is the length of time the order will remain on the order books before it is cancelled and the un-spent funds are returned to the seller’s accountfill_or_kill
: if true, the order will only be included in the blockchain if it is filled immediately; if false, an open order will be left on the books to fill any amount that cannot be filled immediately.broadcast
: true to broadcast the transaction on the network
borrow_asset
Borrow an asset or update the debt/collateral ratio for the loan.
This is the first step in shorting an asset.
Call sell_asset()
to complete the short.
borrower_name
: the name or id of the account associated with the transaction.amount_to_borrow
: the amount of the asset being borrowed. Make this value negative to pay back debt.asset_symbol
: the symbol or id of the asset being borrowed.amount_of_collateral
: the amount of the backing asset to add to your collateral position. Make this negative to claim back some of your collateral. The backing asset is defined in thebitasset_options
for the asset being borrowed.broadcast
: true to broadcast the transaction on the network
cancel_order
Cancel an existing order.
order_id
: the id of order to be cancelledbroadcast
: true to broadcast the transaction on the network
settle_asset
Schedules a market-issued asset for automatic settlement.
Holders of market-issued assets may request a forced settlement for some amount of their asset. This means that the specified sum will be locked by the chain and held for the settlement period, after which time the chain will choose a margin position holder and buy the settled asset using the margin’s collateral.
The price of this sale will be based on the feed price for the market-issued asset being settled. The exact settlement price will be the feed price at the time of settlement with an offset in favour of the margin position, where the offset is a blockchain parameter set in the global_property_object.
account_to_settle
: the name or id of the account owning the assetamount_to_settle
: the amount of the named asset to schedule for settlementsymbol
: the name or id of the asset to settlebroadcast
: true to broadcast the transaction on the network
get_market_history
Get OHLCV data of a trading pair in a time range.
symbol
: name or ID of the base assetsymbol2
: name or ID of the quote assetbucket
: length of each time bucket in seconds.start
: the start of a time range, E.G. “2018-01-01T00:00:00”end
: the end of the time range
get_limit_orders
Get limit orders in a given market.
a
: symbol or ID of asset being soldb
: symbol or ID of asset being purchasedlimit
: Maximum number of orders to retrieve
get_call_orders
Get call orders (aka margin positions) for a given asset.
a
: symbol name or ID of the debt assetlimit
: Maximum number of orders to retrieve
get_settle_orders
Get forced settlement orders in a given asset.
a
: Symbol or ID of asset being settledlimit
: Maximum number of orders to retrieve
Last updated