{ "schemes": [ "https" ], "swagger": "2.0", "info": { "description": "Trade programmatically on your own OnlyTrade account: authenticate with an API key, read instruments and prices, place and manage orders and positions, and pull your trade history. Every endpoint here acts on the account your token belongs to.\n\n**Authorize:** paste `Bearer ` into BearerAuth. Get a token with [an API key or a password](/trader/authentication).\n\nLive prices and account events stream over the [WebSocket](/trader/websocket/overview). New here? Start with [Build a trading bot](/trader/build-a-bot).", "title": "OnlyTrade Trader API", "contact": {}, "version": "1.0" }, "host": "api.onlytradeplatform.com", "basePath": "/", "paths": { "/api/v1/accounts/me": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get Account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Account" ], "operationId": "GetMyProfile", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/v1.ViewAccount" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Get my account" } }, "/api/v1/accounts/me/client-secret": { "post": { "security": [ { "BearerAuth": [] } ], "description": "Creates an API key for this account (password session required). The `client_secret` is returned **once** — store it in your secret manager. Calling this again replaces the key.\n\nGenerate client secret for the client account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Account" ], "operationId": "GenerateClientSecret", "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/v1.ClientSecret" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Create an API key" }, "delete": { "security": [ { "BearerAuth": [] } ], "description": "Revoke client secret for the client account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Account" ], "operationId": "RevokeClientSecret", "responses": { "204": { "description": "No Content" }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Revoke my API key" } }, "/api/v1/accounts/me/export/history": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Download my trade history. format=csv (section=trades|deals|orders|journal) or format=xlsx (all sheets). from/to are unix seconds.", "produces": [ "text/csv" ], "tags": [ "History" ], "operationId": "ExportMyHistory", "parameters": [ { "type": "string", "description": "csv or xlsx", "name": "format", "in": "query" }, { "type": "string", "description": "trades, deals, orders or journal (csv only)", "name": "section", "in": "query" }, { "type": "integer", "description": "unix seconds", "name": "from", "in": "query" }, { "type": "integer", "description": "unix seconds", "name": "to", "in": "query" } ], "responses": { "200": { "description": "OK" } }, "summary": "Export my history (CSV)" } }, "/api/v1/accounts/me/journal": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get My Journal", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "History" ], "operationId": "GetMyJournal", "parameters": [ { "type": "integer", "description": "page number", "name": "page", "in": "query" }, { "type": "integer", "description": "limit number", "name": "limit", "in": "query" }, { "type": "string", "description": "from date", "name": "from", "in": "query" }, { "type": "string", "description": "to date", "name": "to", "in": "query" }, { "type": "string", "description": "sort by", "name": "sort_by", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/v1.Journal" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Get my journal" } }, "/api/v1/accounts/me/transactions": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get my balance-affecting transactions (deposits, withdrawals, credit, adjustments)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Account" ], "operationId": "GetMyTransactions", "parameters": [ { "type": "string", "description": "comma-separated origin filter, e.g. 0,2,3,6,7 (deposit, adjust, withdraw, credit_in, credit_out)", "name": "origin", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/model.Transaction" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "List my money transactions" } }, "/api/v1/deals/accounts/me": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get My Deals", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "History" ], "operationId": "GetMyDeals", "parameters": [ { "type": "integer", "description": "page number", "name": "page", "in": "query" }, { "type": "integer", "description": "limit number", "name": "limit", "in": "query" }, { "type": "string", "description": "from date", "name": "from", "in": "query" }, { "type": "string", "description": "to date", "name": "to", "in": "query" }, { "type": "string", "description": "sort by", "name": "sort_by", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/model.Deal" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "List my deals" } }, "/api/v1/deals/accounts/me/summary": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Aggregate totals over the trader's closed deals (footer)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "History" ], "operationId": "GetMyDealsSummary", "parameters": [ { "type": "string", "description": "from date", "name": "from", "in": "query" }, { "type": "string", "description": "to date", "name": "to", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/v1.DealsSummary" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Get my deals summary" } }, "/api/v1/market/history": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Historical OHLC candles for one symbol, oldest first. `from`/`to` are Unix **seconds**; `resolution` is e.g. `1m`, `5m`, `1h`, `1d`; `count_back` must be > 0. Bar `time` is Unix ms.\n\nGet Market Feed History", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Instruments & prices" ], "operationId": "GetMarketFeedHistory", "parameters": [ { "type": "integer", "description": "Symbol ID", "name": "symbol_id", "in": "query", "required": true }, { "type": "integer", "description": "From Timestamp", "name": "from", "in": "query", "required": true }, { "type": "integer", "description": "To Timestamp", "name": "to", "in": "query", "required": true }, { "type": "string", "description": "Resolution (Xm, Xh, Xd, Xw, Xmo)", "name": "resolution", "in": "query", "required": true }, { "type": "string", "description": "Type (bid or ask)", "name": "type", "in": "query" }, { "type": "integer", "description": "Count Back", "name": "count_back", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/v1.HistoryTick" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Get price history (candles)" } }, "/api/v1/news/feed": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get News from RSS news providers", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "News" ], "operationId": "GetFeed", "parameters": [ { "type": "string", "description": "filter providers by key", "name": "key", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/news.Item" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Get the news feed" } }, "/api/v1/orders/accounts/me": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get My Orders", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Orders" ], "operationId": "GetMyOrders", "parameters": [ { "type": "integer", "description": "page number", "name": "page", "in": "query" }, { "type": "integer", "description": "limit number", "name": "limit", "in": "query" }, { "type": "string", "description": "from date", "name": "from", "in": "query" }, { "type": "string", "description": "to date", "name": "to", "in": "query" }, { "type": "string", "description": "sort by", "name": "sort_by", "in": "query" }, { "type": "boolean", "description": "active orders", "name": "active", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/model.Order" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "List my orders" }, "post": { "security": [ { "BearerAuth": [] } ], "description": "Place a market (`type: 0`) or pending (`1`–`4`) order. `order_price` is required and must not be 0. The `201` response only means *accepted* and has no order ID — the fill (`position_create`) or rejection arrives on the [WebSocket](/trader/websocket/events). Trailing stop, break-even and split are ignored here (WebSocket only). See [Orders, positions & deals](/trader/trading-model).\n\nCreate My Orders", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Orders" ], "operationId": "CreateMyOrder", "parameters": [ { "description": "Order Request Body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CrtMyOrder" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/model.Order" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Place an order" } }, "/api/v1/orders/{order_id}/accounts/me": { "put": { "security": [ { "BearerAuth": [] } ], "description": "Update My Order", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Orders" ], "operationId": "UpdateMyOrder", "parameters": [ { "type": "integer", "description": "Order ID", "name": "order_id", "in": "path", "required": true }, { "description": "Order Request Body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.UptOrder" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/model.Order" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Modify a pending order" }, "post": { "security": [ { "BearerAuth": [] } ], "description": "Cancel My Order", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Orders" ], "operationId": "CancelMyOrder", "parameters": [ { "type": "integer", "description": "Order ID", "name": "order_id", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Cancel a pending order" } }, "/api/v1/positions/accounts/me": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get My Positions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Positions" ], "operationId": "GetMyPositions", "parameters": [ { "type": "integer", "description": "page number", "name": "page", "in": "query" }, { "type": "integer", "description": "limit number", "name": "limit", "in": "query" }, { "type": "string", "description": "from date", "name": "from", "in": "query" }, { "type": "string", "description": "to date", "name": "to", "in": "query" }, { "type": "string", "description": "sort by", "name": "sort_by", "in": "query" }, { "type": "boolean", "description": "active positions", "name": "active", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/model.Position" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "List my open positions" } }, "/api/v1/positions/close-many/accounts/me": { "post": { "security": [ { "BearerAuth": [] } ], "description": "Close many of my positions in one request (trader)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Positions" ], "operationId": "CloseManyMyPositions", "parameters": [ { "description": "Bulk Close Request Body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CloseManyPositions" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/v1.CloseManyResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Close several positions" } }, "/api/v1/positions/{position_id}/accounts/me": { "put": { "security": [ { "BearerAuth": [] } ], "description": "Update My Position", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Positions" ], "operationId": "UpdateMyPosition", "parameters": [ { "type": "integer", "description": "Position ID", "name": "position_id", "in": "path", "required": true }, { "description": "Position Request Body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.UptMyPosition" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/model.Position" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Modify a position (SL/TP)" }, "post": { "security": [ { "BearerAuth": [] } ], "description": "Close My Position", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Positions" ], "operationId": "CloseMyPosition", "parameters": [ { "type": "integer", "description": "Position ID", "name": "position_id", "in": "path", "required": true }, { "description": "Position Request Body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CloseMyPosition" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Close a position" } }, "/api/v1/reports": { "get": { "security": [ { "BearerAuth": [] } ], "description": "List reports visible to the caller. Trader sees own;\ndealer sees own + group accounts; admin sees all.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Reports" ], "operationId": "GetAllReports", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/v1.ViewReport" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "List my reports" }, "post": { "security": [ { "BearerAuth": [] } ], "description": "Queue a new report generation. Body matches\nonlytrade-data's QueryRequest (report_type,\nreport_data_type, optional filter, optional account_ids).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Reports" ], "operationId": "CreateReport", "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/v1.ViewReport" } }, "503": { "description": "Service Unavailable", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Request a report" } }, "/api/v1/reports/file/{request_id}": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Stream the generated file (PDF/CSV/HTML/JSON) by\nrequest_id. Sends the correct Content-Type from the\nrow's mime_type.", "consumes": [ "application/json" ], "produces": [ "application/pdf", "text/csv", "application/json", "text/html" ], "tags": [ "Reports" ], "operationId": "GetReportFile", "parameters": [ { "type": "string", "description": "Request ID", "name": "request_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Download a report file" } }, "/api/v1/reports/{id}": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Fetch one report row by id (metadata only — use the\nfile endpoint for the body).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Reports" ], "operationId": "GetReport", "parameters": [ { "type": "integer", "description": "Report ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/v1.ViewReport" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Get a report" }, "delete": { "security": [ { "BearerAuth": [] } ], "description": "Delete one of the caller's reports — removes the DB\nrow AND the file from disk.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Reports" ], "operationId": "DeleteReport", "parameters": [ { "type": "integer", "description": "Report ID", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Delete a report" } }, "/api/v1/symbols/me": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get All My Symbols", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Instruments & prices" ], "operationId": "GetMySymbols", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/v1.ViewSymbol" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "List my symbols" } }, "/api/v1/symbols/me/by_name": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get My Symbol By Symbol Name", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Instruments & prices" ], "operationId": "GetMySymbol", "parameters": [ { "type": "string", "description": "Symbol Name", "name": "symbol", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/v1.ViewSymbol" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Get a symbol by name" } }, "/api/v1/symbols/me/tree": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get All My Symbols Tree", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Instruments & prices" ], "operationId": "GetMySymbolsTree", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/v1.ViewSymbolClassTree" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "List my symbols by class" } }, "/auth/v1/oauth2/login": { "post": { "security": [ { "BasicAuth": [] } ], "description": "Log in with HTTP Basic auth: `:`. Returns `access_token`, `refresh_token` and `session_id`. Pass `remember_me=true` — without it, a session idle for 5 minutes is logged out.\n\nLogin using account credentials passed using basic auth method", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authentication" ], "operationId": "Login", "parameters": [ { "type": "boolean", "description": "remember me", "name": "remember_me", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/v1.LoginResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Log in with a password" } }, "/auth/v1/oauth2/logout": { "delete": { "security": [ { "BearerAuth": [] } ], "description": "Logout", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authentication" ], "operationId": "Logout", "responses": { "204": { "description": "No Content" }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Log out" } }, "/auth/v1/oauth2/refresh/token": { "post": { "description": "Refresh account's Token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authentication" ], "operationId": "RefreshToken", "parameters": [ { "description": "Refresh Token Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.RefreshTokenBody" } }, { "type": "boolean", "description": "remember me", "name": "remember_me", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/model.Token" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Refresh a token" } }, "/auth/v1/oauth2/token": { "post": { "security": [ { "BasicAuth": [] } ], "description": "Exchange an API key for tokens (OAuth2 `client_credentials`). Send HTTP Basic auth with `:` and the query `grant_type=client_credentials&remember_me=true`. Create the key with `POST /api/v1/accounts/me/client-secret`. The token carries the `API_Trader` scope. Reuse and refresh tokens: each call opens a session, and an account has at most 5.\n\nLogin using account client_id and client secret passed using basic auth method", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authentication" ], "operationId": "Token", "parameters": [ { "type": "string", "description": "either client_credentials or password", "name": "grant_type", "in": "query", "required": true }, { "type": "boolean", "description": "remember me", "name": "remember_me", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/v1.LoginResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/http.HttpResponse" } } }, "summary": "Get a token with an API key" } } }, "definitions": { "eventspread.EventPreview": { "type": "object", "properties": { "active": { "description": "window currently in effect", "type": "boolean" }, "at": { "description": "event time (UTC)", "type": "string" }, "currency": { "type": "string" }, "impact": { "type": "string" }, "manual_symbols": { "description": "Symbols manually attached to this event's title by an admin (widened on\ntop of the auto ones).", "type": "array", "items": { "type": "string" } }, "multiplier": { "description": "spread multiplier under current config (1 = no widening)", "type": "number" }, "passed": { "description": "window already over", "type": "boolean" }, "symbols": { "description": "Symbols whose base/quote currency matches — auto-widened by this event.", "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "window_end": { "description": "event + minutes_after", "type": "string" }, "window_start": { "description": "event − minutes_before", "type": "string" } } }, "eventspread.EventPreviewResult": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "$ref": "#/definitions/eventspread.EventPreview" } }, "feed_error": { "description": "set when the calendar couldn't be fetched", "type": "string" }, "fetched_at": { "type": "string" }, "window_after_min": { "type": "integer" }, "window_before_min": { "type": "integer" } } }, "http.HttpResponse": { "type": "object", "properties": { "code": { "description": "Http status Code", "type": "integer" }, "data": { "description": "if the request were successful the data will be saved here" }, "error": { "description": "Generic General Error Message defined in the system", "type": "string" }, "message": { "description": "More detailed error message indicates why the request was unsuccessful", "type": "string" }, "success": { "description": "Response flag indicates whether the HTTP request was successful or not", "type": "boolean" } } }, "market.DataSourceSymbol": { "type": "object", "properties": { "data_source": { "type": "string" }, "external_id": { "type": "string" }, "source": { "type": "string" } } }, "model.Account": { "type": "object", "properties": { "account_type": { "$ref": "#/definitions/model.AccountType" }, "assets": { "description": "assests = (Long) the current value of purchased financial instruments (of long positions)", "type": "number" }, "balance": { "description": "balance = total of deposit + total of relized profit - total of relized losses - total commision - total swap // balance = total of deposit + total of relized profit - total of relized losses - total commision - total swap", "type": "number" }, "blocked_commission": { "description": "profit commitsion", "type": "number" }, "blocked_profit": { "description": "profit blocked", "type": "number" }, "broker": { "$ref": "#/definitions/model.Broker" }, "broker_id": { "type": "integer" }, "client_id": { "description": "api user for this account", "type": "string" }, "code_expiry": { "description": "the epxiry password change code time.now() + time", "type": "string" }, "created_at": { "type": "integer", "format": "int64" }, "created_by": { "type": "integer" }, "credit": { "description": "forward broker credit // forward broker credit", "type": "number" }, "currency": { "description": "base currency of balance", "type": "string" }, "currency_digits": { "description": "the smallest unit of a currency, depending on the number of decimals.", "type": "integer" }, "deals": { "type": "array", "items": { "$ref": "#/definitions/model.Deal" } }, "equity": { "description": "equity = balance + credit + relized profit", "type": "number" }, "expires_at": { "description": "unix nanos; 0 = never; demo trials auto-expire via cron", "type": "integer" }, "favourite": { "description": "for UI favourites list in the backoffice terminal", "type": "boolean" }, "floating_profit": { "description": "current floating profit while positions is moving up/down", "type": "number" }, "free_margin": { "description": "free_margin = equity - used margin", "type": "number" }, "group": { "$ref": "#/definitions/model.Group" }, "group_id": { "description": "this user if part of a group", "type": "integer" }, "id": { "type": "integer" }, "identity": { "$ref": "#/definitions/model.Identity" }, "kyc_results": { "description": "what kyc provider saying.", "allOf": [ { "$ref": "#/definitions/model.KycStatus" } ] }, "leverage": { "description": "1:x where X = 5000 down to 1 use group level if ZERP", "type": "integer" }, "liabilities": { "description": "Liabilities = (Sell) Liabilities are obligations on current short positions calculated", "type": "number" }, "liqudation": { "description": "a flag to indicated type of liquidated or under liquidation", "allOf": [ { "$ref": "#/definitions/model.LiqudationType" } ] }, "liqudation_status": { "description": "liquidation status", "allOf": [ { "$ref": "#/definitions/model.LiqudationStatus" } ] }, "login": { "description": "UserId string `gorm:\"column:user_id;unique\" json:\"user_id\"` // username or email\nOptional alphanumeric login alias (e.g. \"OT_55782\"). When empty the\naccount id is the login. Never purely numeric, so it can't shadow an id.", "type": "string" }, "mail": { "type": "array", "items": { "$ref": "#/definitions/model.Mail" } }, "margin_initial": { "description": "Margin Initial calcuated", "type": "number" }, "margin_level": { "description": "margin_level = (equity / used margin) x 100%", "type": "number" }, "margin_maintenance": { "description": "minum margin_maintenance required to maintain positions", "type": "number" }, "orders": { "type": "array", "items": { "$ref": "#/definitions/model.Order" } }, "positions": { "type": "array", "items": { "$ref": "#/definitions/model.Position" } }, "profit": { "description": "current profit", "type": "number" }, "prop_account_size": { "description": "prop evaluation phase-state (runtime only; the phase RULES live on the group config and are inherited)", "type": "number" }, "prop_breach_pct": { "description": "the bar's used % at the moment of the breach", "type": "number" }, "prop_breach_rule": { "description": "which limit tripped: prop_max_day_loss | prop_max_day_profit | prop_total_days_loss | margin_stop_out", "type": "string" }, "prop_breached_at": { "description": "ns epoch of the last prop-limit breach (0 = none); kept so the bars can show \"breached X% at