Plugin setup guide

Get the plugin talking to your account and showing live data. Takes a couple of minutes.

1. Install and enable the plugin

Build from source or drop the JAR into RuneLite. In the plugin list, turn on Grand Flip Out.

2. Get your API key

Create an account, then open your dashboard. Click "Create new API key" and copy it. You only see it once—use the Copy button if you need it again. If you're running your own backend without auth, you can leave the key blank and just set the Server URL.

3. Configure the plugin

In RuneLite, open Configuration (wrench icon) → Grand Flip Out API:

• Server URL — e.g. https://grandflipout.com (or your own API URL)
• API Key — paste the key from your dashboard. It's stored locally and masked in the UI.
• Market endpoint path — usually /api/market
• Market snapshot — Website uses /api/market/public (free). Plugin uses /api/market or /api/opportunities with API key (premium).

4. Turn on polling and tracking

In Configuration → Grand Flip Out:

• Enable Market API polling and pick a poll interval (e.g. 60 seconds).
• Enable Local trade tracking and Persist trade history if you want your flips saved across restarts.

5. Open the panel and go

Click the Grand Flip Out icon in the sidebar. Overview = session and all-time profit. Live Market = live prices and market snapshot from the API (or F2P-only public data). Trade History = your trades, open positions, and flip log. You can export or import from that tab (clipboard or file).

More detail

For API request/response shapes see docs/API_CONTRACT.md in the repo. For compliance and how we keep things above board, see docs/COMPLIANCE.md and docs/VALUE_PROTECTION.md.