Global

Members

(constant) BANK_IND

b a n k_ i n d

Source: api.js, line 309

(constant) BITCOIN_ID

b i t c o i n_ i d

Source: api.js, line 390

(constant) CMOD_ID

c m o d_ i d

Source: api.js, line 350

(constant) COMPUTER1_ID

c o m p u t e r1_ i d

Source: api.js, line 330

(constant) COMPUTER2_ID

c o m p u t e r2_ i d

Source: api.js, line 334

(constant) COMPUTER3_ID

c o m p u t e r3_ i d

Source: api.js, line 338

(constant) COMPUTER4_ID

c o m p u t e r4_ i d

Source: api.js, line 342

(constant) CORN_ID

c o r n_ i d

Source: api.js, line 370

(constant) ETF_IND

e t f_ i n d

Source: api.js, line 321

(constant) ETHEREUM_ID

e t h e r e u m_ i d

Source: api.js, line 394

(constant) GNP_RATE_ID

g n p_ r a t e_ i d

Source: api.js, line 386

(constant) GOLD_ID

g o l d_ i d

Source: api.js, line 358

(constant) HUMAN1_ID

Entity IDs

Source: api.js, line 326

(constant) INSURANCE_IND

i n s u r a n c e_ i n d

Source: api.js, line 313

(constant) OIL_ID

o i l_ i d

Source: api.js, line 354

(constant) PLAYER_IND

Industry IDs

Source: api.js, line 305

(constant) PRIME_RATE_ID

p r i m e_ r a t e_ i d

Source: api.js, line 374

(constant) SBOND_RATE_ID

s b o n d_ r a t e_ i d

Source: api.js, line 382

(constant) SECURITIES_BROKER_IND

s e c u r i t i e s_ b r o k e r_ i n d

Source: api.js, line 317

(constant) SILVER_ID

s i l v e r_ i d

Source: api.js, line 362

(constant) STOCK_INDEX_ID

s t o c k_ i n d e x_ i d

Source: api.js, line 346

(constant) TBOND_RATE_ID

t b o n d_ r a t e_ i d

Source: api.js, line 378

(constant) UI_ADVISORY_REPORT

UI IDs

Source: api.js, line 399

(constant) UI_BANK_LOANS_LIST

u i_ b a n k_ l o a n s_ l i s t

Source: api.js, line 471

(constant) UI_COMPANIES_HEATMAP

u i_ c o m p a n i e s_ h e a t m a p

Source: api.js, line 543

(constant) UI_CORP_CASH_FLOW_PROJECTION

u i_ c o r p_ c a s h_ f l o w_ p r o j e c t i o n

Source: api.js, line 475

(constant) UI_CORP_COMMODITY_CONTRACTS_LIST

u i_ c o r p_ c o m m o d i t y_ c o n t r a c t s_ l i s t

Source: api.js, line 495

(constant) UI_CORP_EARNINGS_REPORT

u i_ c o r p_ e a r n i n g s_ r e p o r t

Source: api.js, line 499

(constant) UI_CORP_FINANCIAL_PROFILE

u i_ c o r p_ f i n a n c i a l_ p r o f i l e

Source: api.js, line 467

(constant) UI_CORP_HOLDINGS

u i_ c o r p_ h o l d i n g s

Source: api.js, line 559

(constant) UI_CORP_OPTIONS_PORTFOLIO

u i_ c o r p_ o p t i o n s_ p o r t f o l i o

Source: api.js, line 487

(constant) UI_CORP_OVERVIEW

u i_ c o r p_ o v e r v i e w

Source: api.js, line 567

(constant) UI_CORP_RESEARCH_REPORT

u i_ c o r p_ r e s e a r c h_ r e p o r t

Source: api.js, line 479

(constant) UI_CORP_SHAREHOLDERS_LIST

u i_ c o r p_ s h a r e h o l d e r s_ l i s t

Source: api.js, line 491

(constant) UI_CORP_STOCKS_BONDS_PORTFOLIO

u i_ c o r p_ s t o c k s_ b o n d s_ p o r t f o l i o

Source: api.js, line 483

(constant) UI_CORP_SWAPS_PORTFOLIO

u i_ c o r p_ s w a p s_ p o r t f o l i o

Source: api.js, line 547

(constant) UI_DB_SEARCH

u i_ d b_ s e a r c h

Source: api.js, line 555

(constant) UI_INDUSTRIES_HEATMAP

u i_ i n d u s t r i e s_ h e a t m a p

Source: api.js, line 539

(constant) UI_INDUSTRY_HEATMAP

u i_ i n d u s t r y_ h e a t m a p

Source: api.js, line 535

(constant) UI_INDUSTRY_PROJECTIONS_REPORT

u i_ i n d u s t r y_ p r o j e c t i o n s_ r e p o r t

Source: api.js, line 463

(constant) UI_INDUSTRY_SUMMARY_REPORT

u i_ i n d u s t r y_ s u m m a r y_ r e p o r t

Source: api.js, line 459

(constant) UI_MARKET_HEATMAP

u i_ m a r k e t_ h e a t m a p

Source: api.js, line 531

(constant) UI_MARKET_REPORTS_COMMOD_FUTURES_REPORT

u i_ m a r k e t_ r e p o r t s_ c o m m o d_ f u t u r e s_ r e p o r t

Source: api.js, line 403

(constant) UI_MARKET_REPORTS_COMMOD_PHYSICAL_REPORT

u i_ m a r k e t_ r e p o r t s_ c o m m o d_ p h y s i c a l_ r e p o r t

Source: api.js, line 407

(constant) UI_MARKET_REPORTS_ECON_STATS_REPORT

u i_ m a r k e t_ r e p o r t s_ e c o n_ s t a t s_ r e p o r t

Source: api.js, line 447

(constant) UI_MARKET_REPORTS_INDUSTRY_GROWTH_RATES_REPORT

u i_ m a r k e t_ r e p o r t s_ i n d u s t r y_ g r o w t h_ r a t e s_ r e p o r t

Source: api.js, line 427

(constant) UI_MARKET_REPORTS_INTEREST_RATES_REPORT

u i_ m a r k e t_ r e p o r t s_ i n t e r e s t_ r a t e s_ r e p o r t

Source: api.js, line 451

(constant) UI_MARKET_REPORTS_INTEREST_RATE_SWAPS_REPORT

u i_ m a r k e t_ r e p o r t s_ i n t e r e s t_ r a t e_ s w a p s_ r e p o r t

Source: api.js, line 415

(constant) UI_MARKET_REPORTS_INVESTMENT_CONTRACTS_REPORT

u i_ m a r k e t_ r e p o r t s_ i n v e s t m e n t_ c o n t r a c t s_ r e p o r t

Source: api.js, line 423

(constant) UI_MARKET_REPORTS_LARGEST_MARKET_SHARE_REPORT

u i_ m a r k e t_ r e p o r t s_ l a r g e s t_ m a r k e t_ s h a r e_ r e p o r t

Source: api.js, line 431

(constant) UI_MARKET_REPORTS_LARGEST_TAX_LOSSES_REPORT

u i_ m a r k e t_ r e p o r t s_ l a r g e s t_ t a x_ l o s s e s_ r e p o r t

Source: api.js, line 435

(constant) UI_MARKET_REPORTS_MOST_CASH_REPORT

u i_ m a r k e t_ r e p o r t s_ m o s t_ c a s h_ r e p o r t

Source: api.js, line 439

(constant) UI_MARKET_REPORTS_MOST_MARKET_CAP_REPORT

u i_ m a r k e t_ r e p o r t s_ m o s t_ m a r k e t_ c a p_ r e p o r t

Source: api.js, line 443

(constant) UI_MARKET_REPORTS_OPTIONS_REPORT

u i_ m a r k e t_ r e p o r t s_ o p t i o n s_ r e p o r t

Source: api.js, line 411

(constant) UI_MARKET_REPORTS_STOCKS_REPORT

u i_ m a r k e t_ r e p o r t s_ s t o c k s_ r e p o r t

Source: api.js, line 419

(constant) UI_MARKET_REPORTS_WHO_AHEAD_REPORT

u i_ m a r k e t_ r e p o r t s_ w h o_ a h e a d_ r e p o r t

Source: api.js, line 455

(constant) UI_PLAYER_ADVANCES_LIST

u i_ p l a y e r_ a d v a n c e s_ l i s t

Source: api.js, line 527

(constant) UI_PLAYER_CASH_FLOW_PROJECTION

u i_ p l a y e r_ c a s h_ f l o w_ p r o j e c t i o n

Source: api.js, line 507

(constant) UI_PLAYER_COMMODITY_CONTRACTS_LIST

u i_ p l a y e r_ c o m m o d i t y_ c o n t r a c t s_ l i s t

Source: api.js, line 523

(constant) UI_PLAYER_CORPORATIONS_LIST

u i_ p l a y e r_ c o r p o r a t i o n s_ l i s t

Source: api.js, line 519

(constant) UI_PLAYER_FINANCIAL_PROFILE

u i_ p l a y e r_ f i n a n c i a l_ p r o f i l e

Source: api.js, line 503

(constant) UI_PLAYER_HOLDINGS

u i_ p l a y e r_ h o l d i n g s

Source: api.js, line 563

(constant) UI_PLAYER_OPTIONS_PORTFOLIO

u i_ p l a y e r_ o p t i o n s_ p o r t f o l i o

Source: api.js, line 515

(constant) UI_PLAYER_STOCKS_BONDS_PORTFOLIO

u i_ p l a y e r_ s t o c k s_ b o n d s_ p o r t f o l i o

Source: api.js, line 511

(constant) UI_PLAYER_SWAPS_PORTFOLIO

u i_ p l a y e r_ s w a p s_ p o r t f o l i o

Source: api.js, line 551

(constant) WHEAT_ID

w h e a t_ i d

Source: api.js, line 366

(constant) WSRContext

w s r context

Source: api.js, line 2599

(constant) bridgeReady :Promise.<void>

Promise that resolves when the backend bridge ports are discovered. All API calls internally await this before making network requests.

Type:

Promise.<void>

Source: api.js, line 41

(constant) commandMap

Command map

Source: api.js, line 2472

(constant) gameStore

Game store

Source: api.js, line 2604

(constant) getApiBase

Returns the currently configured REST API base URL. Returns `null` until the bridge handshake completes.

Source: api.js, line 48

(constant) getWsUrl

Returns the currently configured WebSocket URL. Returns `null` until the bridge handshake completes.

Source: api.js, line 55

(constant) useWSRContext

Use w s r context

Source: api.js, line 2686

Methods

WSRProvider({)

w s r provider

Parameters:

Name	Type	Description
`{`	any	children }

Source: api.js, line 2641

advanceFunds(actingAsIdopt) → {Promise.<any>}

Advance funds

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1663

Returns:

Type:: Promise.<any>

advanceTicker() → {Promise.<any>}

Advance ticker

Source: api.js, line 1019

Returns:

Type:: Promise.<any>

advancedOptionsTrading(actingAsIdopt) → {Promise.<any>}

Advanced options trading

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1429

Returns:

Type:: Promise.<any>

antitrustLawsuit(id, actingAsIdopt) → {Promise.<any>}

Antitrust lawsuit

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1859

Returns:

Type:: Promise.<any>

autoAddSelect() → {Promise.<any>}

Auto add select

Source: api.js, line 1945

Returns:

Type:: Promise.<any>

autosaveSelect() → {Promise.<any>}

Autosave select

Source: api.js, line 1900

Returns:

Type:: Promise.<any>

becomeEtfAdvisor(actingAsIdopt) → {Promise.<any>}

Become etf advisor

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1542

Returns:

Type:: Promise.<any>

borrowMoney(actingAsIdopt) → {Promise.<any>}

Borrow money

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1651

Returns:

Type:: Promise.<any>

buildDictRegex(allCompanies, allIndustries)

Build dict regex

Parameters:

Name	Type	Description
`allCompanies`	any
`allIndustries`	string

Source: api.js, line 839

buyBankLoans() → {Promise.<any>}

Buy bank loans

Source: api.js, line 1727

Returns:

Type:: Promise.<any>

buyBusinessLoans(actingAsIdopt) → {Promise.<any>}

Buy business loans

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1733

Returns:

Type:: Promise.<any>

buyCalls(id, actingAsIdopt, underlyingIdopt) → {Promise.<any>}

Buy calls

Parameters:

Name	Type	Attributes	Default
`id`	number
`actingAsId`	number	<optional>	0
`underlyingId`	number	<optional>	0

Source: api.js, line 1399

Returns:

Type:: Promise.<any>

buyCommodityFutures(id, actingAsIdopt) → {Promise.<any>}

Buy commodity futures

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1309

Returns:

Type:: Promise.<any>

buyConsumerLoans(actingAsIdopt) → {Promise.<any>}

Buy consumer loans

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1745

Returns:

Type:: Promise.<any>

buyCorporateAssets(actingAsIdopt) → {Promise.<any>}

Buy corporate assets

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1499

Returns:

Type:: Promise.<any>

buyCorporateBond(id, actingAsIdopt) → {Promise.<any>}

Buy corporate bond

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1269

Returns:

Type:: Promise.<any>

buyCryptoFutures(id, actingAsIdopt) → {Promise.<any>}

Buy crypto futures

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1382

Returns:

Type:: Promise.<any>

buyLongGovtBonds(actingAsIdopt) → {Promise.<any>}

Buy long govt bonds

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1282

Returns:

Type:: Promise.<any>

buyPhysicalCommodity(id, actingAsIdopt) → {Promise.<any>}

Buy physical commodity

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1353

Returns:

Type:: Promise.<any>

buyPhysicalCrypto(id, actingAsIdopt) → {Promise.<any>}

Buy physical crypto

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1369

Returns:

Type:: Promise.<any>

buyPrimeMortgages(actingAsIdopt) → {Promise.<any>}

Buy prime mortgages

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1757

Returns:

Type:: Promise.<any>

buyPuts(id, actingAsIdopt, underlyingIdopt) → {Promise.<any>}

Buy puts

Parameters:

Name	Type	Attributes	Default
`id`	number
`actingAsId`	number	<optional>	0
`underlyingId`	number	<optional>	0

Source: api.js, line 1415

Returns:

Type:: Promise.<any>

buyShortGovtBonds(actingAsIdopt) → {Promise.<any>}

Buy short govt bonds

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1294

Returns:

Type:: Promise.<any>

buyStock(id, actingAsIdopt) → {Promise.<any>}

Buy stock

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1236

Returns:

Type:: Promise.<any>

buySubprimeMortgages(actingAsIdopt) → {Promise.<any>}

Buy subprime mortgages

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1769

Returns:

Type:: Promise.<any>

callInAdvance(id) → {Promise.<any>}

Call in advance

Parameters:

Name	Type	Description
`id`	number

Source: api.js, line 1669

Returns:

Type:: Promise.<any>

callInLoan(id) → {Promise.<any>}

Call in loan

Parameters:

Name	Type	Description
`id`	number

Source: api.js, line 1722

Returns:

Type:: Promise.<any>

capitalContribution(actingAsIdopt) → {Promise.<any>}

Capital contribution

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1583

Returns:

Type:: Promise.<any>

changeActingAs(id) → {Promise.<any>}

Change acting as

Parameters:

Name	Type	Description
`id`	number

Source: api.js, line 2426

Returns:

Type:: Promise.<any>

changeBank(actingAsIdopt) → {Promise.<any>}

Change bank

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1716

Returns:

Type:: Promise.<any>

changeLawFirm(actingAsIdopt) → {Promise.<any>}

Change law firm

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1814

Returns:

Type:: Promise.<any>

changeManagers(actingAsIdopt) → {Promise.<any>}

Change managers

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1469

Returns:

Type:: Promise.<any>

cheatAddCash() → {Promise.<any>}

Cheat add cash

Source: api.js, line 1990

Returns:

Type:: Promise.<any>

cheatDisableLawsuits() → {Promise.<any>}

Cheat Menu

Source: api.js, line 1975

Returns:

Type:: Promise.<any>

cheatEarningsInfo() → {Promise.<any>}

Cheat earnings info

Source: api.js, line 1985

Returns:

Type:: Promise.<any>

cheatMergerInfo() → {Promise.<any>}

Cheat merger info

Source: api.js, line 1980

Returns:

Type:: Promise.<any>

checkScoreboard() → {Promise.<any>}

Check scoreboard

Source: api.js, line 1150

Returns:

Type:: Promise.<any>

clearChart() → {Promise.<any>}

Clear chart

Source: api.js, line 1825

Returns:

Type:: Promise.<any>

clearEventString() → {Promise.<any>}

Clear event string

Source: api.js, line 979

Returns:

Type:: Promise.<any>

clearStreamList() → {Promise.<any>}

Clear stream list

Source: api.js, line 1835

Returns:

Type:: Promise.<any>

closeLongCommodityFuturesBySlot(slot, actingAsIdopt) → {Promise.<any>}

Close long commodity futures by slot

Parameters:

Name	Type	Attributes	Default	Description
`slot`	any
`actingAsId`	number	<optional>	0

Source: api.js, line 1323

Returns:

Type:: Promise.<any>

closeModal(result) → {Promise.<any>}

Close modal

Parameters:

Name	Type	Description
`result`	any

Source: api.js, line 2089

Returns:

Type:: Promise.<any>

coverShortCommodityFutures(id, actingAsIdopt) → {Promise.<any>}

Cover short commodity futures

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1337

Returns:

Type:: Promise.<any>

coverShortCommodityFuturesBySlot(slot, actingAsIdopt) → {Promise.<any>}

Cover short commodity futures by slot

Parameters:

Name	Type	Attributes	Default	Description
`slot`	any
`actingAsId`	number	<optional>	0

Source: api.js, line 1344

Returns:

Type:: Promise.<any>

coverShortStock(id, actingAsIdopt) → {Promise.<any>}

Cover short stock

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1260

Returns:

Type:: Promise.<any>

createPriceAlert(entityId, direction, targetPrice) → {Promise.<any>}

Create price alert

Parameters:

Name	Type	Description
`entityId`	number
`direction`	any
`targetPrice`	any

Source: api.js, line 2149

Returns:

Type:: Promise.<any>

creditInfo(actingAsIdopt) → {Promise.<any>}

Credit info

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1820

Returns:

Type:: Promise.<any>

currencySelect() → {Promise.<any>}

Currency select

Source: api.js, line 1885

Returns:

Type:: Promise.<any>

cycleActingAs(direction)

Cycle acting-as to next/previous controlled company

Parameters:

Name	Type	Description
`direction`	any

Source: api.js, line 2434

dbResearchTool() → {Promise.<any>}

Db research tool

Source: api.js, line 2033

Returns:

Type:: Promise.<any>

debounce(fn, delay)

Debounce

Parameters:

Name	Type	Description
`fn`	any
`delay`	any

Source: api.js, line 2693

decreaseEarnings(actingAsIdopt) → {Promise.<any>}

Decrease earnings

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1800

Returns:

Type:: Promise.<any>

deletePriceAlert(slot) → {Promise.<any>}

Delete price alert

Parameters:

Name	Type	Description
`slot`	any

Source: api.js, line 2167

Returns:

Type:: Promise.<any>

deleteSave(filename) → {Promise.<any>}

Delete a save file (via IPC to main process)

Parameters:

Name	Type	Description
`filename`	string

Source: api.js, line 1072

Returns:

Type:: Promise.<any>

diffObjects(oldObj, newObj, pathopt)

Diff objects

Parameters:

Name	Type	Attributes	Default
`oldObj`	any
`newObj`	any
`path`	any	<optional>	[]

Source: api.js, line 2711

disableHotkeysSelect() → {Promise.<any>}

Disable hotkeys select

Source: api.js, line 1940

Returns:

Type:: Promise.<any>

economicStats() → {Promise.<any>}

Economic stats

Source: api.js, line 2038

Returns:

Type:: Promise.<any>

electCeo(actingAsIdopt) → {Promise.<any>}

Elect ceo

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1457

Returns:

Type:: Promise.<any>

exerciseCallOptionsEarly(id, actingAsIdopt) → {Promise.<any>}

Exercise call options early

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1436

Returns:

Type:: Promise.<any>

exercisePutOptionsEarly(id, actingAsIdopt) → {Promise.<any>}

Exercise put options early

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1443

Returns:

Type:: Promise.<any>

exerciseSelect() → {Promise.<any>}

Exercise select

Source: api.js, line 1905

Returns:

Type:: Promise.<any>

exitGame() → {Promise.<any>}

Exit game

Source: api.js, line 1108

Returns:

Type:: Promise.<any>

exitToDesktop() → {Promise.<any>}

Exit to desktop

Source: api.js, line 1117

Returns:

Type:: Promise.<any>

extraordinaryDividend(actingAsIdopt) → {Promise.<any>}

Extraordinary dividend

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1613

Returns:

Type:: Promise.<any>

fillStreamList() → {Promise.<any>}

Fill stream list

Source: api.js, line 1840

Returns:

Type:: Promise.<any>

formatThousandsPreserveCaret(e, formatFn)

Format thousands preserve caret

Parameters:

Name	Type	Description
`e`	any
`formatFn`	any

Source: api.js, line 2794

freezeAllLoans(actingAsIdopt) → {Promise.<any>}

Freeze all loans

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1786

Returns:

Type:: Promise.<any>

freezeLoan(id) → {Promise.<any>}

Freeze loan

Parameters:

Name	Type	Description
`id`	number

Source: api.js, line 1792

Returns:

Type:: Promise.<any>

getAssetChart(id) → {Promise.<any>}

Get asset chart

Parameters:

Name	Type	Description
`id`	number

Source: api.js, line 1168

Returns:

Type:: Promise.<any>

getCompanyBySymbol(allCompanies, symbol) → {object|undefined}

Returns the company object for a given ticker symbol.

Parameters:

Name	Type	Description
`allCompanies`	Array.<object>	List of companies from gameState
`symbol`	string	Ticker symbol

Source: api.js, line 801

Returns:

Type:: object | undefined

getDatabaseData() → {Promise.<any>}

Fetch database search data.

Source: api.js, line 755

Returns:

Type:: Promise.<any>

getGameState()

Get game state

Source: api.js, line 974

getIndustry(allIndustries, industryNum) → {object|undefined}

Returns the industry object for a given industry ID.

Parameters:

Name	Type	Description
`allIndustries`	Array.<object>	List of industries from gameState
`industryNum`	number	Industry ID

Source: api.js, line 811

Returns:

Type:: object | undefined

getJSON(path) → {Promise.<any>}

Dispatches a GET request and returns the parsed JSON response.

Parameters:

Name	Type	Description
`path`	string	REST endpoint path

Source: api.js, line 732

Returns:

Type:: Promise.<any>

getOwnershipTree() → {Promise.<any>}

Fetch ownership tree (who owns the active entity).

Source: api.js, line 763

Returns:

Type:: Promise.<any>

getQuoteOfTheDay() → {Promise.<any>}

Get quote of the day

Source: api.js, line 1155

Returns:

Type:: Promise.<any>

getSubsidiariesTree() → {Promise.<any>}

Fetch subsidiaries tree (what the active entity owns).

Source: api.js, line 771

Returns:

Type:: Promise.<any>

goBack() → {Promise.<any>}

Go back

Source: api.js, line 2387

Returns:

Type:: Promise.<any>

goForward() → {Promise.<any>}

Go forward

Source: api.js, line 2395

Returns:

Type:: Promise.<any>

gotoPage(p) → {Promise.<any>}

Goto page

Parameters:

Name	Type	Description
`p`	any

Source: api.js, line 2378

Returns:

Type:: Promise.<any>

greenmail(targetIdopt, actingAsIdopt) → {Promise.<any>}

Greenmail

Parameters:

Name	Type	Attributes	Default	Description
`targetId`	number	<optional>	0
`actingAsId`	number	<optional>	0

Source: api.js, line 1564

Returns:

Type:: Promise.<any>

growthThrottle() → {Promise.<any>}

Growth throttle

Source: api.js, line 1830

Returns:

Type:: Promise.<any>

harrassingLawsuit(id, actingAsIdopt) → {Promise.<any>}

Harrassing lawsuit

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1867

Returns:

Type:: Promise.<any>

increaseEarnings(actingAsIdopt) → {Promise.<any>}

Increase earnings

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1806

Returns:

Type:: Promise.<any>

industryProjections() → {Promise.<any>}

Industry projections

Source: api.js, line 2063

Returns:

Type:: Promise.<any>

industrySummary() → {Promise.<any>}

Industry summary

Source: api.js, line 2058

Returns:

Type:: Promise.<any>

interestRateSwaps(assetIdopt, actingAsIdopt) → {Promise.<any>}

Interest rate swaps

Parameters:

Name	Type	Attributes	Default	Description
`assetId`	number	<optional>	0
`actingAsId`	number	<optional>	0

Source: api.js, line 1676

Returns:

Type:: Promise.<any>

isDifferent(oldObj, newObj)

Is different

Parameters:

Name	Type	Description
`oldObj`	any
`newObj`	any

Source: api.js, line 2782

isPlayerCEO(chairedCompanyId, entityId) → {boolean}

Checks if the player is the CEO of a company.

Parameters:

Name	Type	Description
`chairedCompanyId`	number	player.chairedCompanyId from gameState
`entityId`	number	ID to check

Source: api.js, line 791

Returns:

Type:: boolean

isPlayerControlled(controlledCompanies, entityId) → {boolean}

Checks if an entity is controlled by the player.

Parameters:

Name	Type	Description
`controlledCompanies`	Array.<object>	List of companies from gameState
`entityId`	number	ID to check

Source: api.js, line 781

Returns:

Type:: boolean

isValidWindowsFilename(filename)

Validate Windows filename (no invalid characters)

Parameters:

Name	Type	Description
`filename`	string

Source: api.js, line 1098

issueNewCorpBonds(actingAsIdopt) → {Promise.<any>}

Issue new corp bonds

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1601

Returns:

Type:: Promise.<any>

largestMarketCap() → {Promise.<any>}

Largest market cap

Source: api.js, line 2048

Returns:

Type:: Promise.<any>

largestTaxLosses() → {Promise.<any>}

Largest tax losses

Source: api.js, line 2053

Returns:

Type:: Promise.<any>

lbo(targetIdopt, actingAsIdopt) → {Promise.<any>}

Lbo

Parameters:

Name	Type	Attributes	Default	Description
`targetId`	number	<optional>	0
`actingAsId`	number	<optional>	0

Source: api.js, line 1571

Returns:

Type:: Promise.<any>

listBankLoans(actingAsIdopt) → {Promise.<any>}

List bank loans

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1710

Returns:

Type:: Promise.<any>

listEtfs() → {Promise.<any>}

List etfs

Source: api.js, line 1780

Returns:

Type:: Promise.<any>

listSaves() → {Promise.<any>}

List available save files (via IPC to main process)

Source: api.js, line 1063

Returns:

Type:: Promise.<any>

loadGame() → {Promise.<any>}

Load game

Source: api.js, line 1027

Returns:

Type:: Promise.<any>

loadSpecificSave(filename) → {Promise.<any>}

Load a specific save file by triggering the backend load event

Parameters:

Name	Type	Description
`filename`	string

Source: api.js, line 1081

Returns:

Type:: Promise.<any>

makedeliverySelect() → {Promise.<any>}

Makedelivery select

Source: api.js, line 1915

Returns:

Type:: Promise.<any>

mergeGameState(newState)

Merge new game state from polling, preserving local tutorial changes until backend catches up

Parameters:

Name	Type	Description
`newState`	any

Source: api.js, line 2219

merger(targetIdopt, actingAsIdopt) → {Promise.<any>}

Merger

Parameters:

Name	Type	Attributes	Default	Description
`targetId`	number	<optional>	0
`actingAsId`	number	<optional>	0

Source: api.js, line 1557

Returns:

Type:: Promise.<any>

modalResult(result) → {Promise.<any>}

Modal result

Parameters:

Name	Type	Description
`result`	any

Source: api.js, line 2095

Returns:

Type:: Promise.<any>

mostCashReport() → {Promise.<any>}

Most cash report

Source: api.js, line 2043

Returns:

Type:: Promise.<any>

navGotoIndex(index) → {Promise.<any>}

Nav goto index

Parameters:

Name	Type	Description
`index`	any

Source: api.js, line 2404

Returns:

Type:: Promise.<any>

navSetHistory(entries) → {Promise.<any>}

Restore nav history from localStorage — called on game load. entries: [{id, type}] ordered most-recent-first.

Parameters:

Name	Type	Description
`entries`	any

Source: api.js, line 2413

Returns:

Type:: Promise.<any>

newGame() → {Promise.<any>}

New game

Source: api.js, line 1034

Returns:

Type:: Promise.<any>

openMarketHeatMap() → {Promise.<any>}

Open market heat map

Source: api.js, line 2329

Returns:

Type:: Promise.<any>

postIdArg(path, id) → {Promise.<any>}

Dispatches a POST request with a single "id" integer argument.

Parameters:

Name	Type	Description
`path`	string	REST endpoint path
`id`	number	Entity ID or numeric parameter

Source: api.js, line 605

Returns:

Parsed JSON response from backend

Type:: Promise.<any>

postIdArgWithActingAs(path, id, actingAsIdopt) → {Promise.<any>}

Variant of postIdArg that optionally includes an acting-as entity override. If actingAsId > 0, the backend switches context before executing the command.

Parameters:

Name	Type	Attributes	Default	Description
`path`	string			REST endpoint path
`id`	number			Entity ID
`actingAsId`	number	<optional>	0	Entity to act as (0 for current view entity)

Source: api.js, line 646

Returns:

Parsed JSON response

Type:: Promise.<any>

postNoArg(path) → {Promise.<string>}

Dispatches a POST request with no arguments (empty JSON body). Automatically routes to REST or IPC based on current mode.

Parameters:

Name	Type	Description
`path`	string	REST endpoint path (e.g. "/start_ticker")

Source: api.js, line 575

Returns:

Response text from backend

Type:: Promise.<string>

postOptionsTradeWithActingAs(path, id, actingAsIdopt, underlyingIdopt) → {Promise.<any>}

Variant for options-trade endpoints (buy/sell calls/puts). Same shape as postIdArgWithActingAs, plus an optional `underlyingId`: when id=0 and underlyingId>0, the C++ bridge stashes it in strParam1 and PB uses it as TGT — skipping SelectCompanyModal$. Lets CLI "CALL ABC" resolve the symbol up front without colliding with IntParam1's ContractNum& semantics.

Parameters:

Name	Type	Attributes	Default
`path`	any
`id`	number
`actingAsId`	number	<optional>	0
`underlyingId`	number	<optional>	0

Source: api.js, line 674

Returns:

Type:: Promise.<any>

postStringArg(path, str) → {Promise.<any>}

Post string arg

Parameters:

Name	Type	Description
`path`	any
`str`	string

Source: api.js, line 703

Returns:

Type:: Promise.<any>

prepayTaxes(actingAsIdopt) → {Promise.<any>}

Prepay taxes

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1451

Returns:

Type:: Promise.<any>

privateStockOffering(actingAsIdopt) → {Promise.<any>}

Private stock offering

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1595

Returns:

Type:: Promise.<any>

publicStockOffering(actingAsIdopt) → {Promise.<any>}

Public stock offering

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1589

Returns:

Type:: Promise.<any>

rebrand(actingAsIdopt) → {Promise.<any>}

Rebrand

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1524

Returns:

Type:: Promise.<any>

redeemCorpBonds(actingAsIdopt) → {Promise.<any>}

Redeem corp bonds

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1607

Returns:

Type:: Promise.<any>

renderHyperlinks(headline, onClick, regex)

Render hyperlinks

Parameters:

Name	Type	Description
`headline`	any
`onClick`	any
`regex`	any

Source: api.js, line 923

repayLoan(actingAsIdopt) → {Promise.<any>}

Repay loan

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1657

Returns:

Type:: Promise.<any>

resignAsCeo(actingAsIdopt) → {Promise.<any>}

Resign as ceo

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1463

Returns:

Type:: Promise.<any>

restructure(actingAsIdopt) → {Promise.<any>}

Restructure

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1493

Returns:

Type:: Promise.<any>

reverseSplitStock(actingAsIdopt) → {Promise.<any>}

Reverse split stock

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1643

Returns:

Type:: Promise.<any>

runTicker() → {Promise.<any>}

Run ticker

Source: api.js, line 996

Returns:

Type:: Promise.<any>

saveGame() → {Promise.<any>}

Save game

Source: api.js, line 1041

Returns:

Type:: Promise.<any>

saveGameAs(filename) → {Promise.<any>}

Save game as

Parameters:

Name	Type	Description
`filename`	string

Source: api.js, line 1047

Returns:

Type:: Promise.<any>

sellBusinessLoan(id) → {Promise.<any>}

Sell business loan

Parameters:

Name	Type	Description
`id`	number

Source: api.js, line 1739

Returns:

Type:: Promise.<any>

sellCalls(id, actingAsIdopt, underlyingIdopt) → {Promise.<any>}

Sell calls

Parameters:

Name	Type	Attributes	Default
`id`	number
`actingAsId`	number	<optional>	0
`underlyingId`	number	<optional>	0

Source: api.js, line 1407

Returns:

Type:: Promise.<any>

sellCommodityFutures(id, actingAsIdopt) → {Promise.<any>}

Sell commodity futures

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1316

Returns:

Type:: Promise.<any>

sellConsumerLoans(actingAsIdopt) → {Promise.<any>}

Sell consumer loans

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1751

Returns:

Type:: Promise.<any>

sellCorporateAssets(actingAsIdopt) → {Promise.<any>}

Sell corporate assets

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1505

Returns:

Type:: Promise.<any>

sellCorporateBond(id, actingAsIdopt) → {Promise.<any>}

Sell corporate bond

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1276

Returns:

Type:: Promise.<any>

sellCryptoFutures(id, actingAsIdopt) → {Promise.<any>}

Sell crypto futures

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1389

Returns:

Type:: Promise.<any>

sellLongGovtBonds(actingAsIdopt) → {Promise.<any>}

Sell long govt bonds

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1288

Returns:

Type:: Promise.<any>

sellPhysicalCommodity(id, actingAsIdopt) → {Promise.<any>}

Sell physical commodity

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1360

Returns:

Type:: Promise.<any>

sellPhysicalCrypto(id) → {Promise.<any>}

Sell physical crypto

Parameters:

Name	Type	Description
`id`	number

Source: api.js, line 1375

Returns:

Type:: Promise.<any>

sellPrimeMortgages(actingAsIdopt) → {Promise.<any>}

Sell prime mortgages

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1763

Returns:

Type:: Promise.<any>

sellPuts(id, actingAsIdopt, underlyingIdopt) → {Promise.<any>}

Sell puts

Parameters:

Name	Type	Attributes	Default
`id`	number
`actingAsId`	number	<optional>	0
`underlyingId`	number	<optional>	0

Source: api.js, line 1423

Returns:

Type:: Promise.<any>

sellShortGovtBonds(actingAsIdopt) → {Promise.<any>}

Sell short govt bonds

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1300

Returns:

Type:: Promise.<any>

sellStock(id, actingAsIdopt) → {Promise.<any>}

Sell stock

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1246

Returns:

Type:: Promise.<any>

sellSubprimeMortgages(actingAsIdopt) → {Promise.<any>}

Sell subprime mortgages

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1775

Returns:

Type:: Promise.<any>

sellSubsidiaryStock(id, actingAsIdopt) → {Promise.<any>}

Sell subsidiary stock

Parameters:

Name	Type	Attributes	Default	Description
`id`	number
`actingAsId`	number	<optional>	0

Source: api.js, line 1518

Returns:

Type:: Promise.<any>

serialize(obj)

Serialize

Parameters:

Name	Type	Description
`obj`	any

Source: api.js, line 2301

setActiveUIReport(uiId) → {Promise.<any>}

Set active u i report

Parameters:

Name	Type	Description
`uiId`	number

Source: api.js, line 1161

Returns:

Type:: Promise.<any>

setAdvisoryFee(actingAsIdopt) → {Promise.<any>}

Set advisory fee

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1548

Returns:

Type:: Promise.<any>

setBankAllocation(actingAsIdopt) → {Promise.<any>}

Set bank allocation

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1698

Returns:

Type:: Promise.<any>

setChartType(typeInt) → {Promise.<any>}

Per-machine UI prefs (PB persists to CFIG.WSR via WriteConfig)

Parameters:

Name	Type	Description
`typeInt`	any

Source: api.js, line 1952

Returns:

Type:: Promise.<any>

setCustomData(blob) → {Promise.<any>}

Set custom data

Parameters:

Name	Type	Description
`blob`	any

Source: api.js, line 2120

Returns:

Type:: Promise.<any>

setDividend(actingAsIdopt) → {Promise.<any>}

Set dividend

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1475

Returns:

Type:: Promise.<any>

setGrowthRate(actingAsIdopt) → {Promise.<any>}

Set growth rate

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1487

Returns:

Type:: Promise.<any>

setLocale(localeCode) → {Promise.<any>}

Set locale

Parameters:

Name	Type	Description
`localeCode`	any

Source: api.js, line 1958

Returns:

Type:: Promise.<any>

setProductivity(actingAsIdopt) → {Promise.<any>}

Set productivity

Parameters:

Name	Type	Attributes	Default	Description
`actingAsId`	number	<optional>	0

Source: api.js, line 1481

Returns:

Type:: Promise.<any>

setTickSpeed(speed) → {Promise.<any>}

Set tick speed

Parameters:

Name	Type	Description
`speed`	any

Source: api.js, line 1014

Returns:

Type:: Promise.<any>

setTutorialEnabled(enabled) → {Promise.<any>}

Set tutorial enabled

Parameters:

Name	Type	Description
`enabled`	any

Source: api.js, line 2206

Returns:

Type:: Promise.<any>

setTutorialStep(step) → {Promise.<any>}

Set tutorial step

Parameters:

Name	Type	Description
`step`	any

Source: api.js, line 2193

Returns:

Type:: Promise.<any>

setViewAsset(id) → {Promise.<any>}

Set view asset

Parameters:

Name	Type	Description
`id`	number

Source: api.js, line 2345

Returns:

Type:: Promise.<any>

setViewAssetWithTab(id, preferredTab) → {Promise.<any>}

Like setViewAsset but also sets a preferred tab so the destination view opens on the correct tab (e.g. "Stocks & Bonds" when drilling from Holdings). preferredTab is a string matching the tab label in IndustrialView / PlayerView. NOTE: the preferred tab is set AFTER the navigation REST call completes so that it lands in a separate render cycle and doesn't cause a simultaneous activeEntityNum + preferredTab state change, which previously caused rapid mount/unmount of heavy components (Holdings ↔ target tab) and an Oilpan OOM crash.

Parameters: