bitburner-src/doc/source/netscript/tixapi/buy.rst

18 lines
773 B
ReStructuredText
Raw Normal View History

2021-10-27 21:16:16 +02:00
buy() Netscript Function
=============================
2021-10-27 21:16:16 +02:00
.. js:function:: buy(sym, shares)
2021-03-12 08:51:56 +01:00
:RAM cost: 2.5 GB
:param string sym: Symbol of stock to purchase
:param number shares: Number of shares to purchased. Must be positive. Will be rounded to nearest integer
2021-03-12 08:51:56 +01:00
Attempts to purchase shares of a stock using a `Market Order <http://bitburner.wikia.com/wiki/Stock_Market#Order_Types>`_.
If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember
that every transaction on the stock exchange costs a certain commission fee.
If this function successfully purchases the shares, it will return the stock price at which each share was purchased. Otherwise,
it will return 0.