AccountRow
An account as the API serves it: the `AccountUpdated` record plus the row extras (`globalSequence`; the deprecated `unscaled`, never present since 0.3.3) — the one shape its reads and its commands answer.
Properties
| Name | Type | Description |
|---|---|---|
| accountId | integer | Sticky entity key. |
| version | string | Monotonic per entity. int64 as a decimal JSON string |
| orgId | integer | The owning org — stamped by the owner from the credential's org, never client-supplied. |
| credentialId | integer | The pipe this account is reached through. |
| status | object | UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN |
| location | object | UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN |
| ownership | object | HOUSE only exercised in the POC. UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this fie |
| purpose | object | UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN |
| temperature | object | UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN |
| portfolioId | integernull | Single assignment in the POC; 0 = unassigned. |
| pendingByUserId | integernull | The maker while a proposal is pending; 0 otherwise. |
| pendingTransition | object | ACTIVATE (a classification), AMEND (a re-classification — the proposed axes ride this record while the last approved record keeps enforcing), UNFREEZE, RETIRE; NONE otherwise. NONE is the unset sentin |
| tradingCredentialId | integernull | The trading credential this account's orders go through when set (a read-only key discovers the account; a trading key at the same venue is designated here); absent or 0 = orders go through credential |
| externalRef | string | The venue's own account identifier — an attribute, never the id; with the credential, the key a discovery is idempotent on. |
| displayName | string | Empty-not-null. |
| globalSequence | object | |
| unscaled | boolean | Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/immix/json-schema/immix-account-row-schema.json",
"title": "AccountRow",
"description": "An account as the API serves it: the `AccountUpdated` record plus the row extras (`globalSequence`; the deprecated `unscaled`, never present since 0.3.3) — the one shape its reads and its commands answer.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/immix-accounts-api-openapi.yml#/components/schemas/AccountRow",
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"description": "Sticky entity key."
},
"version": {
"type": "string",
"pattern": "^-?[0-9]+$",
"description": "Monotonic per entity. int64 as a decimal JSON string"
},
"orgId": {
"type": "integer",
"description": "The owning org — stamped by the owner from the credential's org, never client-supplied."
},
"credentialId": {
"type": "integer",
"description": "The pipe this account is reached through."
},
"status": {
"$ref": "#/$defs/AccountUpdatedStatus",
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
},
"location": {
"$ref": "#/$defs/AccountUpdatedLocation",
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
},
"ownership": {
"$ref": "#/$defs/AccountUpdatedOwnership",
"description": "HOUSE only exercised in the POC. UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
},
"purpose": {
"$ref": "#/$defs/AccountUpdatedPurpose",
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
},
"temperature": {
"$ref": "#/$defs/AccountUpdatedTemperature",
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
},
"portfolioId": {
"type": [
"integer",
"null"
],
"description": "Single assignment in the POC; 0 = unassigned."
},
"pendingByUserId": {
"type": [
"integer",
"null"
],
"description": "The maker while a proposal is pending; 0 otherwise."
},
"pendingTransition": {
"$ref": "#/$defs/AccountUpdatedPendingTransition",
"description": "ACTIVATE (a classification), AMEND (a re-classification — the proposed axes ride this record while the last approved record keeps enforcing), UNFREEZE, RETIRE; NONE otherwise. NONE is the unset sentinel: outputs only — as input, omit the field instead; explicit NONE refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict"
},
"tradingCredentialId": {
"type": [
"integer",
"null"
],
"description": "The trading credential this account's orders go through when set (a read-only key discovers the account; a trading key at the same venue is designated here); absent or 0 = orders go through credentialId. Designated at classification, under dual control."
},
"externalRef": {
"type": "string",
"description": "The venue's own account identifier — an attribute, never the id; with the credential, the key a discovery is idempotent on."
},
"displayName": {
"type": "string",
"description": "Empty-not-null."
},
"globalSequence": {
"$ref": "#/$defs/GlobalSequenceValue"
},
"unscaled": {
"type": "boolean",
"description": "Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so a row is never served raw, whether or not this member holds the asset or instrument it references. Kept, deprecated, so a client generated from 0.3.2 still compiles; it goes at the next major.",
"deprecated": true
}
},
"required": [
"accountId",
"version",
"orgId",
"credentialId",
"status",
"location",
"ownership",
"purpose",
"temperature",
"pendingTransition",
"externalRef",
"displayName",
"globalSequence"
],
"$defs": {
"AccountUpdatedLocation": {
"type": "string",
"enum": [
"UNKNOWN",
"EXCHANGE",
"CUSTODIAN",
"WALLET",
"SELF_HOSTED",
"BANK"
],
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
"title": "AccountUpdatedLocation"
},
"AccountUpdatedOwnership": {
"type": "string",
"enum": [
"UNKNOWN",
"HOUSE",
"CLIENT_OMNIBUS",
"CLIENT_SEGREGATED"
],
"description": "HOUSE only exercised in the POC. UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
"title": "AccountUpdatedOwnership"
},
"AccountUpdatedPendingTransition": {
"type": "string",
"enum": [
"NONE",
"ACTIVATE",
"AMEND",
"REACTIVATE",
"UNFREEZE",
"RETIRE",
"REVOKE",
"ROTATE",
"RESUME_TRADING"
],
"description": "ACTIVATE (a classification), AMEND (a re-classification — the proposed axes ride this record while the last approved record keeps enforcing), UNFREEZE, RETIRE; NONE otherwise. NONE is the unset sentinel: outputs only — as input, omit the field instead; explicit NONE refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict",
"title": "AccountUpdatedPendingTransition"
},
"AccountUpdatedPurpose": {
"type": "string",
"enum": [
"UNKNOWN",
"TREASURY",
"CLIENT_DEPOSIT",
"SETTLEMENT_OPS",
"COLLATERAL",
"HEDGE",
"RAIL_VISIBLE"
],
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
"title": "AccountUpdatedPurpose"
},
"AccountUpdatedStatus": {
"type": "string",
"enum": [
"UNKNOWN",
"DISCOVERED",
"PENDING_APPROVAL",
"ACTIVE",
"FROZEN",
"RETIRED"
],
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
"title": "AccountUpdatedStatus"
},
"AccountUpdatedTemperature": {
"type": "string",
"enum": [
"UNKNOWN",
"COLD",
"WARM",
"HOT"
],
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
"title": "AccountUpdatedTemperature"
},
"GlobalSequenceValue": {
"type": "string",
"pattern": "^[0-9]+$",
"description": "The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.",
"title": "GlobalSequenceValue"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/immix-account-row"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.