Skip to main content

Who am I

GET /api/v1/whoami · scope read The account your key acts for.

Buying power

GET /api/v1/account · scope read What a buy can spend, read live from tZERO. tZERO refuses any order larger than this.
404 until the brokerage account is opened. 503 when tZERO does not answer within 5 seconds or is briefly unavailable; retry. 502 when tZERO cannot report this account’s buying power (a refused credential or capability, an account tZERO does not know, or an answer without a figure); retrying will not help.

Positions

GET /api/v1/home/positions · scope read What the account holds, read live from tZERO: the USD cash row first (when tZERO reports one), then one row per security. Quantities only; price them from a quote.
404 until the brokerage account is opened. An empty array when tZERO lists nothing for the account. 503 when tZERO does not answer within 5 seconds or is briefly unavailable; retry. 502 when tZERO cannot report this account’s holdings (a refused credential or capability, or an unusable answer); retrying will not help.

Profile

GET /api/me · scope read This endpoint’s fields are snake_case; the /api/v1 endpoints use camelCase.