Jump to content
Main menu
Main menu
move to sidebar
hide
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
Special pages
Wall Street Raider Wiki
Search
Search
Appearance
Create account
Log in
Personal tools
Create account
Log in
Pages for logged out editors
learn more
Contributions
Talk
Editing
Modding
(section)
Page
Discussion
English
Read
Edit
View history
Tools
Tools
move to sidebar
hide
Actions
Read
Edit
View history
General
What links here
Related changes
Page information
Appearance
move to sidebar
hide
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== REST API reference == For third-party apps and direct integrations. Frontend mods should prefer <code>api.js</code> ([[#Calling the API from a frontend mod|§api.js]]). === Conventions === * '''Base URL:''' <code>http://127.0.0.1:<rest_port></code>. Read <code>rest_port</code> from <code>%LOCALAPPDATA%\Wall Street Raider\runtime.json</code>; ports change every launch. * '''Content-Type:''' <code>application/json</code> on all POSTs. * '''Generic body schema:''' the bridge accepts a single envelope <code>{ id?, intParam2?, underlyingId?, str?, answer?, value?, filename? }</code>. Each endpoint uses 0-3 of these fields with '''endpoint-specific meanings''' - the per-endpoint tables below spell out which fields are read and what they mean in context. * '''Omitted fields default to 0 / empty.''' Most action endpoints can be called as <code>{}</code> if they don't strictly need params (the engine often falls back to "use the currently active entity" or "show the picker modal"). * '''Most actions open a modal''' rather than executing immediately. After POSTing, the engine pushes a modal state via WS / <code>gameState.modalType</code>; respond with <code>POST /modal_result</code>. ==== The <code>actingAsId</code> pattern ==== Most corporate / trade endpoints accept an '''<code>actingAsId</code>''' (sent as the JSON field <code>intParam2</code>): the entity that '''executes''' the action. * <code>0</code> (or omitted) = act as the player. * Any other ID = act as that controlled company. The engine momentarily switches context, runs the action ''as that company'', then restores. When the per-endpoint tables below show <code>intParam2</code>, it means actingAsId unless noted otherwise. ==== Response shape ==== GET endpoints return endpoint-specific JSON (documented in the GET table). POST endpoints return <code>{ status: "ok" }</code> on success and a <code>{ error: "…" }</code> with HTTP 4xx/5xx on failure. Side effects show up via the next WS broadcast. === GET endpoints === {| class="wikitable" ! Method !! Endpoint !! Returns |- | GET || <code>/status</code> || health check |- | GET || <code>/gamestate</code> || full game-state JSON ([[#gameState reference|§gameState]]) |- | GET || <code>/quote</code> || <code>{ quote: string }</code> - quote of the day |- | POST || <code>/asset_chart</code> || body <code>{ id }</code>; returns 60 months of price history for an asset (<code>{ prices, highs, lows, xAxisTitle, yAxisTitle, baseMonth, baseYear }</code>) |- | GET || <code>/database_data</code> || searchable database of all companies (industry, financials, ratings, …) |- | GET || <code>/ownership_tree</code> || ownership hierarchy of the active entity (who owns it, at what %) |- | GET || <code>/subsidiaries_tree</code> || what the active entity owns (its subsidiaries, at what %) |} === Session / clock === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/newgame</code> || <code>{}</code> || Start a new game. |- | POST <code>/loadgame</code> || <code>{}</code> || Open the load-game flow. |- | POST <code>/load_specific_save</code> || <code>{ filename }</code> || Load a specific save. <code>filename</code> = save basename; must not contain <code>..</code>, <code>/</code>, <code>\</code>, <code>:</code>. |- | POST <code>/savegame</code> || <code>{}</code> || Save to the default slot. |- | POST <code>/savegameas</code> || <code>{ filename }</code> || Save under a name. Empty <code>filename</code> shows the Save-As dialog. |- | POST <code>/exit_game</code> || <code>{}</code> || Exit to main menu. |- | POST <code>/check_scoreboard</code> || <code>{}</code> || Open the scoreboard view. |- | POST <code>/start_ticker</code> || <code>{}</code> || Start the market ticker animations. |- | POST <code>/run_ticker</code> || <code>{}</code> || Advance the ticker by one queue item. |- | POST <code>/stop_ticker</code> || <code>{}</code> || Stop the ticker. |- | POST <code>/set_ticker_speed</code> || <code>{ id }</code> || Set ticker speed. <code>id</code> = speed enum. |- | POST <code>/ticker_advance</code> || <code>{}</code> || Pop the front of the ticker queue, append a new item. |- | POST <code>/clear_event_string</code> || <code>{}</code> || Clear the event message log. |- | POST <code>/splash_screen_played</code> || <code>{}</code> || Mark splash as shown so it's skipped next time. |} === Trading - stocks & bonds === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/buy_stock</code> || <code>{ id, intParam2? }</code> || Buy stock. <code>id</code> = company to buy. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_stock</code> || <code>{ id, intParam2? }</code> || Sell stock. <code>id</code> = company to sell. <code>intParam2</code> = actingAsId. |- | POST <code>/short_stock</code> || <code>{ id, intParam2? }</code> || Open short. <code>id</code> = company to short. <code>intParam2</code> = actingAsId. |- | POST <code>/cover_short_stock</code> || <code>{ id, intParam2? }</code> || Cover an existing short. <code>id</code> = company. <code>intParam2</code> = actingAsId. |- | POST <code>/buy_corporate_bond</code> || <code>{ id, intParam2? }</code> || Buy a corporate bond. <code>id</code> = issuing company. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_corporate_bond</code> || <code>{ id, intParam2? }</code> || Sell a corporate bond. <code>id</code> = issuing company. <code>intParam2</code> = actingAsId. |- | POST <code>/buy_long_govt_bonds</code> || <code>{ intParam2 }</code> || Buy long-term govt bonds. <code>intParam2</code> = actingAsId. <code>id</code> ignored. |- | POST <code>/sell_long_govt_bonds</code> || <code>{ intParam2 }</code> || Sell long-term govt bonds. <code>intParam2</code> = actingAsId. |- | POST <code>/buy_short_govt_bonds</code> || <code>{ intParam2 }</code> || Buy short-term govt bonds. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_short_govt_bonds</code> || <code>{ intParam2 }</code> || Sell short-term govt bonds. <code>intParam2</code> = actingAsId. |} === Trading - commodities & crypto === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/buy_commodity_futures</code> || <code>{ id, intParam2? }</code> || Buy commodity futures. <code>id</code> = commodity ID (e.g. <code>OIL_ID</code>, <code>GOLD_ID</code>). <code>intParam2</code> = actingAsId. |- | POST <code>/sell_commodity_futures</code> || <code>{ id, intParam2? }</code> || Sell commodity futures. <code>id</code> = commodity ID. <code>intParam2</code> = actingAsId. |- | POST <code>/close_long_commodity_futures_by_slot</code> || <code>{ id, intParam2? }</code> || Close a specific long position. <code>id</code> = '''portfolio slot index''' (not a commodity ID). <code>intParam2</code> = actingAsId. |- | POST <code>/short_commodity_futures</code> || <code>{ id, intParam2? }</code> || Short commodity futures. <code>id</code> = commodity ID. <code>intParam2</code> = actingAsId. |- | POST <code>/cover_short_commodity_futures</code> || <code>{ id, intParam2? }</code> || Cover commodity short. <code>id</code> = commodity ID. <code>intParam2</code> = actingAsId. |- | POST <code>/cover_short_commodity_futures_by_slot</code> || <code>{ id, intParam2? }</code> || Cover a specific short position. <code>id</code> = '''portfolio slot index'''. <code>intParam2</code> = actingAsId. |- | POST <code>/buy_physical_commodity</code> || <code>{ id, intParam2? }</code> || Buy physical commodity. <code>id</code> = commodity ID. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_physical_commodity</code> || <code>{ id, intParam2? }</code> || Sell physical commodity. <code>id</code> = commodity ID. <code>intParam2</code> = actingAsId. |- | POST <code>/buy_physical_crypto</code> || <code>{ id, intParam2? }</code> || Buy physical crypto. <code>id</code> = crypto ID (e.g. <code>BITCOIN_ID</code>). <code>intParam2</code> = actingAsId. |- | POST <code>/sell_physical_crypto</code> || <code>{ id }</code> || Sell physical crypto. <code>id</code> = crypto ID. (No actingAs param on this one.) |- | POST <code>/buy_crypto_futures</code> || <code>{ id, intParam2? }</code> || Buy crypto futures. <code>id</code> = crypto ID. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_crypto_futures</code> || <code>{ id, intParam2? }</code> || Sell crypto futures. <code>id</code> = crypto ID. <code>intParam2</code> = actingAsId. |} === Trading - options === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/buy_calls</code> || <code>{ id, intParam2?, underlyingId? }</code> || Buy calls. <code>id</code> = strike-price ID (or 0 to show the strike picker). <code>intParam2</code> = actingAsId. <code>underlyingId</code> = company being optioned (when <code>id>0</code> and <code>underlyingId>0</code>, modal is skipped — used by CLI flows like "CALL ABC"). |- | POST <code>/sell_calls</code> || <code>{ id, intParam2?, underlyingId? }</code> || Sell calls. Same param semantics as <code>/buy_calls</code>. |- | POST <code>/buy_puts</code> || <code>{ id, intParam2?, underlyingId? }</code> || Buy puts. Same param semantics as <code>/buy_calls</code>. |- | POST <code>/sell_puts</code> || <code>{ id, intParam2?, underlyingId? }</code> || Sell puts. Same param semantics as <code>/buy_calls</code>. |- | POST <code>/advanced_options_trading</code> || <code>{ intParam2 }</code> || Open the advanced options panel (spreads, collars). <code>intParam2</code> = actingAsId. |- | POST <code>/exercise_call_options_early</code> || <code>{ id, intParam2? }</code> || Exercise a call early. <code>id</code> = call contract ID. <code>intParam2</code> = actingAsId. |- | POST <code>/exercise_put_options_early</code> || <code>{ id, intParam2? }</code> || Exercise a put early. <code>id</code> = put contract ID. <code>intParam2</code> = actingAsId. |} === Corporate management === All of these operate on the acting-as entity. <code>id</code> is unused unless noted; pass <code>0</code> or omit. {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/prepay_taxes</code> || <code>{ intParam2 }</code> || Prepay taxes. <code>intParam2</code> = actingAsId. |- | POST <code>/elect_ceo</code> || <code>{ intParam2 }</code> || Open CEO-election picker for the entity. <code>intParam2</code> = actingAsId. |- | POST <code>/resign_as_ceo</code> || <code>{ intParam2 }</code> || Acting-as entity resigns as CEO. <code>intParam2</code> = actingAsId. |- | POST <code>/change_managers</code> || <code>{ intParam2 }</code> || Hire / fire managers. <code>intParam2</code> = actingAsId. |- | POST <code>/set_dividend</code> || <code>{ intParam2 }</code> || Set the company's dividend. <code>intParam2</code> = actingAsId (dividend issuer). |- | POST <code>/set_productivity</code> || <code>{ intParam2 }</code> || Set productivity. <code>intParam2</code> = actingAsId. |- | POST <code>/set_growth_rate</code> || <code>{ intParam2 }</code> || Set growth rate. <code>intParam2</code> = actingAsId. |- | POST <code>/restructure</code> || <code>{ intParam2 }</code> || Open restructuring modal. <code>intParam2</code> = actingAsId. |- | POST <code>/buy_corporate_assets</code> || <code>{ intParam2 }</code> || Buy plant / equipment. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_corporate_assets</code> || <code>{ intParam2 }</code> || Sell plant / equipment. <code>intParam2</code> = actingAsId. |- | POST <code>/offer_corporate_assets_for_sale</code> || <code>{ intParam2 }</code> || List assets for other entities to buy. <code>intParam2</code> = actingAsId. |- | POST <code>/view_for_sale_items</code> || <code>{ intParam2 }</code> || Browse assets currently for sale. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_subsidiary_stock</code> || <code>{ id, intParam2? }</code> || Sell stock the entity holds in a subsidiary. <code>id</code> = subsidiary company ID. <code>intParam2</code> = actingAsId (seller). |- | POST <code>/rebrand</code> || <code>{ intParam2 }</code> || Rename the company. <code>intParam2</code> = actingAsId. |- | POST <code>/toggle_company_autopilot</code> || <code>{ id }</code> || Toggle one company's autopilot. <code>id</code> = company. |- | POST <code>/toggle_global_autopilot</code> || <code>{ intParam2 }</code> || Toggle autopilot across all of the entity's holdings. <code>intParam2</code> = actingAsId. |- | POST <code>/become_etf_advisor</code> || <code>{ intParam2 }</code> || Become ETF advisor. <code>intParam2</code> = actingAsId. |- | POST <code>/set_advisory_fee</code> || <code>{ intParam2 }</code> || Set the ETF advisory fee. <code>intParam2</code> = actingAsId. |- | POST <code>/decrease_earnings</code> || <code>{ intParam2 }</code> || Accounting adjustment to lower reported earnings. <code>intParam2</code> = actingAsId. |- | POST <code>/increase_earnings</code> || <code>{ intParam2 }</code> || Accounting adjustment to raise reported earnings. <code>intParam2</code> = actingAsId. |} === M&A / corporate finance === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/merger</code> || <code>{ id, intParam2? }</code> || Start a merger. <code>id</code> = target company. <code>intParam2</code> = actingAsId (acquirer). |- | POST <code>/greenmail</code> || <code>{ id, intParam2? }</code> || Greenmail (coercive buyback). <code>id</code> = target. <code>intParam2</code> = actingAsId. |- | POST <code>/lbo</code> || <code>{ id, intParam2? }</code> || Leveraged buyout. <code>id</code> = target. <code>intParam2</code> = actingAsId. |- | POST <code>/startup</code> || <code>{ intParam2 }</code> || Found a new startup. <code>intParam2</code> = actingAsId (founder). |- | POST <code>/capital_contribution</code> || <code>{ intParam2 }</code> || Inject cash into a subsidiary. <code>intParam2</code> = actingAsId. |- | POST <code>/public_stock_offering</code> || <code>{ intParam2 }</code> || IPO. <code>intParam2</code> = actingAsId (company going public). |- | POST <code>/private_stock_offering</code> || <code>{ intParam2 }</code> || Private placement. <code>intParam2</code> = actingAsId. |- | POST <code>/issue_new_corp_bonds</code> || <code>{ intParam2 }</code> || Issue new corporate bonds. <code>intParam2</code> = actingAsId (issuer). |- | POST <code>/redeem_corp_bonds</code> || <code>{ intParam2 }</code> || Retire outstanding bonds. <code>intParam2</code> = actingAsId. |- | POST <code>/extraordinary_dividend</code> || <code>{ intParam2 }</code> || One-time special dividend. <code>intParam2</code> = actingAsId. |- | POST <code>/tax_free_liquidation</code> || <code>{ intParam2 }</code> || Liquidate with tax deferral. <code>intParam2</code> = actingAsId. |- | POST <code>/taxable_liquidation</code> || <code>{ intParam2 }</code> || Liquidate; pay tax on gains. <code>intParam2</code> = actingAsId. |- | POST <code>/spin_off</code> || <code>{ id, intParam2? }</code> || Spin off a subsidiary. <code>id</code> = subsidiary to spin off. <code>intParam2</code> = actingAsId (parent). |- | POST <code>/split_stock</code> || <code>{ intParam2 }</code> || Forward stock split. <code>intParam2</code> = actingAsId. |- | POST <code>/reverse_split_stock</code> || <code>{ intParam2 }</code> || Reverse stock split. <code>intParam2</code> = actingAsId. |} === Banking / loans / swaps === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/borrow_money</code> || <code>{ intParam2 }</code> || Take out a loan. <code>intParam2</code> = actingAsId (borrower). |- | POST <code>/repay_loan</code> || <code>{ intParam2 }</code> || Pay down / repay. <code>intParam2</code> = actingAsId. |- | POST <code>/advance_funds</code> || <code>{ intParam2 }</code> || Lender advances cash against securities. <code>intParam2</code> = actingAsId (lender). |- | POST <code>/call_in_advance</code> || <code>{ id }</code> || Terminate an advance. <code>id</code> = advance ID. |- | POST <code>/interest_rate_swaps</code> || <code>{ id, intParam2? }</code> || Open the swaps modal. <code>id</code> = asset ID. <code>intParam2</code> = actingAsId. |- | POST <code>/view_swap_details</code> || <code>{ id, intParam2? }</code> || View one swap's details. <code>id</code> = swap ID. <code>intParam2</code> = actingAsId. |- | POST <code>/terminate_swap</code> || <code>{ id, intParam2? }</code> || Terminate a swap early. <code>id</code> = swap ID. <code>intParam2</code> = actingAsId. |- | POST <code>/set_bank_allocation</code> || <code>{ intParam2 }</code> || Distribute cash across banks. <code>intParam2</code> = actingAsId. |- | POST <code>/trade_tbills</code> || <code>{ intParam2 }</code> || Trade T-bills. <code>intParam2</code> = actingAsId. |- | POST <code>/list_bank_loans</code> || <code>{ intParam2 }</code> || List the entity's outstanding bank loans (when acting as a bank). <code>intParam2</code> = actingAsId. |- | POST <code>/change_bank</code> || <code>{ intParam2 }</code> || Change primary bank. <code>intParam2</code> = actingAsId. |- | POST <code>/call_in_loan</code> || <code>{ id }</code> || Demand immediate repayment. <code>id</code> = loan ID. |- | POST <code>/buy_bank_loans</code> || <code>{}</code> || Open the bank-loans investment picker. |- | POST <code>/buy_business_loans</code> || <code>{ intParam2 }</code> || Buy business-loan portfolio. <code>intParam2</code> = actingAsId (investor). |- | POST <code>/sell_business_loan</code> || <code>{ id }</code> || Sell one business-loan holding. <code>id</code> = loan ID. |- | POST <code>/buy_consumer_loans</code> || <code>{ intParam2 }</code> || Buy consumer-loan portfolio. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_consumer_loans</code> || <code>{ intParam2 }</code> || Sell consumer-loan holdings. <code>intParam2</code> = actingAsId. |- | POST <code>/buy_prime_mortgages</code> || <code>{ intParam2 }</code> || Buy prime mortgages. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_prime_mortgages</code> || <code>{ intParam2 }</code> || Sell prime mortgages. <code>intParam2</code> = actingAsId. |- | POST <code>/buy_subprime_mortgages</code> || <code>{ intParam2 }</code> || Buy subprime mortgages. <code>intParam2</code> = actingAsId. |- | POST <code>/sell_subprime_mortgages</code> || <code>{ intParam2 }</code> || Sell subprime mortgages. <code>intParam2</code> = actingAsId. |- | POST <code>/list_etfs</code> || <code>{}</code> || Show available ETFs. |- | POST <code>/freeze_all_loans</code> || <code>{ intParam2 }</code> || Freeze all loan repayments across the lender's portfolio. <code>intParam2</code> = actingAsId. |- | POST <code>/freeze_loan</code> || <code>{ id }</code> || Freeze one specific loan. <code>id</code> = loan ID. |} === Legal / dirty tricks === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/change_law_firm</code> || <code>{ intParam2 }</code> || Hire a law firm. <code>intParam2</code> = actingAsId. |- | POST <code>/credit_info</code> || <code>{ intParam2 }</code> || Show credit info (rating, history). <code>intParam2</code> = actingAsId. |- | POST <code>/antitrust_lawsuit</code> || <code>{ id, intParam2? }</code> || Sue for antitrust. <code>id</code> = target company. <code>intParam2</code> = actingAsId (plaintiff). |- | POST <code>/harrassing_lawsuit</code> || <code>{ id, intParam2? }</code> || File a frivolous lawsuit. <code>id</code> = target. <code>intParam2</code> = actingAsId. |- | POST <code>/spread_rumors</code> || <code>{ id, intParam2? }</code> || Spread rumors to damage stock / reputation. <code>id</code> = target company. <code>intParam2</code> = actingAsId. |} === Reports / views / navigation === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/set_active_ui_report</code> || <code>{ id }</code> || Switch active report panel. <code>id</code> = a <code>UI_*</code> enum (see <code>api.js</code> constants). |- | POST <code>/set_view_asset</code> || <code>{ id }</code> || Navigate to a company / player. <code>id</code> = entity ID. Updates nav history. |- | POST <code>/set_view_industry</code> || <code>{ id }</code> || Navigate to an industry overview. <code>id</code> = industry index, or <code>-2</code> = trigger DB Search. |- | POST <code>/database_search</code> || <code>{}</code> || Open the database search interface. |- | POST <code>/clear_chart</code> || <code>{}</code> || Clear the active price chart. |- | POST <code>/growth_throttle</code> || <code>{}</code> || Open growth-throttle settings. |- | POST <code>/clear_stream_list</code> || <code>{}</code> || Clear the streaming-quotes watchlist. |- | POST <code>/fill_stream_list</code> || <code>{}</code> || Populate the streaming-quotes watchlist with defaults. |- | POST <code>/toggle_streaming_quote</code> || <code>{ id }</code> || Toggle live updates for one asset. <code>id</code> = company / asset. |- | POST <code>/nav_back</code> || <code>{}</code> || Nav history: back. |- | POST <code>/nav_forward</code> || <code>{}</code> || Nav history: forward. |- | POST <code>/nav_clear</code> || <code>{}</code> || Clear nav history. |- | POST <code>/nav_goto</code> || <code>{ id }</code> || Jump to a nav-history index. <code>id</code> = position in history stack. |- | POST <code>/nav_set_history</code> || JSON array || Restore nav history from saved state. Body = array of <code>{ id, type }</code> where <code>type</code> is <code>"asset"</code> or <code>"industry"</code>, most-recent-first. |- | POST <code>/set_who_owns_filter</code> || <code>{ value }</code> || Set the "who owns what" filter. <code>value</code> = filter enum. |- | POST <code>/view_current_interest_rates</code> || <code>{}</code> || Show current interest rates. |- | POST <code>/whos_ahead</code> || <code>{}</code> || Show the leaderboard. |- | POST <code>/db_research_tool</code> || <code>{}</code> || Open the research database tool. |- | POST <code>/economic_stats</code> || <code>{}</code> || Show macro stats. |- | POST <code>/most_cash_report</code> || <code>{}</code> || Most-cash leaderboard. |- | POST <code>/largest_market_cap</code> || <code>{}</code> || Market-cap leaderboard. |- | POST <code>/largest_tax_losses</code> || <code>{}</code> || Largest carried-forward tax losses. |- | POST <code>/industry_summary</code> || <code>{}</code> || Industry summary stats. |- | POST <code>/industry_projections</code> || <code>{}</code> || Industry growth / decline projections. |- | POST <code>/view_corp_assets_for_sale</code> || <code>{}</code> || All corporate assets currently for sale. |} === Settings / toggles === These all open a settings menu / cycle the toggle. No params except where noted. {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/supp_earn_select</code> || <code>{}</code> || Suppress earnings-warnings menu. |- | POST <code>/currency_select</code> || <code>{}</code> || Currency selection. |- | POST <code>/supp_warn_select</code> || <code>{}</code> || Suppress-warnings menu. |- | POST <code>/suppress_select</code> || <code>{}</code> || Suppress messages / alerts menu. |- | POST <code>/autosave_select</code> || <code>{}</code> || Autosave settings. |- | POST <code>/exercise_select</code> || <code>{}</code> || Auto-exercise options settings. |- | POST <code>/sweep_select</code> || <code>{}</code> || Cash-sweep settings. |- | POST <code>/makedelivery_select</code> || <code>{}</code> || Make-delivery settings (commodity/crypto). |- | POST <code>/takedelivery_select</code> || <code>{}</code> || Take-delivery settings. |- | POST <code>/tooltips_select</code> || <code>{}</code> || Tooltip enable / disable. |- | POST <code>/shareholdergraph_select</code> || <code>{}</code> || Shareholder-graph display settings. |- | POST <code>/disablehotkeys_select</code> || <code>{}</code> || Hotkey enable / disable. |- | POST <code>/autoadd_select</code> || <code>{}</code> || Auto-add-to-watchlist settings. |- | POST <code>/set_chart_type</code> || <code>{ id }</code> || Set chart style. <code>id</code> = chart type enum. |- | POST <code>/set_locale</code> || <code>{ str }</code> || Set UI locale. <code>str</code> = locale code (e.g. <code>"en-US"</code>, <code>"ja-JP"</code>). |} === Cheat menu === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/cheat_disable</code> || <code>{}</code> || Lock cheats off. |- | POST <code>/cheat_disable_lawsuits</code> || <code>{}</code> || Disable lawsuits entirely. |- | POST <code>/cheat_merger_info</code> || <code>{}</code> || Reveal hidden merger info. |- | POST <code>/cheat_earnings_info</code> || <code>{}</code> || Reveal earnings forecasts and hidden financials. |- | POST <code>/cheat_add_cash</code> || <code>{}</code> || Add a fixed amount of cash. (No "set cash to N" - this is fixed.) |} === Modals === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/close_modal</code> || <code>{}</code> || Close the current modal. |- | POST <code>/modal_result</code> || <code>{ answer }</code> or <code>{ str }</code> || Submit the player's modal response. Use <code>answer</code> for numeric / choice modals; <code>str</code> for text-entry modals. |} === Tutorial === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/set_tutorial_step</code> || <code>{ id }</code> || Jump tutorial to a step. <code>id</code> = step number. |- | POST <code>/set_tutorial_enabled</code> || <code>{ id }</code> || Enable / disable tutorial. <code>id</code> = <code>1</code> on, <code>0</code> off. |} === Price alerts === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/show_price_alerts</code> || <code>{}</code> || Open the alerts management dialog. |- | POST <code>/create_price_alert</code> || <code>{ str }</code> || Create an alert. <code>str</code> = pipe-delimited <code>"entityId|direction|targetPrice"</code>; direction is <code>"up"</code> or <code>"down"</code>. |- | POST <code>/delete_price_alert</code> || <code>{ id }</code> || Delete one alert. <code>id</code> = alert slot index. |} === CustomData === {| class="wikitable" ! Endpoint !! Body !! Description |- | POST <code>/set_custom_data</code> || JSON object || Shallow-merge mod data into <code>customData</code>. See [[#CustomData - your persistent storage|§CustomData]]. |}
Summary:
Please note that all contributions to Wall Street Raider Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Wall Street Raider Wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Search
Search
Editing
Modding
(section)
Add topic