Skip to content
ZapCLI

Buy Amount

Syntax

this.buyAmount(asset, amount, options?)

Description

The buyAmount function generates a buy order for a specified symbol and amount. It returns an order object containing information about the buy action. The function also supports additional options to control order generation based on existing open positions.

Returns

The buyAmount function returns an order object containing information about the buy action. If the order is not generated due to existing open positions, it may return null

Parameters

  • asset: asset to be bought
  • amount: amount to be bought.
  • options?
    • target: checks openPositions and generates order to balance portfolio
    • round: round the number of shares to the nearest whole number

Examples

// Buys 1.29 shares of AAPL if price is 155
this.buyAmount(this.asset("AAPL"), 200);
//=> order {symbol: "AAPL", action: "buy", units: 1.29, ....}


// Buys 1 share of AAPL if price is 155
this.buyAmount(this.asset("AAPL"), 200, { round: true });
//=> order {symbol: "AAPL", action: "buy", units: 1, ....}