TradingView REST API Specification for Brokers | Broker Integration Manual (2024)

{

• "s": "ok",

• "d": {

  • "access_token": "7133au-cba5a72-842029c",

  • "expiration": 1548661401

  }

{

• "s": "ok"

{

• "s": "ok",

• "d": {

  • "accountSummaryRow": [

    • {

      • "id": "accountBalance",

      • "title": "Account Balance"

      },

    • {

      • "id": "Equity",

      • "title": "Realized P/L"

      },

    • {

      • "id": "Open Profit",

      • "title": "Unrealized P/L"

      }

    ],

  • "accountManager": [

    • {

      • "id": "accountSummary",

      • "title": "",

      • "columns": [

        • {

          • "id": "todayPL",

          • "title": "Today's P&L"

          },

        • {

          • "id": "accountValue",

          • "title": "Account Value"

          },

        • {

          • "id": "balance",

          • "title": "Balance"

          },

        • {

          • "id": "totalMargin",

          • "title": "Margin"

          },

        • {

          • "id": "held",

          • "title": "Held"

          },

        • {

          • "id": "buyingPower",

          • "title": "Buying Power"

          }

        ]

      }

    ],

  • "durations": [

    • {

      • "id": "GTT",

      • "title": "Good Till Time",

      • "hasDatePicker": true,

      • "hasTimePicker": true,

      • "default": true,

      • "supportedOrderTypes": [

        • "stop",

        • "stoplimit"

        ]

      }

    ],

  • "orderCustomFields": [

    • {

      • "id": "commission",

      • "title": "Commission",

      • "tooltip": "Commission Fees",

      • "alignment": "right"

      }

    ],

  • "orderHistoryCustomFields": [

    • {

      • "id": "commission",

      • "title": "Commission",

      • "tooltip": "Commission Fees",

      • "alignment": "right"

      }

    ],

  • "positionCustomFields": [

    • {

      • "id": "exchangeFee",

      • "title": "Exchange fee",

      • "tooltip": "Exchange fee for the position",

      • "alignment": "right"

      },

    • {

      • "id": "routeFee",

      • "title": "Route fee",

      • "tooltip": "Route fee for the position",

      • "alignment": "right"

      }

    ],

  • "netPositionCustomFields": [

    • {

      • "id": "exchangeFee",

      • "title": "Exchange fee",

      • "tooltip": "Exchange fee for the position",

      • "alignment": "right"

      },

    • {

      • "id": "routeFee",

      • "title": "Route fee",

      • "tooltip": "Route fee for the position",

      • "alignment": "right"

      }

    ],

  • "individualPositionCustomFields": [

    • {

      • "id": "exchangeFee",

      • "title": "Exchange fee",

      • "tooltip": "Exchange fee for the position",

      • "alignment": "right"

      },

    • {

      • "id": "routeFee",

      • "title": "Route fee",

      • "tooltip": "Route fee for the position",

      • "alignment": "right"

      }

    ],

  • "pullingInterval": {

    • "quotes": 500,

    • "orders": 500,

    • "positions": 1000,

    • "accountManager": 1000,

    • "balances": 1000

    }

  }

{

• "s": "ok",

• "d": [

  • {

    • "id": "ACC-001",

    • "name": "Demo trading account",

    • "type": "demo",

    • "currency": "JPY",

    • "currencySign": "¥",

    • "config": {

      • "supportBrackets": true,

      • "supportOrderBrackets": false,

      • "supportAddBracketsToExistingOrder": true,

      • "supportMarketBrackets": true,

      • "supportPositionBrackets": false,

      • "supportPositions": true,

      • "supportMultiposition": false,

      • "supportClosePosition": false,

      • "supportPartialClosePosition": false,

      • "supportReversePosition": true,

      • "supportNativeReversePosition": false,

      • "supportMarketOrders": true,

      • "supportLimitOrders": true,

      • "supportStopOrders": true,

      • "supportStopLimitOrders": false,

      • "supportTrailingStop": false,

      • "supportGuaranteedStop": false,

      • "supportStopOrdersInBothDirections": false,

      • "supportStopLimitOrdersInBothDirections": false,

      • "supportPartialOrderExecution": false,

      • "supportModifyOrder": true,

      • "supportModifyOrderPrice": true,

      • "supportEditAmount": true,

      • "supportModifyBrackets": true,

      • "supportModifyDuration": false,

      • "supportCryptoExchangeOrderTicket": false,

      • "supportDigitalSignature": false,

      • "supportPlaceOrderPreview": false,

      • "supportModifyOrderPreview": false,

      • "showQuantityInsteadOfAmount": false,

      • "supportBalances": false,

      • "supportOrdersHistory": false,

      • "supportLeverage": false,

      • "supportLeverageButton": true,

      • "supportDOM": true,

      • "supportLevel2Data": false,

      • "supportPLUpdate": true,

      • "supportDisplayBrokerNameInSymbolSearch": true,

      • "supportLogout": false,

      • "supportCustomAccountSummaryRow": false,

      • "supportPositionCustomFields": false,

      • "supportOrderCustomFields": false,

      • "supportOrderHistoryCustomFields": false,

      • "supportTrackLatency": false,

      • "supportPositionNetting": false,

      • "supportIndividualPositionBrackets": false,

      • "supportCloseIndividualPosition": false,

      • "supportPartialCloseIndividualPosition": false,

      • "supportStrictCheckingLimitOrderPrice": false,

      • "supportRiskControlsAndInfo": true

      },

    • "ui": {

      • "accountSummaryRow": [

        • {

          • "id": "accountBalance",

          • "title": "Account Balance"

          },

        • {

          • "id": "Equity",

          • "title": "Realized P/L"

          },

        • {

          • "id": "Open Profit",

          • "title": "Unrealized P/L"

          }

        ],

      • "accountManager": [

        • {

          • "id": "accountSummary",

          • "title": "",

          • "columns": [

            • {

              • "id": "todayPL",

              • "title": "Today's P&L"

              },

            • {

              • "id": "accountValue",

              • "title": "Account Value"

              },

            • {

              • "id": "balance",

              • "title": "Balance"

              },

            • {

              • "id": "totalMargin",

              • "title": "Margin"

              },

            • {

              • "id": "held",

              • "title": "Held"

              },

            • {

              • "id": "buyingPower",

              • "title": "Buying Power"

              }

            ]

          }

        ],

      • "orderCustomFields": [

        • {

          • "id": "commission",

          • "title": "Commission",

          • "tooltip": "Commission Fees",

          • "alignment": "right"

          }

        ],

      • "orderHistoryCustomFields": [

        • {

          • "id": "commission",

          • "title": "Commission",

          • "tooltip": "Commission Fees",

          • "alignment": "right"

          }

        ],

      • "positionCustomFields": [

        • {

          • "id": "exchangeFee",

          • "title": "Exchange fee",

          • "tooltip": "Exchange fee for the position",

          • "alignment": "right"

          },

        • {

          • "id": "routeFee",

          • "title": "Route fee",

          • "tooltip": "Route fee for the position",

          • "alignment": "right"

          }

        ],

      • "netPositionCustomFields": [

        • {

          • "id": "exchangeFee",

          • "title": "Exchange fee",

          • "tooltip": "Exchange fee for the position",

          • "alignment": "right"

          },

        • {

          • "id": "routeFee",

          • "title": "Route fee",

          • "tooltip": "Route fee for the position",

          • "alignment": "right"

          }

        ],

      • "individualPositionCustomFields": [

        • {

          • "id": "exchangeFee",

          • "title": "Exchange fee",

          • "tooltip": "Exchange fee for the position",

          • "alignment": "right"

          },

        • {

          • "id": "routeFee",

          • "title": "Route fee",

          • "tooltip": "Route fee for the position",

          • "alignment": "right"

          }

        ],

      • "orderDialogCustomFields": {

        • "comboBox": [

          • {

            • "id": "customInputFieldId",

            • "title": "Additional parameters",

            • "saveToSettings": true,

            • "mutable": false,

            • "forceUserEnterInitialValue": true,

            • "items": [

              • {

                • "text": "text",

                • "value": "value"

                }

              ]

            }

          ],

        • "checkbox": [

          • {

            • "id": "customInputFieldId",

            • "title": "Additional parameter",

            • "saveToSettings": true,

            • "help": "Brief help text",

            • "checked": false,

            • "mutable": false

            }

          ],

        • "textField": [

          • {

            • "id": "customInputFieldId",

            • "title": "Additional parameters",

            • "saveToSettings": true,

            • "mutable": false,

            • "forceUserEnterInitialValue": true,

            • "placeholder": "string",

            • "maskWithAsterisk": false

            }

          ]

        },

      • "orderDialogLinks": [

        • {

          • "text": "Rules",

          • "url": "https://my-broker.com/rules-and-conditions"

          }

        ]

      },

    • "durations": [

      • {

        • "id": "GTT",

        • "title": "Good Till Time",

        • "hasDatePicker": true,

        • "hasTimePicker": true,

        • "default": true,

        • "supportedOrderTypes": [

          • "stop",

          • "stoplimit"

          ]

        }

      ],

    • "prefix": "NASDAQ",

    • "isVerified": true,

    • "connectWarningConfig": {

      • "key": "string",

      • "skippable": false

      }

    }

  ]

{

• "s": "ok",

• "d": [

  • {

    • "name": "EURUSD",

    • "description": "EUR/USD",

    • "minQty": 1,

    • "maxQty": 100000000,

    • "qtyStep": 100,

    • "pipSize": 0.0001,

    • "pipValue": 0.00008845,

    • "minTick": 0.00001,

    • "lotSize": 10,

    • "currency": "EUR",

    • "baseCurrency": "LTC",

    • "quoteCurrency": "BTC",

    • "marginRate": 0.05,

    • "hasQuotes": false,

    • "units": "string",

    • "variableMinTick": "0.01 10 0.02 25 0.05",

    • "type": "forex",

    • "typespecs": "crypto,cfd",

    • "ui": {

      • "orderDialogCustomFields": {

        • "comboBox": [

          • {

            • "id": "customInputFieldId",

            • "title": "Additional parameters",

            • "saveToSettings": true,

            • "mutable": false,

            • "forceUserEnterInitialValue": true,

            • "items": [

              • {

                • "text": "text",

                • "value": "value"

                }

              ]

            }

          ],

        • "checkbox": [

          • {

            • "id": "customInputFieldId",

            • "title": "Additional parameter",

            • "saveToSettings": true,

            • "help": "Brief help text",

            • "checked": false,

            • "mutable": false

            }

          ],

        • "textField": [

          • {

            • "id": "customInputFieldId",

            • "title": "Additional parameters",

            • "saveToSettings": true,

            • "mutable": false,

            • "forceUserEnterInitialValue": true,

            • "placeholder": "string",

            • "maskWithAsterisk": false

            }

          ]

        },

      • "validationRules": [

        • {

          • "id": "slPercent",

          • "options": {

            • "min": 10,

            • "max": 90

            }

          },

        • {

          • "id": "tpPercent",

          • "options": {

            • "min": 10,

            • "max": 90

            }

          },

        • {

          • "id": "limitPercent",

          • "options": {

            • "min": 10,

            • "max": 20

            }

          },

        • {

          • "id": "stopPercent",

          • "options": {

            • "min": 10,

            • "max": 20

            }

          },

        • {

          • "id": "gsPercent",

          • "options": {

            • "min": 10,

            • "max": 20

            }

          }

        ]

      }

    }

  ]

{

• "s": "ok",

• "d": {

  • "balance": 41757.91,

  • "unrealizedPl": 1053.02,

  • "equity": 42857.56,

  • "amData": [

    • [

      • [

        • "90.22",

        • "42857.56",

        • "42857.56",

        • "1099.65",

        • "0.00",

        • "41757.91"

        ]

      ]

    ],

  • "accountSummaryRowData": [

    • "96883.89",

    • "96837.12",

    • "-46.77"

    ]

  }

{

• "balance": 41757.91,

• "unrealizedPl": 1053.02,

• "equity": 42857.56,

• "amData": [

  • [

    • [

      • "90.22",

      • "42857.56",

      • "42857.56",

      • "1099.65",

      • "0.00",

      • "41757.91"

      ]

    ]

  ],

• "accountSummaryRowData": [

  • "96883.89",

  • "96837.12",

  • "-46.77"

  ]

{

• "s": "ok",

• "d": [

  • {

    • "id": "1",

    • "instrument": "EURUSD",

    • "qty": 100,

    • "side": "buy",

    • "type": "limit",

    • "avgPrice": 0,

    • "limitPrice": 1.14344,

    • "duration": {

      • "type": "gtt",

      • "datetime": 1548406235

      },

    • "status": "working",

    • "customFields": [

      • {

        • "id": "commission",

        • "value": "1.25"

        }

      ]

    },

  • {

    • "id": "2",

    • "instrument": "EURUSD",

    • "qty": 100,

    • "side": "sell",

    • "type": "limit",

    • "filledQty": 50,

    • "avgPrice": 0,

    • "limitPrice": 1.15094,

    • "parentId": "1",

    • "parentType": "order",

    • "duration": {

      • "type": "gtt",

      • "datetime": 1548406235

      },

    • "status": "inactive",

    • "customFields": [

      • {

        • "id": "commission",

        • "value": ""

        }

      ]

    },

  • {

    • "id": "3",

    • "instrument": "EURUSD",

    • "qty": 1000000,

    • "side": "sell",

    • "type": "limit",

    • "filledQty": 0,

    • "avgPrice": 0,

    • "limitPrice": 1.15094,

    • "parentId": "1",

    • "parentType": "order",

    • "duration": {

      • "type": "gtt",

      • "datetime": 1548406235

      },

    • "status": "rejected",

    • "message": {

      • "text": "This order has been rejected due to the closed market",

      • "type": "error"

      }

    }

  ]

[

• {

  • "id": "1",

  • "instrument": "EURUSD",

  • "qty": 101,

  • "side": "buy",

  • "type": "limit",

  • "avgPrice": 0,

  • "limitPrice": 1.2093,

  • "duration": {

    • "type": "gtt",

    • "datetime": 1548406235

    },

  • "status": "working",

  • "customFields": [

    • {

      • "id": "commission",

      • "value": "1.25"

      }

    ]

  }

{

• "s": "ok",

• "d": [

  • {

    • "id": "1",

    • "instrument": "EURUSD",

    • "qty": 1,

    • "side": "buy",

    • "avgPrice": 1.1347091,

    • "unrealizedPl": 19.4739,

    • "message": {

      • "text": "You can add brackets to this position to protect it",

      • "type": "Information"

      },

    • "customFields": [

      • {

        • "id": "string",

        • "value": "string"

        }

      ]

    }

  ]

[

• {

  • "id": "1",

  • "instrument": "EURUSD",

  • "qty": 1,

  • "side": "buy",

  • "avgPrice": 1.1347091,

  • "unrealizedPl": 19.4739,

  • "message": {

    • "text": "You can add brackets to this position to protect it",

    • "type": "Information"

    },

  • "customFields": [

    • {

      • "id": "customField1",

      • "value": "Value of custom field"

      }

    ]

  },

• {

  • "id": "2",

  • "qty": 0

  }

{

• "s": "ok",

• "d": [

  • {

    • "id": "1",

    • "instrument": "EURUSD",

    • "qty": 1,

    • "longQty": 2,

    • "shortQty": 1,

    • "avgPrice": 1.23,

    • "customFields": [

      • {

        • "id": "string",

        • "value": "string"

        }

      ],

    • "message": {

      • "text": "You can add brackets to this position to protect it",

      • "type": "Information"

      }

    }

  ]

[

• {

  • "id": "np1",

  • "instrument": "EUR/USD",

  • "qty": 90,

  • "side": "buy",

  • "longQty": 90,

  • "shortQty": 0,

  • "avgPrice": 1.1247

  },

• {

  • "id": "np2",

  • "qty": 0

  }

{

• "s": "ok",

• "d": [

  • {

    • "id": "1",

    • "instrument": "EURUSD",

    • "date": "1683818630353",

    • "qty": 1,

    • "side": "buy",

    • "price": 23.274,

    • "unrealizedPl": 3.094,

    • "customFields": [

      • {

        • "id": "string",

        • "value": "string"

        }

      ],

    • "message": {

      • "text": "You can add brackets to this position to protect it",

      • "type": "Information"

      }

    }

  ]

[

• {

  • "id": "ip1",

  • "instrument": "EUR/USD",

  • "qty": 50,

  • "side": "buy",

  • "price": 1.1347,

  • "pl": 555.44

  },

• {

  • "id": "ip2",

  • "instrument": "EUR/USD",

  • "qty": 40,

  • "side": "buy",

  • "price": 1.12,

  • "pl": 405.44

  },

• {

  • "id": "ip3",

  • "qty": 0

  }

{

• "s": "ok",

• "d": [

  • {

    • "symbol": "BTC",

    • "longName": "Bitcoin",

    • "total": 1000,

    • "available": 10,

    • "reserved": 90,

    • "btcValue": 1000,

    • "value": 100000,

    • "valueCurrency": "USD"

    }

  ]

{

• "s": "ok",

• "d": [

  • {

    • "id": "EX34567",

    • "instrument": "EURUSD",

    • "price": 1.23564,

    • "time": 1548406235,

    • "qty": 1,

    • "side": "buy",

    • "orderId": "1263159154",

    • "isClose": false,

    • "positionId": "10098",

    • "commission": 0.004

    }

  ]

{

• "s": "ok",

• "d": [

  • {

    • "id": "1",

    • "instrument": "EURUSD",

    • "qty": 100,

    • "side": "buy",

    • "type": "limit",

    • "avgPrice": 0,

    • "limitPrice": 1.14344,

    • "duration": {

      • "type": "gtt",

      • "datetime": 1548406235

      },

    • "status": "filled"

    },

  • {

    • "id": "2",

    • "instrument": "EURUSD",

    • "qty": 100,

    • "side": "sell",

    • "type": "limit",

    • "filledQty": 50,

    • "avgPrice": 0,

    • "limitPrice": 1.15094,

    • "parentId": "1",

    • "parentType": "order",

    • "duration": {

      • "type": "gtt",

      • "datetime": 1548406235

      },

    • "status": "cancelled"

    }

  ]

{

• "s": "ok",

• "d": {

  • "title": "Adjust Leverage",

  • "leverage": 5,

  • "min": 1,

  • "max": 10,

  • "step": 1

  }

{

• "s": "ok",

• "d": {

  • "leverage": 25

  }

{

• "s": "ok",

• "d": {

  • "infos": [

    • "Borrowing limit at current leverage 0.3057 BTC or 0.00000 USDT",

    • "Required position margin at current leverage 0.3057 BTC"

    ],

  • "warnings": [

    • "Your leverage is comparatively high. Please be aware of risks"

    ],

  • "errors": [

    • "Invalid leverage value"

    ]

  }