{ "openapi": "3.1.0", "info": { "title": "CPZAI API", "version": "2.0.0", "description": "Programmatic access to CPZAI for agents, scripts, and integrations. Manage strategies, execute backtests, place orders, monitor risk, and subscribe to real-time events, all via API key or OAuth2 access token.", "contact": { "name": "CPZAI Support", "url": "https://cpz-lab.com" }, "license": { "name": "Proprietary" } }, "servers": [ { "url": "https://api.cpz-lab.com/functions/v1/rest-api/v1", "description": "Production REST adapter v1" } ], "security": [ { "ApiKeyHeader": [] }, { "ApiKeyBearer": [] }, { "OAuth2": [] } ], "tags": [ { "name": "strategies" }, { "name": "data-files" }, { "name": "backtests" }, { "name": "orders" }, { "name": "positions" }, { "name": "accounts" }, { "name": "risk-snapshots" }, { "name": "webhooks" }, { "name": "actions" }, { "name": "me" } ], "paths": { "/strategies": { "get": { "summary": "List strategies", "tags": [ "strategies" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "strategy_type", "in": "query", "schema": { "type": "string" } }, { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Strategy" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "post": { "summary": "Create a strategie", "tags": [ "strategies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Strategy" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Strategy" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/strategies/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "summary": "Get strategies by id", "tags": [ "strategies" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Strategy" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "patch": { "summary": "Update a strategie", "tags": [ "strategies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Strategy" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Strategy" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "delete": { "summary": "Delete a strategie", "tags": [ "strategies" ], "responses": { "200": { "description": "Deleted" } } } }, "/data-files": { "get": { "summary": "List data-files", "tags": [ "data-files" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "file_type", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataFile" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "post": { "summary": "Create a data-file", "tags": [ "data-files" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataFile" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DataFile" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/data-files/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "summary": "Get data-files by id", "tags": [ "data-files" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DataFile" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "patch": { "summary": "Update a data-file", "tags": [ "data-files" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataFile" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DataFile" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "delete": { "summary": "Delete a data-file", "tags": [ "data-files" ], "responses": { "200": { "description": "Deleted" } } } }, "/backtests": { "get": { "summary": "List backtests", "tags": [ "backtests" ], "parameters": [ { "name": "strategy_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Backtest" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/backtests/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "summary": "Get backtests by id", "tags": [ "backtests" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Backtest" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/orders": { "get": { "summary": "List orders", "description": "Alpaca accounts are read live from the broker and merged with the orders CPZAI recorded, newest first. Other brokers are listed from the orders CPZAI recorded. The response carries order_sources (which accounts were read live) and, when a broker read failed or was cut short, account_errors.", "tags": [ "orders" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "open, closed, all, or one exact status" }, { "name": "symbol", "in": "query", "schema": { "type": "string" } }, { "name": "side", "in": "query", "schema": { "type": "string", "enum": [ "buy", "sell" ] } }, { "name": "strategy_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Orders CPZAI recorded for the strategy; brokers are not read" }, { "name": "account_id", "in": "query", "schema": { "type": "string" } }, { "name": "client_order_id", "in": "query", "schema": { "type": "string" } }, { "name": "source", "in": "query", "schema": { "type": "string", "enum": [ "platform" ] }, "description": "Only the orders CPZAI recorded, no broker read" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "post": { "summary": "Place a new order", "tags": [ "orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "broker_credential_id", "symbol", "side", "order_type", "quantity" ], "properties": { "account_id": { "type": "string" }, "broker_credential_id": { "type": "string" }, "symbol": { "type": "string" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "order_type": { "type": "string", "enum": [ "market", "limit", "stop", "stop_limit" ] }, "quantity": { "type": "number" }, "price": { "type": "number", "nullable": true } } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/positions": { "get": { "summary": "List positions", "tags": [ "positions" ], "parameters": [ { "name": "account_id", "in": "query", "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Position" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/accounts": { "get": { "summary": "List accounts", "tags": [ "accounts" ], "parameters": [ { "name": "broker", "in": "query", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "schema": { "type": "string", "enum": [ "live", "paper" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/risk-snapshots": { "get": { "summary": "List risk-snapshots", "tags": [ "risk-snapshots" ], "parameters": [ { "name": "account_id", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RiskSnapshot" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/order-approvals": { "get": { "summary": "List order-approvals", "tags": [ "order-approvals" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "pending", "approved", "rejected", "consumed", "placed", "failed" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderApproval" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/order-approvals/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "summary": "Get order-approvals by id", "tags": [ "order-approvals" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderApproval" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/watchlist": { "get": { "summary": "List watchlist", "tags": [ "watchlist" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WatchlistItem" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "post": { "summary": "Add a symbol to the watchlist (10 at most)", "tags": [ "watchlist" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "symbol" ], "properties": { "symbol": { "type": "string", "example": "AAPL" } } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WatchlistItem" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/watchlist/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "delete": { "summary": "Remove a symbol from the watchlist", "tags": [ "watchlist" ], "responses": { "200": { "description": "Removed" } } } }, "/transactions": { "get": { "summary": "List transactions", "tags": [ "transactions" ], "parameters": [ { "name": "year", "in": "query", "schema": { "type": "integer" }, "description": "Calendar year in UTC; from and to win over it" }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Exclusive" }, { "name": "account_id", "in": "query", "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "schema": { "type": "string" } }, { "name": "side", "in": "query", "schema": { "type": "string", "enum": [ "buy", "sell" ] } }, { "name": "environment", "in": "query", "schema": { "type": "string", "enum": [ "live", "paper" ] } }, { "name": "broker", "in": "query", "schema": { "type": "string" } }, { "name": "strategy_id", "in": "query", "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "csv" ] }, "description": "csv returns text/csv; without limit it stops at 10,000 rows and sets X-Truncated: true" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/cash": { "get": { "summary": "List cash", "tags": [ "cash" ], "parameters": [ { "name": "broker", "in": "query", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "schema": { "type": "string", "enum": [ "live", "paper" ] } }, { "name": "tradable", "in": "query", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CashAccount" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/webhooks": { "get": { "summary": "List webhooks", "tags": [ "webhooks" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "count": { "type": "integer" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "post": { "summary": "Create a webhook", "tags": [ "webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Webhook" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/me": { "get": { "summary": "Current user profile", "tags": [ "me" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/portfolio-sync": { "post": { "summary": "Trigger portfolio sync", "tags": [ "actions" ], "responses": { "200": { "description": "Sync triggered" } } } }, "/market-data": { "post": { "summary": "Fetch live quotes", "tags": [ "actions" ], "parameters": [ { "name": "symbols", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Comma-separated symbols" } ], "responses": { "200": { "description": "Quotes" } } } }, "/risk-compute": { "post": { "summary": "Compute a fresh risk snapshot", "tags": [ "actions" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "account_id": { "type": "string" } } } } } }, "responses": { "200": { "description": "Risk snapshot" } } } }, "/execute": { "post": { "summary": "Execute a strategy on compute", "tags": [ "actions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "strategy_id" ], "properties": { "strategy_id": { "type": "string", "format": "uuid" }, "code": { "type": "string" } } } } } }, "responses": { "200": { "description": "Execution started" } } } } }, "components": { "securitySchemes": { "ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-CPZ-Key", "description": "Paired with X-CPZ-Secret. Recommended for SDK and server-to-server use." }, "ApiKeyBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "cpz_key", "description": "Single-header API key: Authorization: Bearer cpz_key_....cpz_secret_... (the key, a dot, then the secret)" }, "OAuth2": { "type": "oauth2", "description": "OAuth 2.0 + PKCE issued by the CPZAI authorization server.", "flows": { "authorizationCode": { "authorizationUrl": "https://api.cpz-lab.com/oauth/authorize", "tokenUrl": "https://api.cpz-lab.com/oauth/token", "refreshUrl": "https://api.cpz-lab.com/oauth/token", "scopes": { "openid": "openid", "profile": "profile", "email": "email", "offline_access": "offline_access", "strategies": "strategies", "data": "data", "orders": "orders", "orders_paper": "orders_paper", "confirm_orders": "confirm_orders", "data_connections": "data_connections", "trading_credentials": "trading_credentials", "storage": "storage" } }, "clientCredentials": { "tokenUrl": "https://api.cpz-lab.com/oauth/token", "scopes": { "strategies": "strategies", "data": "data", "orders": "orders", "orders_paper": "orders_paper", "confirm_orders": "confirm_orders", "data_connections": "data_connections", "trading_credentials": "trading_credentials", "storage": "storage" } } } } }, "responses": { "Unauthorized": { "description": "Missing or invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "RateLimited": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } }, "X-RateLimit-Limit": { "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error" ] }, "User": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "created_at": { "type": "string", "format": "date-time" } } }, "Strategy": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "strategy_type": { "type": "string" }, "status": { "type": "string" }, "code": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "DataFile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "file_type": { "type": "string" }, "status": { "type": "string" }, "size_bytes": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } }, "Backtest": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "strategy_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "results": { "type": "object", "additionalProperties": true }, "created_at": { "type": "string", "format": "date-time" } } }, "Order": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "account_id": { "type": "string" }, "symbol": { "type": "string" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "order_type": { "type": "string" }, "quantity": { "type": "number" }, "price": { "type": "number", "nullable": true }, "status": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "OrderApproval": { "type": "object", "description": "An order from a confirm_orders credential, held for the owner. Approve or reject in the app; resubmit POST /orders with approval_id once approved.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected", "consumed", "placed", "failed" ] }, "effective_status": { "type": "string", "enum": [ "pending", "approved", "rejected", "consumed", "placed", "failed", "expired" ] }, "summary": { "type": "object" }, "broker": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "consumed_at": { "type": "string", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "result_status": { "type": "integer", "nullable": true }, "error": { "type": "string", "nullable": true } } }, "WatchlistItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "symbol": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "Transaction": { "type": "object", "description": "One fill. quantity is the filled quantity; gross_amount is quantity times price, null when the price is not on record.", "properties": { "id": { "type": "string", "format": "uuid" }, "executed_at": { "type": "string", "format": "date-time", "nullable": true }, "symbol": { "type": "string" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "nullable": true }, "price": { "type": "number", "nullable": true }, "gross_amount": { "type": "number", "nullable": true }, "commission": { "type": "number", "nullable": true }, "broker": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "account_id": { "type": "string", "nullable": true }, "order_id": { "type": "string", "nullable": true }, "client_order_id": { "type": "string", "nullable": true }, "strategy_id": { "type": "string", "nullable": true }, "status": { "type": "string", "description": "The order status. Any order with a fill is a transaction, including one that partly filled and then expired or was canceled." } } }, "CashAccount": { "type": "object", "description": "A connected account with the last balance the metrics sync recorded, or for TradeStation the balance read live. coverage says where the balance came from, or why there is none.", "properties": { "id": { "type": "string", "format": "uuid" }, "broker": { "type": "string" }, "broker_display_name": { "type": "string" }, "environment": { "type": "string", "enum": [ "live", "paper" ], "nullable": true }, "account_id": { "type": "string", "nullable": true }, "account_name": { "type": "string", "nullable": true }, "tradable": { "type": "boolean" }, "currency": { "type": "string", "nullable": true }, "cash": { "type": "number", "nullable": true }, "buying_power": { "type": "number", "nullable": true }, "equity": { "type": "number", "nullable": true }, "as_of": { "type": "string", "format": "date-time", "nullable": true }, "stale": { "type": "boolean" }, "coverage": { "type": "string", "enum": [ "synced", "broker_live", "broker_unreadable", "not_synced", "no_balance_source" ] }, "error": { "type": "string", "description": "Why a live broker read failed (coverage broker_unreadable only)." }, "error_code": { "type": "string", "nullable": true } } }, "Position": { "type": "object", "properties": { "account_id": { "type": "string" }, "symbol": { "type": "string" }, "quantity": { "type": "number" }, "avg_cost": { "type": "number" }, "market_value": { "type": "number" }, "updated_at": { "type": "string", "format": "date-time" } } }, "Account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "broker": { "type": "string" }, "broker_display_name": { "type": "string" }, "environment": { "type": "string", "enum": [ "live", "paper" ] }, "account_id": { "type": "string" }, "account_number": { "type": "string" }, "status": { "type": "string" } } }, "RiskSnapshot": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "account_id": { "type": "string", "nullable": true }, "risk_score": { "type": "number" }, "portfolio_var_95": { "type": "number" }, "sharpe_ratio": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" } } }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" } } }, "WebhookCreate": { "type": "object", "required": [ "url", "events" ], "properties": { "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "order.placed", "order.filled", "strategy.executed", "backtest.completed", "risk.alert", "news.breaking" ] } }, "description": { "type": "string", "nullable": true }, "active": { "type": "boolean", "default": true } } } } } }