Skip to content

Terminal API

All endpoints require authentication.

Get Widget Layout

GET /api/terminal/widgets
Authorization: Bearer <token>

Returns array of widget objects with position, size, type, and page number.

Save Widget Layout

PUT /api/terminal/widgets
Authorization: Bearer <token>

Body:

json
{
  "widgets": [
    {
      "id": "w-1711900000000",
      "type": "chart",
      "ticker": "AAPL",
      "title": "Chart — AAPL",
      "x": 0,
      "y": 0,
      "w": 720,
      "h": 520,
      "page": 1
    }
  ]
}

Widget Types

TypeDescriptionRequires Ticker
chartFull candlestick chartYes
mini-chartCompact area chartYes
watchlistLive price listNo
newsMarket news feedNo
portfolioHoldings with P&LNo
heatmapCustom heatmapYes (heatmap ID)
currencyBank rate comparisonNo (bank selected in widget)

Released under the MIT License.