.. _netscript_tixapi:

Netscript Trade Information eXchange (TIX) API
==============================================

The Trade Information eXchange (TIX) is the communications protocol supported by the World Stock Exchange (WSE).
The WSE provides an API that allows you to automatically communicate with the
:ref:`Stock Market <gameplay_stock_market>`.
This API lets you write code using Netscript
to build automated trading systems and create your own algorithmic trading strategies. Access to this
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

.. 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>
    sellShort() <tixapi/sellShort>
    placeOrder() <tixapi/placeOrder>
    cancelOrder() <tixapi/cancelOrder>
    getOrders() <tixapi/getOrders>
    getStockVolatility() <tixapi/getStockVolatility>
    getStockForecast() <tixapi/getStockForecast>
    purchase4SMarketData() <tixapi/purchase4SMarketData>
    purchase4SMarketDataTixApi() <tixapi/purchase4SMarketDataTixApi>
