BuyingPower Property
Buying power.
Syntax
invstatement.getBuyingPower([callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getBuyingPower([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setBuyingPower([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
The amount of money available to buy securities. In a margin account, the buying power is the total cash held in the brokerage account plus maximum margin available.
This property is an optional field. When calling the GetStatement method, if the server's response does not contain this value, querying the property will return an empty string.
This property is read-only.
Data Type
String