GET /v2/journal/accounts

List journal accounts

journal_listAccounts

Every trade-journal account on your account, each as {id, name, broker} (broker is omitted when unset). Journal trades reference these ids.

Empty results

An account with no journal accounts returns 200 with an empty data list.

Example

http

GET /v2/journal/accounts

json

{
  "data": [
    {
      "id": "01J8ZKQ4ZP3V7C2M8XW5R6T9YB",
      "name": "IBKR main",
      "broker": "ibkr"
    }
  ],
  "meta": { "count": 1 }
}

Response

Prices are dollars, timestamps epoch milliseconds, strikes integer thousandths of a dollar; null means unknown. Units →

200application/json

Your journal accounts in data

object

A successful response: the payload consumers parse plus response metadata. data shapes are the platform types — never reshaped by the envelope.

data array<object> required

broker string nullable

id string required

name string

meta object required

Response metadata.

caps object nullable

meta.caps — the entitlement caps that shaped this response. applied lists the caps that actually changed it (for example range_clamped).

applied array<string> required

Which caps actually shaped this response (e.g. range_clamped). Empty = nothing was clamped.

darkpool boolean nullable

Whether this account can use Off-Exchange in the site.

flow boolean nullable

Whether the OPRA option-flow capability (flow) is granted to this principal in the app: site Pro plus a CBOE non-professional attestation (never on an itm_ key). Emitted explicitly — true and false — by the account endpoints, so the app reads the grant instead of inferring it from tier and attestation; absent on routes that do not report it.

gexDepth string nullable

GEX data depth when the route reports it. Camel-cased to match the browser capability bundle; absent on unrelated routes.

tier string required

The tier the request was served under.

cursor string nullable

Opaque continuation cursor (pass back as ?cursor=); absent when there is nothing more to read.

plane string nullable

Which serving tier answered the read (meta.plane). Informational provenance: treat it as an opaque label, because new values may appear.

Errors

Every error is the JSON error envelope; branch on error.code.

Status	Meaning
401	`unauthenticated`

Request

curl -sS "https://api.itmatrixhq.com/v2/journal/accounts" \
  -H "Authorization: Bearer $ITM_API_KEY"

import os
import httpx

response = httpx.get(
    "https://api.itmatrixhq.com/v2/journal/accounts",
    headers={"Authorization": f"Bearer {os.environ['ITM_API_KEY']}"},
    timeout=30,
)
print(response.status_code, response.json())

import os
import itmatrix as itm

with itm.ITMClient(api_key=os.environ["ITM_API_KEY"]) as client:
    result = client.journal.list_accounts()
    print(result.status, result.data)

const url = new URL("https://api.itmatrixhq.com/v2/journal/accounts");

const response = await fetch(url, {
  headers: { Authorization: `Bearer ${process.env.ITM_API_KEY}` },
});
console.log(response.status, await response.json());

import { ITMClient } from "@itmatrixhq/core";

const client = new ITMClient({ apiKey: process.env.ITM_API_KEY });
const result = await client.journal.listAccounts();
console.log(result.status, result.data);