--- updatedAt: 2026-03-26T12:27:31.000Z agentTools: projectIndex: https://public-api.tradelocker.com/llms.txt --- # Get configuration # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "description": "Trading API", "version": "2.11.0", "title": "Trading API", "contact": {} }, "tags": [ { "name": "Config", "description": "Basic settings and schemas." } ], "paths": { "/trade/config": { "get": { "tags": [ "Config" ], "summary": "Get configuration", "operationId": "getConfigUsingGET", "parameters": [ { "name": "accNum", "in": "header", "description": "Account number", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "BearerAuth": [] } ] } } }, "servers": [ { "url": "https://demo.tradelocker.com/backend-api" }, { "url": "https://live.tradelocker.com/backend-api" } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "Column": { "type": "object", "properties": { "description": { "type": "string", "description": "Column description." }, "id": { "type": "string", "description": "Column identifier." } }, "title": "Column" }, "Config": { "type": "object", "properties": { "accountDetailsConfig": { "$ref": "#/components/schemas/PanelConfig" }, "customerAccess": { "$ref": "#/components/schemas/Permissions_to_use_specific_functions_and_information_in_the_client_terminal." }, "filledOrdersConfig": { "$ref": "#/components/schemas/PanelConfig" }, "ordersConfig": { "$ref": "#/components/schemas/PanelConfig" }, "ordersHistoryConfig": { "$ref": "#/components/schemas/PanelConfig" }, "positionsConfig": { "$ref": "#/components/schemas/PanelConfig" }, "rateLimits": { "$ref": "#/components/schemas/RateLimits" }, "limits": { "$ref": "#/components/schemas/Limits" } }, "title": "Config" }, "ConfigResponse": { "type": "object", "required": [ "s" ], "properties": { "d": { "$ref": "#/components/schemas/Config" }, "s": { "type": "string", "example": "ok", "description": "Status will always be `ok`." } }, "title": "ConfigResponse", "example": { "s": "ok", "d": { "customerAccess": { "orders": true, "ordersHistory": true, "filledOrders": true, "positions": true, "symbolInfo": true, "marketDepth": true }, "positionsConfig": { "id": "positions", "title": "Positions", "columns": [ { "id": "id" }, { "id": "tradableInstrumentId" }, { "id": "routeId" }, { "id": "side" }, { "id": "qty" }, { "id": "avgPrice" }, { "id": "stopLossId" }, { "id": "takeProfitId" }, { "id": "openDate" }, { "id": "unrealizedPl" }, { "id": "strategyId" } ] }, "ordersConfig": { "id": "orders", "title": "Orders", "columns": [ { "id": "id" }, { "id": "tradableInstrumentId" }, { "id": "routeId" }, { "id": "qty" }, { "id": "side" }, { "id": "type" }, { "id": "status" }, { "id": "filledQty" }, { "id": "avgPrice" }, { "id": "price" }, { "id": "stopPrice" }, { "id": "validity" }, { "id": "expireDate" }, { "id": "createdDate" }, { "id": "lastModified" }, { "id": "isOpen" }, { "id": "positionId" }, { "id": "stopLoss" }, { "id": "stopLossType" }, { "id": "takeProfit" }, { "id": "takeProfitType" }, { "id": "strategyId" } ] }, "ordersHistoryConfig": { "id": "ordersHistory", "title": "Orders history", "columns": [ { "id": "id" }, { "id": "tradableInstrumentId" }, { "id": "routeId" }, { "id": "qty" }, { "id": "side" }, { "id": "type" }, { "id": "status" }, { "id": "filledQty" }, { "id": "avgPrice" }, { "id": "price" }, { "id": "stopPrice" }, { "id": "validity" }, { "id": "expireDate" }, { "id": "createdDate" }, { "id": "lastModified" }, { "id": "isOpen" }, { "id": "positionId" }, { "id": "stopLoss" }, { "id": "stopLossType" }, { "id": "takeProfit" }, { "id": "takeProfitType" }, { "id": "strategyId" } ] }, "filledOrdersConfig": { "id": "filledOrders", "title": "Filled orders", "columns": [ { "id": "id" }, { "id": "price" }, { "id": "side" }, { "id": "createdDate" }, { "id": "qty" }, { "id": "orderId" }, { "id": "positionId" }, { "id": "tradableInstrumentId" } ] }, "accountDetailsConfig": { "id": "accountDetails", "title": "Account details", "columns": [ { "id": "balance", "description": "A current realized balance of an account." }, { "id": "projectedBalance", "description": "A future balance which includes all accrued and not accrued profit/loss." }, { "id": "availableFunds", "description": "Amount of funds which can be used for trading." }, { "id": "blockedBalance", "description": "Balance blocked by a broker or by a user for withdrawal/transfer." }, { "id": "cashBalance", "description": "A current cash position for an account with taken into account unsettled profit/loss." }, { "id": "unsettledCash", "description": "Cash sum of unsettled account operations, which have not been delivered to an account yet and will be delivered in accordance with T+n settlement system." }, { "id": "withdrawalAvailable", "description": "Shows an amount of cash that you can withdraw immediately from your account." }, { "id": "stocksValue", "description": "A total cost of assets, traded with Stock pre-paid margin type, positions of which are open on a selected account." }, { "id": "optionValue", "description": "Current option value in portfolio. Can be positive for a long Net position, or negative for a short Net position. Option value is calculated only for Options with Option trading style 'Premium-style' or 'Market-to-market'. Option trading style is set up by a broker." }, { "id": "initialMarginReq", "description": "Amount of initial margin blocked for all positions and orders taking into account a margin crossing." }, { "id": "maintMarginReq", "description": "Total margin used for maintenance of a current portfolio in account currency." }, { "id": "marginWarningLevel", "description": "Shows Maintenance margin level." }, { "id": "blockedForStocks", "description": "Amount of funds debited from a balance in case of trading with symbols with Stocks pre-paid margin type. After closing such position, funds will be returned to an account. Stock operations can be pending." }, { "id": "stockOrdersReq", "description": "Total margin blocked for orders with Stock pre-paid margin type." }, { "id": "stopOutLevel", "description": "Maintenance margin level value needed for the stop out to occur." }, { "id": "warningMarginReq", "description": "Warning margin requirement for positions and orders." }, { "id": "marginBeforeWarning", "description": "Margin available before warning triggering." }, { "id": "todayGross", "description": "A gross profit for today." }, { "id": "todayNet", "description": "A total profit or loss realized from positions today." }, { "id": "todayFees", "description": "Fees paid today." }, { "id": "todayVolume", "description": "A total volume traded for today." }, { "id": "todayTradesCount", "description": "A number of trades done for today." }, { "id": "openGrossPnL", "description": "A profit or loss on all currently opened positions and currency, recalculated in real-time based on the most recent quotes" }, { "id": "openNetPnL", "description": "A net profit or loss on open positions." }, { "id": "positionsCount", "description": "A number of currently opened positions." }, { "id": "ordersCount", "description": "A number of currently placed pending orders." } ] }, "rateLimits": [ { "rateLimitType": "GET_ACCOUNTS", "measure": "SECONDS", "intervalNum": 1, "limit": 2 }, { "rateLimitType": "GET_EXECUTIONS", "measure": "SECONDS", "intervalNum": 1, "limit": 2 }, { "rateLimitType": "GET_INSTRUMENTS", "measure": "SECONDS", "intervalNum": 1, "limit": 2 }, { "rateLimitType": "GET_ORDERS", "measure": "SECONDS", "intervalNum": 1, "limit": 1 }, { "rateLimitType": "GET_ORDERS_HISTORY", "measure": "SECONDS", "intervalNum": 1, "limit": 1 }, { "rateLimitType": "GET_POSITIONS", "measure": "SECONDS", "intervalNum": 1, "limit": 1 }, { "rateLimitType": "GET_ACCOUNTS_STATE", "measure": "SECONDS", "intervalNum": 2, "limit": 4 }, { "rateLimitType": "GET_INSTRUMENT_DETAILS", "measure": "SECONDS", "intervalNum": 1, "limit": 2 }, { "rateLimitType": "GET_TRADE_SESSIONS", "measure": "SECONDS", "intervalNum": 1, "limit": 2 }, { "rateLimitType": "GET_SESSION_STATUSES", "measure": "SECONDS", "intervalNum": 1, "limit": 2 }, { "rateLimitType": "PLACE_ORDER", "measure": "SECONDS", "intervalNum": 1, "limit": 5 }, { "rateLimitType": "MODIFY_ORDER", "measure": "SECONDS", "intervalNum": 1, "limit": 5 }, { "rateLimitType": "MODIFY_POSITION", "measure": "SECONDS", "intervalNum": 1, "limit": 5 }, { "rateLimitType": "DAILY_BAR", "measure": "SECONDS", "intervalNum": 1, "limit": 5 }, { "rateLimitType": "QUOTES", "measure": "SECONDS", "intervalNum": 1, "limit": 10 }, { "rateLimitType": "DEPTH", "measure": "SECONDS", "intervalNum": 1, "limit": 10 }, { "rateLimitType": "TRADES", "measure": "SECONDS", "intervalNum": 1, "limit": 5 }, { "rateLimitType": "QUOTES_HISTORY", "measure": "SECONDS", "intervalNum": 1, "limit": 3 } ], "limits": [ { "limitType": "QUOTES_HISTORY_BARS", "limit": 30000 }, { "limitType": "MAX_ORDERS_COUNT_IN_HISTORY", "limit": 10000 } ] } } }, "PanelConfig": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/components/schemas/Column" } }, "id": { "type": "string", "description": "Panel identifier." }, "title": { "type": "string", "description": "Localized title of a table" } }, "title": "PanelConfig" }, "Limits": { "type": "object", "properties": { "limitType": { "type": "string", "description": "Limit type" }, "limit": { "type": "integer", "description": "Limit value" } }, "title": "Limits" }, "RateLimits": { "type": "object", "properties": { "rateLimitType": { "type": "string", "description": "Limit type" }, "measure": { "type": "string", "description": "Frequency measurement unit (SECONDS or MINUTES)" }, "intervalNum": { "type": "integer", "description": "How many SECONDS/MINUTES are in the measured interval" }, "limit": { "type": "integer", "description": "Limit value (maximum number of allowed times in intervalNum SECONDS/MINUTES)" } }, "title": "RateLimits" }, "Permissions_to_use_specific_functions_and_information_in_the_client_terminal.": { "type": "object", "properties": { "filledOrders": { "type": "boolean", "description": "Whether the Executions tab is supported. If set to false, the /executions endpoint should not be used." }, "marketDepth": { "type": "boolean", "description": "Whether the Market depth is supported. If set to false, the /depth endpoint should not be used." }, "orders": { "type": "boolean", "description": "Whether the Orders tab is supported. If set to false, the /orders endpoint should not be used." }, "ordersHistory": { "type": "boolean", "description": "Whether the Orders history tab is supported. If set to false, the /ordersHistory endpoint should not be used" }, "positions": { "type": "boolean", "description": "Whether the Positions tab is supported. If set to false, the /positions endpoint should not be used." }, "symbolInfo": { "type": "boolean", "description": "Whether the Symbol info is supported. If set to false, the symbol_info endpoint should not be used." } }, "title": "Permissions to use specific functions and information in the client terminal." } } } } ```