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 Peerplays; if you want to buy PPY with BTC, you should sell BTC for PPY.
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.
1
signed_transaction graphene::wallet::wallet_api::sell_asset(
2
string seller_account,
3
string amount_to_sell,
4
string symbol_to_sell,
5
string min_to_receive,
6
string symbol_to_receive,
7
uint32_t timeout_sec = 0,
8
bool fill_or_kill = false,
9
bool broadcast = false)
Copied!
Parameters
Return
  • 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, for example 0.5 for half of a PPY)
  • symbol_to_sell: the name or id of the asset to sell
  • min_to_receive: the minimum amount you are willing to receive in return for selling the entire amount_to_sell
  • symbol_to_receive: the name or id of the asset you wish to receive
  • timeout_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 account
  • fill_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
The signed transaction selling the funds.

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.
1
signed_transaction graphene::
2
wallet
3
::
4
wallet_api
5
::borrow_asset(string borrower_name, string amount_to_borrow, string asset_symbol, string amount_of_collateral, bool broadcast = false)
Copied!
Parameters
Return
  • 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 the bitasset_options for the asset being borrowed.
  • broadcast: true to broadcast the transaction on the network
The signed transaction borrowing the asset

cancel_order

Cancel an existing order.
1
signed_transaction graphene::wallet::wallet_api::cancel_order(
2
object_id_type order_id,
3
bool broadcast = false)
Copied!
Parameters
Return
  • order_id: the id of order to be cancelled
  • broadcast: true to broadcast the transaction on the network
The signed transaction canceling the order

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 favor of the margin position, where the offset is a blockchain parameter set in the global_property_object.
1
signed_transaction graphene::wallet::wallet_api::settle_asset(
2
string account_to_settle,
3
string amount_to_settle,
4
string symbol,
5
bool broadcast = false)
Copied!
Parameters
Return
  • account_to_settle: the name or id of the account owning the asset
  • amount_to_settle: the amount of the named asset to schedule for settlement
  • symbol: the name or id of the asset to settle
  • broadcast: true to broadcast the transaction on the network
The signed transaction settling the named asset.

get_market_history

Get OHLCV (Open, High, Low, Close, & Volume) data of a trading pair in a time range.
1
vector<bucket_object> graphene::wallet::wallet_api::get_market_history(
2
string symbol,
3
string symbol2,
4
uint32_t bucket,
5
fc::time_point_sec start,
6
fc::time_point_sec end)const
Copied!
Parameters
Return
  • symbol: name or ID of the base asset
  • symbol2: name or ID of the quote asset
  • bucket: 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
A list of OHLCV data, in “least recent first” order.

get_limit_orders

Get limit orders in a given market.
1
vector<limit_order_object> graphene::wallet::wallet_api::get_limit_orders(
2
string a,
3
string b,
4
uint32_t limit)const
Copied!
Parameters
Return
  • a: symbol or ID of asset being sold
  • b: symbol or ID of asset being purchased
  • limit: Maximum number of orders to retrieve
The limit orders, ordered from least price to greatest.

get_call_orders

Get call orders (aka margin positions) for a given asset.
1
vector<call_order_object> graphene::wallet::wallet_api::get_call_orders(
2
string a,
3
uint32_t limit)const
Copied!
Parameters
Return
  • a: symbol name or ID of the debt asset
  • limit: Maximum number of orders to retrieve
The call orders, ordered from earliest to be called to latest

get_settle_orders

Get forced settlement orders in a given asset.
1
vector<force_settlement_object> graphene::wallet::wallet_api::get_settle_orders(
2
string a,
3
uint32_t limit)const
Copied!
Parameters
Return
  • a: Symbol or ID of asset being settled
  • limit: Maximum number of orders to retrieve
The settle orders, ordered from earliest settlement date to latest