POST /v2/journal/accounts

Create a journal account

journal_createAccount

Creates a trade-journal account from {"name": "IBKR main", "broker": "ibkr"} and returns it with its id. For safe retries use PUT /v2/journal/accounts/{id} instead.

Request body

The contract does not describe a body schema for this operation; the notes on this page give its fields.

Details

The server assigns the id unless the body supplies one. broker is optional.

Response

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

200application/json

The stored account 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 object required

A journal account (normalized; minimal fields).

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 -X POST "https://api.itmatrixhq.com/v2/journal/accounts" \
  -H "Authorization: Bearer $ITM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import httpx

response = httpx.post(
    "https://api.itmatrixhq.com/v2/journal/accounts",
    json={},  # the fields under "Request body" above
    headers={"Authorization": f"Bearer {os.environ['ITM_API_KEY']}"},
    timeout=30,
)
print(response.status_code, response.json())

import os
import itmatrix as itm

account = {}  # the fields under "Request body" above

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

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

const response = await fetch(url, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ITM_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}), // the fields under "Request body" above
});
console.log(response.status, await response.json());

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

const client = new ITMClient({ apiKey: process.env.ITM_API_KEY });
const account = {}; // the fields under "Request body" above
const result = await client.journal.createAccount(account);
console.log(result.status, result.data);