Files
bitburner-src/markdown/bitburner.tix.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* Update api-documentor and api-extractor. #1566 follow-up.

I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.

I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).

Stylisticly it could use some whitespace, but it is correctly rendered.

This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.

* Follow up to 5f732a6f35, include `npm run doc` changed docs.

* Add missing license info

* Fix React warning

---------

Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
2025-09-26 14:52:39 -07:00

4.2 KiB
Raw Blame History

Home > bitburner > TIX

TIX interface

Stock market API

Signature:

export interface TIX 

Methods

Method

Description

buyShort(sym, shares)

Short stocks.

buyStock(sym, shares)

Buy stocks.

cancelOrder(sym, shares, price, orderType, positionType)

Cancel order for stocks.

getAskPrice(sym)

Returns the ask price of that stock.

getBidPrice(sym)

Returns the bid price of that stock.

getBonusTime()

Get Stock Market bonus time.

getConstants()

Get game constants for the stock market mechanic.

getForecast(sym)

Returns the probability that the specified stocks price will increase (as opposed to decrease) during the next tick.

getMaxShares(sym)

Returns the maximum number of shares of a stock.

getOrders()

Returns your order book for the stock market.

getOrganization(sym)

Returns the organization associated with a stock symbol.

getPosition(sym)

Returns the players position in a stock.

getPrice(sym)

Returns the price of a stock.

getPurchaseCost(sym, shares, positionType)

Calculates cost of buying stocks.

getSaleGain(sym, shares, positionType)

Calculate profit of selling stocks.

getSymbols()

Returns an array of the symbols of the tradable stocks

getVolatility(sym)

Returns the volatility of the specified stock.

has4SData()

Returns true if the player has access to the 4S Data

has4SDataTixApi()

Returns true if the player has access to the 4SData TIX API

hasTixApiAccess()

Returns true if the player has access to the TIX API

hasWseAccount()

Returns true if the player has access to a WSE Account

nextUpdate()

Sleep until the next Stock Market price update has happened.

placeOrder(sym, shares, price, orderType, positionType)

Place order for stocks.

purchase4SMarketData()

Purchase 4S Market Data Access.

purchase4SMarketDataTixApi()

Purchase 4S Market Data TIX API Access.

purchaseTixApi()

Purchase TIX API Access

purchaseWseAccount()

Purchase WSE Account.

sellShort(sym, shares)

Sell short stock.

sellStock(sym, shares)

Sell stocks.