This commit is contained in:
Olivier Gagnon
2021-10-27 15:16:16 -04:00
parent b255318a20
commit 8f097ebb32
25 changed files with 508 additions and 413 deletions
+15 -13
View File
@@ -13,25 +13,27 @@ TIX API can be purchased by visiting the World Stock Exchange in-game.
Access to the TIX API currently costs $5 billion. After you purchase it, you will retain this
access even after you 'reset' by installing Augmentations
**TIX API functions must be accessed through the stock namespace**
.. toctree::
:caption: API Functions:
getStockSymbols() <tixapi/getStockSymbols>
getStockPrice() <tixapi/getStockPrice>
getStockAskPrice() <tixapi/getStockAskPrice>
getStockBidPrice() <tixapi/getStockBidPrice>
getStockPosition() <tixapi/getStockPosition>
getStockMaxShares() <tixapi/getStockMaxShares>
getStockPurchaseCost() <tixapi/getStockPurchaseCost>
getStockSaleGain() <tixapi/getStockSaleGain>
buyStock() <tixapi/buyStock>
sellStock() <tixapi/sellStock>
shortStock() <tixapi/shortStock>
getSymbols() <tixapi/getSymbols>
getPrice() <tixapi/getPrice>
getAskPrice() <tixapi/getAskPrice>
getBidPrice() <tixapi/getBidPrice>
getPosition() <tixapi/getPosition>
getMaxShares() <tixapi/getMaxShares>
getPurchaseCost() <tixapi/getPurchaseCost>
getSaleGain() <tixapi/getSaleGain>
buy() <tixapi/buy>
sell() <tixapi/sell>
short() <tixapi/short>
sellShort() <tixapi/sellShort>
placeOrder() <tixapi/placeOrder>
cancelOrder() <tixapi/cancelOrder>
getOrders() <tixapi/getOrders>
getStockVolatility() <tixapi/getStockVolatility>
getStockForecast() <tixapi/getStockForecast>
getVolatility() <tixapi/getVolatility>
getForecast() <tixapi/getForecast>
purchase4SMarketData() <tixapi/purchase4SMarketData>
purchase4SMarketDataTixApi() <tixapi/purchase4SMarketDataTixApi>
@@ -1,7 +1,7 @@
buyStock() Netscript Function
buy() Netscript Function
=============================
.. js:function:: buyStock(sym, shares)
.. js:function:: buy(sym, shares)
:RAM cost: 2.5 GB
:param string sym: Symbol of stock to purchase
@@ -1,7 +1,7 @@
getStockAskPrice() Netscript Function
getAskPrice() Netscript Function
=====================================
.. js:function:: getStockAskPrice(sym)
.. js:function:: getAskPrice(sym)
:RAM cost: 2 GB
:param string sym: Stock symbol
@@ -1,7 +1,7 @@
getStockBidPrice() Netscript Function
getBidPrice() Netscript Function
=====================================
.. js:function:: getStockBidPrice(sym)
.. js:function:: getBidPrice(sym)
:RAM cost: 2 GB
:param string sym: Stock symbol
@@ -1,7 +1,7 @@
getStockForecast() Netscript Function
getForecast() Netscript Function
=====================================
.. js:function:: getStockForecast(sym)
.. js:function:: getForecast(sym)
:RAM cost: 2.5 GB
:param string sym: Symbol of stock
@@ -1,7 +1,7 @@
getStockMaxShares() Netscript Function
getMaxShares() Netscript Function
======================================
.. js:function:: getStockMaxShares(sym)
.. js:function:: getMaxShares(sym)
:RAM cost: 2 GB
:param string sym: Stock symbol
@@ -1,7 +1,7 @@
getStockPosition() Netscript Function
getPosition() Netscript Function
=====================================
.. js:function:: getStockPosition(sym)
.. js:function:: getPosition(sym)
:RAM cost: 2 GB
:param string sym: Stock symbol
@@ -21,7 +21,7 @@ getStockPosition() Netscript Function
Example::
pos = getStockPosition("ECP");
pos = getPosition("ECP");
shares = pos[0];
avgPx = pos[1];
sharesShort = pos[2];
@@ -1,7 +1,7 @@
getStockPrice() Netscript Function
getPrice() Netscript Function
==================================
.. js:function:: getStockPrice(sym)
.. js:function:: getPrice(sym)
:RAM cost: 2 GB
:param string sym: Stock symbol
@@ -15,4 +15,4 @@ getStockPrice() Netscript Function
Example::
getStockPrice("FSIG");
getPrice("FSIG");
@@ -1,7 +1,7 @@
getStockPurchaseCost() Netscript Function
getPurchaseCost() Netscript Function
=========================================
.. js:function:: getStockPurchaseCost(sym, shares, posType)
.. js:function:: getPurchaseCost(sym, shares, posType)
:RAM cost: 2 GB
:param string sym: Stock symbol
@@ -1,7 +1,7 @@
getStockSaleGain() Netscript Function
getSaleGain() Netscript Function
=====================================
.. js:function:: getStockSaleGain(sym, shares, posType)
.. js:function:: getSaleGain(sym, shares, posType)
:RAM cost: 2 GB
:param string sym: Stock symbol
@@ -1,7 +1,7 @@
getStockSymbols() Netscript Function()
getSymbols() Netscript Function()
======================================
.. js:function:: getStockSymbols()
.. js:function:: getSymbols()
:RAM cost: 2 GB
@@ -1,7 +1,7 @@
sellStock() Netscript Function
sell() Netscript Function
==============================
.. js:function:: sellStock(sym, shares)
.. js:function:: sell(sym, shares)
:RAM cost: 2.5 GB
:param string sym: Symbol of stock to sell
@@ -1,7 +1,7 @@
shortStock() Netscript Function
short() Netscript Function
===============================
.. js:function:: shortStock(sym, shares)
.. js:function:: short(sym, shares)
:RAM cost: 2.5 GB
:param string sym: Symbol of stock to short