Endpoint requirements
Before integrating your broker’s platform into TradingView, you should review the list of required and optional endpoints. This will allow you to understand which endpoints you need for the features you’d like to have.
tip
If you are not sure which endpoints you need in your particular case, contact the TradingView team.
Required endpoints
The endpoints listed below are required for trading integration.
| Endpoint | Description |
|---|---|
| /accounts | Gets a list of accounts (subaccounts) owned by a user. |
| /config | Gets localized configuration. |
| /instruments | Gets the list of the instruments that are available for trading with the specified account (subaccount). |
| /orders | Gets, places, modifies, or deletes orders for the account (subaccount). |
| /ordersHistory | Gets order history for an account (subaccount). All orders that come in response to /ordersHistory requests are displayed in the History tab. |
| /state | Gets account (subaccount) information. |
| /quotes | Gets the current prices of an instrument and its data restrictions. Must be implemented to avoid possible delays in fetching data from the exchange, which may lead users’ orders to execute at unexpected prices. |
Data-related endpoints
If you plan to integrate data, you also need to implement the following endpoints.
| Endpoint | Description |
|---|---|
| /symbol_info | Gets a list of all instruments and a set of rules for them. |
| /history | Gets history data for instruments. |
| /streaming | Gets real-time prices for instruments. |
| /groups | Gets a list of possible symbol groups. Required when you use different instrument types and when you need to restrict access to market data, hide symbols for some users, or prevent them from paying twice for a real-time data subscription. |
Optional endpoints
The table below describes optional endpoints which can be required in several cases.
| Endpoint | Description | When required |
|---|---|---|
| /authorize | Authenticates users by their usernames and passwords. | Required when you use Password Bearer authentication type. |
| /logout | Explicitly notifies the broker server that a user has finished working with the integration. | Required when supportLogout: true is set in the /accounts endpoint. Note that /logout is only needed for servers that do not automatically invalidate a token some time after it is no longer used in requests. |
| /positions | Gets, modifies, or deletes positions for a broker account (subaccount). | Required unless supportPositions: false is set in /accounts. Not used in Crypto Spot trading. Note that you should implement either /positions or /balances or both endpoints in your integration. |
| /balances | Gets crypto balances for an account (subaccount). | Required for Crypto brokers. Note that you should implement either /positions or /balances or both endpoints in your integration. |
| /executions | Gets a list of executions (fills or trades) for an account (subaccount) and an instrument. | Required when supportExecutions: true is set in /accounts. If /executions is not implemented, transactions will not be displayed on the Chart. |
| /previewOrder | Gets estimated cost, commission, and other order information without the order being placed or modified. | Required when either supportPlaceOrderPreview or supportModifyOrderPreview is set to true in /accounts. |
| /depth | Gets current depth of market for the instrument. | Required when supportLevel2Data: true is set in /accounts. |
| /getLeverage | Gets changes on every action users do in the order ticket. | Required when supportLeverage: true is set in /accounts. |
| /previewLeverage | Displays preview information when users edit the leverage. | Required when supportLeverage: true is set in /accounts. |
| /setLeverage | Sets the leverage when users confirm changing it. | Required when supportLeverage: true is set in /accounts. |
| /mapping | Gets all broker symbols that match the TradingView ones. | Required for symbol mapping when you use the TradingView market data that is available from a third-party source. |
| /permissions | Gets a list of symbol groups allowed for a user. | Required for restricting access to market data, hide symbols for some users, or prevent them from paying twice for a real-time data subscription. |
Streaming trading endpoints
The table below shows corresponding regular and streaming REST endpoints.
| REST | Streaming |
|---|---|
| /orders | /stream/orders |
| /state | /stream/state |
| /positions | /stream/positions |
| /quotes | /stream/quotes |
| /individualPosition | /stream/individualPositions |
| /netPositions | stream/netPositions |