BCS Trade API

https://trade-api.bcs.ru
Admin
BCS Trade API is a trading API platform that enables developers to build custom trading programs,...
Tokens:68,681
Snippets:364
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Daily Schedule Example

Source: https://trade-api.bcs.ru/http/information/get-daily-schedule

This example demonstrates how to retrieve the daily trading schedule for a security. Ensure you provide valid 'classCode' and 'ticker' as query parameters.

```http
GET
## https://be.broker.ru/trade-api-information-service/api/v1/trading-schedule/daily-schedule
```

--------------------------------

### Daily Schedule Response Example

Source: https://trade-api.bcs.ru/http/information/get-daily-schedule

This is an example of a successful response (200 OK) for the daily trading schedule. It indicates if it's a workday and lists the trading sessions.

```json
{
  "isWorkDay": true,
  "dailySchedule": [
    {
      "startDate": "14:30:00",
      "endDate": "14:30:00",
      "tradingSessionType": "Технический перерыв QUIK",
      "tradingSessionStatus": "OPEN"
    }
  ]
}
```

--------------------------------

### Retrieve Instruments Discounts using HttpClient in C#

Source: https://trade-api.bcs.ru/http/get-instruments-discounts

Example of how to make a GET request to the instruments discounts endpoint using HttpClient in C#. Ensure to replace `<token>` with a valid JWT.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://be.broker.ru/trade-api-bff-marginal-indicators/api/v1/instruments-discounts");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Example

Source: https://trade-api.bcs.ru/http/operations/status

Demonstrates how to make a GET request with Bearer Token authentication using C#'s HttpClient. Ensure the Authorization header is correctly formatted with your JWT.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://be.broker.ru/trade-api-bff-operations/api/v1/orders/:originalClientOrderId");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### C# HttpClient Example

Source: https://trade-api.bcs.ru/http/authorization

Example of how to request an access token using HttpClient in C#. Ensure the `Content-Type` header is set to `application/x-www-form-urlencoded`.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://be.broker.ru/trade-api-keycloak/realms/tradeapi/protocol/openid-connect/token");
request.Headers.Add("Accept", "application/json");
var content = new StringContent(string.Empty);
content.Headers.ContentType = new MediaTypeHeaderValue("application/x-www-form-urlencoded");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Example

Source: https://trade-api.bcs.ru/http/information/get-daily-schedule

This C# code snippet demonstrates how to make a GET request to the daily trading schedule endpoint using HttpClient. Remember to replace '<token>' with your actual JWT token.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://be.broker.ru/trade-api-information-service/api/v1/trading-schedule/daily-schedule");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Trading Status - C# Example

Source: https://trade-api.bcs.ru/http/information/get-trading-status

This C# code snippet demonstrates how to make a GET request to the trading schedule status endpoint using HttpClient. Ensure you replace `<token>` with a valid JWT.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://be.broker.ru/trade-api-information-service/api/v1/trading-schedule/status");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Connect to Portfolio WebSocket in Java

Source: https://trade-api.bcs.ru/websocket/portfolio

This Java example uses OkHttp to establish a WebSocket connection to the portfolio API. Replace 'YOUR_ACCESS_TOKEN' with your valid token.

```java
import okhttp3.*;  

public class PortfolioWs {  
    public static void main(String[] args) {  
        OkHttpClient client = new OkHttpClient();  

        Request request = new Request.Builder()  
            .url("wss://ws.broker.ru/trade-api-bff-portfolio/api/v1/portfolio/ws")  
            .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN")  
            .build();  

        WebSocketListener listener = new WebSocketListener() {  
            @Override  
            public void onOpen(WebSocket webSocket, Response response) {  
                System.out.println("connected");  
            }  

            @Override  
            public void onMessage(WebSocket webSocket, String text) {  
                System.out.println(text);  
            }  

            @Override  
            public void onFailure(WebSocket webSocket, Throwable t, Response response) {  
                t.printStackTrace();  
            }  
        };  

        client.newWebSocket(request, listener);  
    }  
}  
```

--------------------------------

### Connect to Portfolio WebSocket in Python

Source: https://trade-api.bcs.ru/websocket/portfolio

This Python example demonstrates connecting to the portfolio WebSocket API using the 'websockets' library. Replace 'YOUR_ACCESS_TOKEN' with your valid token.

```python
import asyncio  
import json  
import websockets  

URL = "wss://ws.broker.ru/trade-api-bff-portfolio/api/v1/portfolio/ws"  
TOKEN = "YOUR_ACCESS_TOKEN"  

async def main():  
    async with websockets.connect(  
        URL,  
        additional_headers={"Authorization": f"Bearer {TOKEN}"},  
    ) as ws:  
        async for message in ws:  
            data = json.loads(message)  
            print(data)  

if __name__ == "__main__":  
    asyncio.run(main())  
```

--------------------------------

### 200 OK Response Schema and Example

Source: https://trade-api.bcs.ru/http/operations/status

This is the schema and an example of a successful response (HTTP 200 OK) for an operation. It includes details about order status, execution, and trade information.

```json
{
  "clientOrderId": "string",
  "originalClientOrderId": "string",
  "data": {
    "messageType": "string",
    "orderStatus": "0",
    "executionType": "0",
    "orderQuantity": 0,
    "executedQuantity": 0,
    "lastQuantity": 0,
    "remainedQuantity": 0,
    "ticker": "string",
    "classCode": "string",
    "side": "1",
    "orderType": "1",
    "averagePrice": 0,
    "orderId": "string",
    "executionId": "string",
    "price": 0,
    "currency": "string",
    "clientCode": "string",
    "transactionTime": "2024-07-29T15:51:28.071Z",
    "tradeDate": "2024-07-29",
    "orderNumber": "string",
    "accruedCoupon": 0,
    "executionValue": 0,
    "commission": 0,
    "securityExchange": "string",
    "rejectReason": "string"
  }
}
```

--------------------------------

### Instrument Response Example

Source: https://trade-api.bcs.ru/http/information/get-instruments-by-type-and-base-asset-ticker

This is an example of a successful response when retrieving instrument data. It includes detailed information about various financial instruments.

```json
[
  {
    "ticker": "string",
    "boards": [
      {
        "classCode": "TQBR",
        "exchange": "MOEX"
      }
    ],
    "shortName": "string",
    "displayName": "string",
    "type": "CURRENCY",
    "isin": "string",
    "registrationCode": "string",
    "issuerName": "string",
    "tradingCurrency": "string",
    "faceValue": 0,
    "scale": 0,
    "minimumStep": 0,
    "accruedInt": 0,
    "currencyStepPrice": "string",
    "settleCode": "string",
    "instrumentType": "CURRENCY",
    "settlementCurrency": "string",
    "settlementDate": "2024-07-29T15:51:28.071Z",
    "maturityDate": "Unknown Type: date-time",
    "lotSize": 0,
    "isQualifiedOnly": true,
    "isCanShort": true,
    "baseAsset": "string",
    "qualifiedTestId": 0,
    "qualifiedTestIdTm": 0,
    "availableForUnqualified": true,
    "currencyNominal": "string",
    "stepPrice": 0,
    "isBcsProduct": true,
    "couponsPerYear": 0,
    "couponRate": 0,
    "nextCoupon": "2024-07-29T15:51:28.071Z",
    "complexProduct": 0,
    "baseAssetFuture": "string",
    "subType": "string",
    "percentTargetCurrent": 0,
    "businessSector": "string",
    "peNorm": 0,
    "priceTangible": 0,
    "epsGrowthRate": 0,
    "predictedDps": 0,
    "dividendYield": 0,
    "priceChangeYear": 0,
    "targetPrice": 0,
    "mktcap": 0,
    "isBlocked": true,
    "businessSectorId": 0,
    "primaryBoard": "string",
    "secondaryBoards": [
      "string"
    ],
    "isCanMargin": true,
    "isReplacementBond": true,
    "subTitle": "string",
    "couponTypeName": "string",
    "emissionDate": "Unknown Type: date-time",
    "creditRating": "string",
    "liquidityRating": "string",
    "bcsScore": 0,
    "bcsScoreColor": "string",
    "nrdCode": "string",
    "strike": 0,
    "baseAssetSecuritySecCode": "string",
    "baseAssetSecurityClassCode": "string",
    "businessCountry": "string",
    "businessCountryCode": "string",
    "priceChangeHalfYear": 0,
    "priceChangeMonth": 0,
    "priceChangeEarlyYear": 0,
    "firstCurrCode": "string",
    "amortisedMty": true
  }
]
```

--------------------------------

### Connect to WebSocket Limits API with Python

Source: https://trade-api.bcs.ru/websocket/limits

This Python example shows how to establish a WebSocket connection to the Limits API. Replace 'YOUR_ACCESS_TOKEN' with your valid token.

```python
import asyncio
import json
import websockets

URL = "wss://ws.broker.ru/trade-api-bff-limit/api/v1/limits/ws"
TOKEN = "YOUR_ACCESS_TOKEN"

async def main():
    async with websockets.connect(
        URL,
        additional_headers={"Authorization": f"Bearer {TOKEN}"},
    ) as ws:
        async for message in ws:
            data = json.loads(message)
            print(data)

if __name__ == "__main__":
    asyncio.run(main())
```

--------------------------------

### Trading Schedule Status Response Example

Source: https://trade-api.bcs.ru/http/information/get-trading-status

This is an example of a successful JSON response when retrieving trading schedule status. It includes session ID, type, status, and the next session change time.

```json
{
  "tradingSessionTypeId": 0,
  "tradingSessionType": "string",
  "tradingSessionStatus": "OPEN",
  "nextSessionDate": "2024-07-29T15:51:28.071Z"
}
```

--------------------------------

### Connect to WebSocket Limits API with C#

Source: https://trade-api.bcs.ru/websocket/limits

A C# example for connecting to the WebSocket Limits API. Ensure you replace 'YOUR_ACCESS_TOKEN' with your valid token.

```csharp
using System;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var ws = new ClientWebSocket();
        ws.Options.SetRequestHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN");

        await ws.ConnectAsync(
            new Uri("wss://ws.broker.ru/trade-api-bff-limit/api/v1/limits/ws"),
            CancellationToken.None
        );

        var buffer = new byte[8192];

        while (ws.State == WebSocketState.Open)
        {
            var result = await ws.ReceiveAsync(buffer, CancellationToken.None);
            if (result.MessageType == WebSocketMessageType.Close)
            {
                break;
            }

            var json = Encoding.UTF8.GetString(buffer, 0, result.Count);
            Console.WriteLine(json);
        }

    }

}
```

--------------------------------

### All Order List Response (200 OK)

Source: https://trade-api.bcs.ru/http/operations/all-order-list

This is an example of a successful response when retrieving a list of orders. It includes an array of order records and pagination information.

```json
{
  "records": [
    {
      "orderNum": 0,
      "orderId": "string",
      "clientCode": "string",
      "executionDateTime": "2024-07-29T15:51:28.071Z",
      "executedValue": 0,
      "orderDateTime": "2024-07-29T15:51:28.071Z",
      "tradeDate": "2024-07-29",
      "updateDateTime": "2024-07-29T15:51:28.071Z",
      "ticker": "string",
      "classCode": "string",
      "takePrice": 0,
      "stopPrice": 0,
      "price": 0,
      "settlementCurrency": "string",
      "orderQuantity": 0,
      "remainedQuantity": 0,
      "executedQuantity": 0,
      "rejectReason": "string",
      "averagePrice": 0,
      "calculationVolume": 0,
      "contractSum": 0,
      "orderStatus": 1,
      "orderType": 1,
      "side": 1,
      "orderQuantityLots": 0,
      "remainedQuantityLots": 0,
      "executedQuantityLots": 0,
      "linkedOrder": "string",
      "stopOrder": "string",
      "visible": 0,
      "marketTakeProfit": 1,
      "marketStopLoss": 1,
      "positionPriceStop": 0,
      "positionPriceLimit": 0
    }
  ],
  "totalRecords": 0,
  "totalPages": 0
}
```

--------------------------------

### Connect to Execution Status WebSocket in Go

Source: https://trade-api.bcs.ru/websocket/operations/execution-status

Use the 'gorilla/websocket' package to establish a connection and read messages. This example includes error handling and deferring the connection close. Replace 'YOUR_ACCESS_TOKEN' with your actual token.

```go
package main  

import (  
    "log"  
    "net/http"  

    "github.com/gorilla/websocket"  
)  

func main() {  
    header := http.Header{}  
    header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")  

    c, _, err := websocket.DefaultDialer.Dial(  
        "wss://ws.broker.ru/trade-api-bff-operations/api/v1/orders/execution/ws",  
        header,  
    )  
    if err != nil {  
        log.Fatal("dial:", err)  
    }  
    defer c.Close()  

    for {  
        _, message, err := c.ReadMessage()  
        if err != nil {  
            log.Println("read:", err)  
            return  
        }  
        log.Printf("received: %s", message)  
    }  
}  
```

--------------------------------

### Connect to Portfolio WebSocket in C#

Source: https://trade-api.bcs.ru/websocket/portfolio

This C# example shows how to connect to the portfolio WebSocket API using the built-in ClientWebSocket class. Ensure you replace 'YOUR_ACCESS_TOKEN' with your actual token.

```csharp
using System;  
using System.Net.WebSockets;  
using System.Text;  
using System.Threading;  
using System.Threading.Tasks;  

class Program  
{  
    static async Task Main()  
    {  
        using var ws = new ClientWebSocket();  
        ws.Options.SetRequestHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN");  

        await ws.ConnectAsync(  
            new Uri("wss://ws.broker.ru/trade-api-bff-portfolio/api/v1/portfolio/ws"),  
            CancellationToken.None  
        );  

        var buffer = new byte[8192];  

        while (ws.State == WebSocketState.Open)  
        {  
            var result = await ws.ReceiveAsync(buffer, CancellationToken.None);  
            if (result.MessageType == WebSocketMessageType.Close)  
            {  
                break;  
            }  

            var json = Encoding.UTF8.GetString(buffer, 0, result.Count);  
            Console.WriteLine(json);  
        }  
    }  
}  
```

--------------------------------

### Connect to Portfolio WebSocket in Go

Source: https://trade-api.bcs.ru/websocket/portfolio

Connect to the portfolio WebSocket endpoint using Go's 'gorilla/websocket' library. Remember to substitute 'YOUR_ACCESS_TOKEN' with your actual authentication token.

```go
package main  

import (  
    "log"  
    "net/http"  

    "github.com/gorilla/websocket"  
)  

func main() {  
    header := http.Header{}  
    header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")  

    c, _, err := websocket.DefaultDialer.Dial(  
        "wss://ws.broker.ru/trade-api-bff-portfolio/api/v1/portfolio/ws",  
        header,  
    )  
    if err != nil {  
        log.Fatal("dial:", err)  
    }  
    defer c.Close()  

    for {  
        _, message, err := c.ReadMessage()  
        if err != nil {  
            log.Println("read:", err)  
            return  
        }  
        log.Printf("received: %s", message)  
    }  
}  
```

--------------------------------

### Update Order Request Body Example

Source: https://trade-api.bcs.ru/http/operations/update

This is an example of the JSON body required to update an order. It includes the client-generated order ID, price, and quantity.

```json
{
  "clientOrderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "price": 0,
  "orderQuantity": 0
}
```

--------------------------------

### Subscribe to Market Data Quotes in Java

Source: https://trade-api.bcs.ru/websocket/market-data/quotes

Use the OkHttp library to create a WebSocket client for receiving market data. Replace 'YOUR_ACCESS_TOKEN' with your actual token.

```java
import okhttp3.*;  

public class QuotesWs {  

    public static void main(String[] args) {  

        OkHttpClient client = new OkHttpClient();  

  

        Request request = new Request.Builder()  

            .url("wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws")  

            .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN")  

            .build();  

  

        WebSocketListener listener = new WebSocketListener() {  

            @Override  

            public void onOpen(WebSocket webSocket, Response response) {  

                String subscribeMessage = """

                    {

                      "subscribeType": 0,

                      "dataType": 3,

                      "instruments": [

                        { "ticker": "SBER", "classCode": "TQBR" }

                      ]

                    }

                    """;

                webSocket.send(subscribeMessage);  

            }

  

            @Override  

            public void onMessage(WebSocket webSocket, String text) {  

                System.out.println(text);  

            }  

  

            @Override  

            public void onFailure(WebSocket webSocket, Throwable t, Response response) {  

                t.printStackTrace();  

            }  

        };  

  

        client.newWebSocket(request, listener);  

    }  

}  
```

--------------------------------

### Get List of All Orders

Source: https://trade-api.bcs.ru/http/operations

Retrieves a list of all orders.

```APIDOC
## GET /orders

### Description
Retrieves a list of all orders.

### Method
GET

### Endpoint
/orders
```

--------------------------------

### Subscribe to Market Data Quotes in Go

Source: https://trade-api.bcs.ru/websocket/market-data/quotes

Use the 'gorilla/websocket' library to connect and subscribe to market data. Remember to replace 'YOUR_ACCESS_TOKEN' with your actual authentication token.

```go
package main  

import (  

    "log"  

    "net/http"  


    "github.com/gorilla/websocket"  

)  

  

func main() {  

    header := http.Header{}  

    header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")  


    c, _, err := websocket.DefaultDialer.Dial(  

        "wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws",  

        header,  

    )  

    if err != nil {  

        log.Fatal("dial:", err)  

    }  

    defer c.Close()  

  

    subscribeMessage := map[string]interface{}{  

        "subscribeType": 0,  

        "dataType":       3,  

        "instruments": []map[string]string{  

            {"ticker": "SBER", "classCode": "TQBR"},  

        },  

    }  

  

    if err := c.WriteJSON(subscribeMessage); err != nil {  

        log.Fatal("write:", err)  

    }  

  

    for {  

        var payload map[string]interface{}  

        if err := c.ReadJSON(&payload); err != nil {  

            log.Println("read:", err)  

            return  

        }  

        log.Printf("received: %#v", payload)  

    }  

}  
```

--------------------------------

### Get Order Status

Source: https://trade-api.bcs.ru/http/operations

Retrieves the status of a previously created order.

```APIDOC
## GET /orders/{orderId}/status

### Description
Retrieves the status of a created order.

### Method
GET

### Endpoint
/orders/{orderId}/status

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The ID of the order to check.
```

--------------------------------

### Get Limits Information

Source: https://trade-api.bcs.ru/http/limits

Retrieves information about your portfolio via the Limits service.

```APIDOC
## GET https://be.broker.ru/trade-api-bff-limit/api/v1/limits

### Description
Retrieves information about your portfolio through the Limits service.

### Method
GET

### Endpoint
https://be.broker.ru/trade-api-bff-limit/api/v1/limits
```

--------------------------------

### Connect to Marginal Indicators WebSocket API in Java

Source: https://trade-api.bcs.ru/websocket/marginal-indicators

This example uses the OkHttp library to connect to the WebSocket. Replace 'YOUR_ACCESS_TOKEN' with your valid token. Implement a WebSocketListener to handle connection events and messages.

```java
import okhttp3.*;  

public class MarginalIndicatorsWs {  
    public static void main(String[] args) {  
        OkHttpClient client = new OkHttpClient();  

        Request request = new Request.Builder()  
            .url("wss://ws.broker.ru/trade-api-bff-marginal-indicators/api/v1/marginal-indicators/ws")  
            .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN")  
            .build();  

        WebSocketListener listener = new WebSocketListener() {  
            @Override  
            public void onOpen(WebSocket webSocket, Response response) {  
                System.out.println("connected");  
            }  

            @Override  
            public void onMessage(WebSocket webSocket, String text) {  
                System.out.println(text);  
            }  

            @Override  
            public void onFailure(WebSocket webSocket, Throwable t, Response response) {  
                t.printStackTrace();  
            }  
        };  

        client.newWebSocket(request, listener);  
    }  
}  
```

--------------------------------

### Get Daily Schedule

Source: https://trade-api.bcs.ru/http/information/get-daily-schedule

Fetches the daily trading schedule for a specified instrument.

```APIDOC
## GET /trading-schedule/daily-schedule

### Description
Retrieves the daily trading schedule for a specific financial instrument.

### Method
GET

### Endpoint
https://be.broker.ru/trade-api-information-service/api/v1/trading-schedule/daily-schedule

### Parameters
#### Query Parameters
- **classCode** (string) - Required - Code of the security class. Possible values: `non-empty`. Example: `TQBR`
- **ticker** (string) - Required - Ticker of the instrument. Possible values: `non-empty`. Example: `SBER`

### Response
#### Success Response (200)
- **isWorkDay** (boolean) - Indicates if it is a working day.
- **dailySchedule** (object[]) - Full daily schedule. Each object contains:
  - **startDate** (string) - Start time of the session. Example: `14:30:00`
  - **endDate** (string) - End time of the session. Example: `14:30:00`
  - **tradingSessionType** (string) - Name of the current session. Possible values: `Технический перерыв QUIK`, `Аукцион открытия`, `Не рабочее время/Выходной/Праздник`, `Вечерняя торговая сессия`, `Торговый период`, `Аукцион закрытия`
  - **tradingSessionStatus** (string) - Status of the session. Possible values: `OPEN`, `CLOSE`

#### Response Example (200)
{
  "isWorkDay": true,
  "dailySchedule": [
    {
      "startDate": "14:30:00",
      "endDate": "14:30:00",
      "tradingSessionType": "Технический перерыв QUIK",
      "tradingSessionStatus": "OPEN"
    }
  ]
}

#### Error Response (429)
- **timestamp** (int64) - Timestamp of the error.
- **traceId** (string) - Trace ID for the error.
- **type** (string) - Type of the error. Possible values: `VALIDATION_ERROR`, `RESOURCE_EXHAUSTED`, `USER_BLOCKED`, `BAD_REQUEST`, `NOT_FOUND`, `UNAUTHORIZED`, `FORBIDDEN`, `CONFLICT`, `INTERNAL_SERVER_ERROR`, `SESSION_NOT_FOUND_ERROR`, `SESSION_EXPIRED_ERROR`, `SESSION_FAILED_ERROR`
- **errors** (object[]) - Array of specific errors.
- **displayOptions** (object) - Options for displaying the error.

#### Response Example (429)
{
  "timestamp": 0,
  "traceId": "string",
  "type": "VALIDATION_ERROR",
  "errors": [
    {
      "type": "string",
      "field": "string",
      "payload": {}
    }
  ],
  "displayOptions": {}
}
```

--------------------------------

### Get All Trades

Source: https://trade-api.bcs.ru/http/trades

Retrieves a list of all trades. Use this endpoint to fetch trade data.

```APIDOC
## GET /trades

### Description
Retrieves a list of all trades.

### Method
GET

### Endpoint
/trades

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of trades to return.
- **offset** (integer) - Optional - The number of trades to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **trades** (array) - A list of trade objects.
  - **id** (string) - The unique identifier of the trade.
  - **symbol** (string) - The trading symbol.
  - **type** (string) - The type of trade (e.g., 'buy', 'sell').
  - **quantity** (number) - The quantity of the asset traded.
  - **price** (number) - The price at which the trade was executed.
  - **timestamp** (string) - The timestamp of the trade in ISO 8601 format.
```

--------------------------------

### Subscribe to Market Trades in Go

Source: https://trade-api.bcs.ru/websocket/market-data/trades

Use the 'gorilla/websocket' library to connect and subscribe to trade data. The Authorization header must be set for authentication.

```go
package main  

import (  
    "log"  
    "net/http"  

    "github.com/gorilla/websocket"  
)  

func main() {  
    header := http.Header{}  
    header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")  

    c, _, err := websocket.DefaultDialer.Dial(  
        "wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws",  
        header,  
    )  
    if err != nil {  
        log.Fatal("dial:", err)  
    }  
    defer c.Close()  

    subscribeMessage := map[string]interface{}{  
        "subscribeType": 0,  
        "dataType":       2,  
        "instruments": []map[string]string{  
            {"ticker": "SBER", "classCode": "TQBR"},  
        },  
    }  

    if err := c.WriteJSON(subscribeMessage); err != nil {  
        log.Fatal("write:", err)  
    }  

    for {  
        var payload map[string]interface{}  
        if err := c.ReadJSON(&payload); err != nil {  
            log.Println("read:", err)  
            return  
        }  
        log.Printf("received: %#v", payload)  
    }  
}  
```

--------------------------------

### Connect to Execution Status WebSocket in Java

Source: https://trade-api.bcs.ru/websocket/operations/execution-status

Implement a WebSocket client using OkHttp to connect and receive messages. This example defines a listener for WebSocket events. Remember to substitute 'YOUR_ACCESS_TOKEN'.

```java
import okhttp3.*;  

public class ExecutionStatusWs {  
    public static void main(String[] args) {  
        OkHttpClient client = new OkHttpClient();  

        Request request = new Request.Builder()  
            .url("wss://ws.broker.ru/trade-api-bff-operations/api/v1/orders/execution/ws")  
            .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN")  
            .build();  

        WebSocketListener listener = new WebSocketListener() {  
            @Override  
            public void onOpen(WebSocket webSocket, Response response) {  
                System.out.println("connected");  
            }  

            @Override  
            public void onMessage(WebSocket webSocket, String text) {  
                System.out.println(text);  
            }  

            @Override  
            public void onFailure(WebSocket webSocket, Throwable t, Response response) {  
                t.printStackTrace();  
            }  
        };  

        client.newWebSocket(request, listener);  
    }  
}  
```

--------------------------------

### Get Trading Status

Source: https://trade-api.bcs.ru/http/information/get-trading-status

Fetches the trading status for a specified security class code.

```APIDOC
## GET https://be.broker.ru/trade-api-information-service/api/v1/trading-schedule/status

### Description
Retrieves the trading status for a given security class code.

### Method
GET

### Endpoint
/trade-api-information-service/api/v1/trading-schedule/status

### Parameters
#### Query Parameters
- **classCode** (string) - Required - Code of the security class. Possible values: `non-empty`. Example: `TQBR`

### Responses
#### Success Response (200)
- **tradingSessionTypeId** (int32) - ID of the session.
- **tradingSessionType** (string) - Name of the current session.
- **tradingSessionStatus** (string) - Status of the session. Possible values: `OPEN`, `CLOSE`.
- **nextSessionDate** (date-time) - Date and time of the next status change.

### Request Example
```json
{
  "tradingSessionTypeId": 0,
  "tradingSessionType": "string",
  "tradingSessionStatus": "OPEN",
  "nextSessionDate": "2024-07-29T15:51:28.071Z"
}
```

#### Error Response (429 Too Many Requests)
- **timestamp** (int64)
- **traceId** (string)
- **type** (string) - Possible values: `VALIDATION_ERROR`, `RESOURCE_EXHAUSTED`, `USER_BLOCKED`, `BAD_REQUEST`, `NOT_FOUND`, `UNAUTHORIZED`, `FORBIDDEN`, `CONFLICT`, `INTERNAL_SERVER_ERROR`, `SESSION_NOT_FOUND_ERROR`, `SESSION_EXPIRED_ERROR`, `SESSION_FAILED_ERROR`.
- **errors** (object[]) - Array of error details.
  - **type** (string)
  - **field** (string)
  - **payload** (object)
- **displayOptions** (object)

### Request Example
```json
{
  "timestamp": 0,
  "traceId": "string",
  "type": "VALIDATION_ERROR",
  "errors": [
    {
      "type": "string",
      "field": "string",
      "payload": {}
    }
  ],
  "displayOptions": {}
}
```

### Authorization
Bearer Token (JWT)
```

--------------------------------

### Error Response Example

Source: https://trade-api.bcs.ru/websocket/market-data/trades

Server response indicating an error occurred during trade data processing.

```APIDOC
## Error Response Example

### Response Body

```json
{
  "responseType": "LastTrades",
  "errors": [
    {
      "message": "Input JSON structure does not match structure, 'ticker' field is undefined.",
      "code": "INCORRECT_JSON"
    }
  ]
}
```

### Error Response Fields

| Field | Type | Description |
|---|---|---|
| `responseType` | string (enum) | Message type. For trades errors - `LastTrades` |
| `errors[].message` | string | Error text |
| `errors[].code` | string (enum) | Error code: `NO_DATE` - no data, `NOT_FOUND` - instrument not found, `INCORRECT_JSON` - invalid json, `BAD_REQUEST` - execution error, `UNAUTHORIZED` - client not authorized |
```

--------------------------------

### Connect and Subscribe to Market Data (Go)

Source: https://trade-api.bcs.ru/websocket/market-data/order-book

Connects to the market data WebSocket endpoint and subscribes to SBER ticker data. Requires the 'gorilla/websocket' library.

```go
package main  

import (  
    "log"  
    "net/http"  

    "github.com/gorilla/websocket"  
)  

func main() {  
    header := http.Header{}  
    header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")  

    c, _, err := websocket.DefaultDialer.Dial(  
        "wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws",  
        header,  
    )  
    if err != nil {  
        log.Fatal("dial:", err)  
    }  
    defer c.Close()  

    subscribeMessage := map[string]interface{}{  
        "subscribeType": 0,  
        "dataType":       0,  
        "depth":          20,  
        "instruments": []map[string]string{  
            {"ticker": "SBER", "classCode": "TQBR"},  
        },  
    }  

    if err := c.WriteJSON(subscribeMessage); err != nil {  
        log.Fatal("write:", err)  
    }  

    for {  
        var payload map[string]interface{}  
        if err := c.ReadJSON(&payload); err != nil {  
            log.Println("read:", err)  
            return  
        }  
        log.Printf("received: %#v", payload)  
    }  
}  
```

--------------------------------

### Order Book Error Response

Source: https://trade-api.bcs.ru/websocket/market-data/order-book

This is an example of an error response when receiving order book data.

```json
{
  "responseType": "OrderBook",
  "errors": [
    {
      "message": "Input JSON structure does not match structure, 'instruments' field is undefined.",
      "code": "INCORRECT_JSON"
    }
  ]
}
```

--------------------------------

### Connect and Subscribe to Market Data (C#)

Source: https://trade-api.bcs.ru/websocket/market-data/order-book

Connects to the market data WebSocket endpoint and subscribes to SBER ticker data using ClientWebSocket. Requires System.Net.WebSockets.

```csharp
using System;  
using System.Net.WebSockets;  
using System.Text;  
using System.Text.Json;  
using System.Threading;  
using System.Threading.Tasks;  

class Program  
{  
    static async Task Main()  
    {  
        using var ws = new ClientWebSocket();  
        ws.Options.SetRequestHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN");  

        await ws.ConnectAsync(  
            new Uri("wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws"),  
            CancellationToken.None  
        );  

        var subscribeMessage = new  
        {  
            subscribeType = 0,  
            dataType = 0,  
            depth = 20,  
            instruments = new[]  
            {  
```

--------------------------------

### Subscribe to Market Trades in Java

Source: https://trade-api.bcs.ru/websocket/market-data/trades

Implement a WebSocket client using OkHttp to connect and subscribe to trade data. The Authorization header is required for authentication.

```java
import okhttp3.*;  

public class TradesWs {  
    public static void main(String[] args) {  
        OkHttpClient client = new OkHttpClient();  

        Request request = new Request.Builder()  
            .url("wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws")  
            .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN")  
            .build();  

        WebSocketListener listener = new WebSocketListener() {  
            @Override  
            public void onOpen(WebSocket webSocket, Response response) {  
                String subscribeMessage = """
                    {  
                      "subscribeType": 0,  
                      "dataType": 2,  
                      "instruments": [  
                        { "ticker": "SBER", "classCode": "TQBR" }  
                      ]  
                    }  
                    """;  
                webSocket.send(subscribeMessage);  
            }  

            @Override  
            public void onMessage(WebSocket webSocket, String text) {  
                System.out.println(text);  
            }  

            @Override  
            public void onFailure(WebSocket webSocket, Throwable t, Response response) {  
                t.printStackTrace();  
            }  
        };  

        client.newWebSocket(request, listener);  
    }  
}  
```

--------------------------------

### Get All Orders

Source: https://trade-api.bcs.ru/http/operations/all-order-list

Fetches a list of all orders. The response includes details for each order and pagination information.

```APIDOC
## GET /all-order-list

### Description
Retrieves a list of all orders with detailed information. The response includes pagination details.

### Method
GET

### Endpoint
/all-order-list

### Query Parameters
* **page** (integer) - Optional - The page number to retrieve.
* **size** (integer) - Optional - The number of records per page.

### Response
#### Success Response (200)
- **records** (object[]) - List of orders.
  - **orderNum** (int64) - Order number.
  - **orderId** (string) - Unique order identifier.
  - **clientCode** (string) - Client code.
  - **executionDateTime** (date-time) - Order execution date and time.
  - **executedValue** (double) - Executed volume in currency.
  - **orderDateTime** (date-time) - Order placement date and time.
  - **tradeDate** (date) - Trade date.
  - **updateDateTime** (date-time) - Last update date and time.
  - **ticker** (string) - Instrument ticker.
  - **classCode** (string) - Instrument class code.
  - **takePrice** (double) - Take profit price.
  - **stopPrice** (double) - Stop loss price.
  - **price** (double) - Order price.
  - **settlementCurrency** (string) - Settlement currency.
  - **orderQuantity** (double) - Quantity in the order (in pieces).
  - **remainedQuantity** (double) - Remaining quantity (in pieces).
  - **executedQuantity** (double) - Executed quantity (in pieces).
  - **rejectReason** (string) - Reason for order rejection.
  - **averagePrice** (double) - Average execution price.
  - **calculationVolume** (double) - Calculation volume.
  - **contractSum** (double) - Contract sum.
  - **orderStatus** (int32) - Order status (1: Canceled, 2: Executed, 3: Active).
  - **orderType** (int32) - Order type (1: Market, 2: Limit, 3: Iceberg, 4: Stop-limit, 5: Take profit, 6: Stop loss, 7: Take profit and stop loss, 10: Limit for 30 days, 11: Take profit, 12: Trailing stop).
  - **side** (int32) - Order direction (1: Buy, 2: Sell).
  - **orderQuantityLots** (double) - Quantity in the order (in lots).
  - **remainedQuantityLots** (double) - Remaining quantity (in lots).
  - **executedQuantityLots** (double) - Executed quantity (in lots).
  - **linkedOrder** (string) - Linked order number.
  - **stopOrder** (string) - Stop order number.
  - **visible** (double) - Visible part of the iceberg order.
  - **marketTakeProfit** (integer) - Market take profit flag (1: Market order, 2: Limit order).
  - **marketStopLoss** (integer) - Market stop loss flag (1: Market order, 2: Limit order).
  - **positionPriceStop** (double) - Position stop price.
  - **positionPriceLimit** (double) - Position limit price.
- **totalRecords** (int64) - Total number of records.
- **totalPages** (int32) - Total number of pages.

#### Response Example (200)
```json
{
  "records": [
    {
      "orderNum": 0,
      "orderId": "string",
      "clientCode": "string",
      "executionDateTime": "2024-07-29T15:51:28.071Z",
      "executedValue": 0,
      "orderDateTime": "2024-07-29T15:51:28.071Z",
      "tradeDate": "2024-07-29",
      "updateDateTime": "2024-07-29T15:51:28.071Z",
      "ticker": "string",
      "classCode": "string",
      "takePrice": 0,
      "stopPrice": 0,
      "price": 0,
      "settlementCurrency": "string",
      "orderQuantity": 0,
      "remainedQuantity": 0,
      "executedQuantity": 0,
      "rejectReason": "string",
      "averagePrice": 0,
      "calculationVolume": 0,
      "contractSum": 0,
      "orderStatus": 1,
      "orderType": 1,
      "side": 1,
      "orderQuantityLots": 0,
      "remainedQuantityLots": 0,
      "executedQuantityLots": 0,
      "linkedOrder": "string",
      "stopOrder": "string",
      "visible": 0,
      "marketTakeProfit": 1,
      "marketStopLoss": 1,
      "positionPriceStop": 0,
      "positionPriceLimit": 0
    }
  ],
  "totalRecords": 0,
  "totalPages": 0
}
```

#### Error Response (429)
- **timestamp** (int64) - Timestamp of the error.
- **traceId** (string) - Trace ID for the error.
- **type** (string) - Error type (e.g., RESOURCE_EXHAUSTED).
- **errors** (object[]) - Array of specific errors.
  - **type** (string) - Type of the error.
  - **field** (string) - Field related to the error.
  - **payload** (object) - Additional error payload.
- **displayOptions** (object) - Options for displaying the error.

#### Response Example (429)
```json
{
  "timestamp": 0,
  "traceId": "string",
  "type": "VALIDATION_ERROR",
  "errors": [
    {
      "type": "string",
      "field": "string",
      "payload": {}
    }
  ],
  "displayOptions": {}
}
```
```

--------------------------------

### Successful Order Execution Response

Source: https://trade-api.bcs.ru/websocket/operations/execution-status

This is an example of a successful response from the server detailing an order execution event.

```json
{
  "originalClientOrderId": "517661df-d051-461d-9389-988abf24de4d",
  "clientOrderId": "",
  "data": {
    "messageType": "8",
    "orderStatus": "2",
    "executionType": "2",
    "orderQuantity": 100,
    "executedQuantity": 100,
    "lastQuantity": 50,
    "remainedQuantity": 0,
    "ticker": "SBER",
    "classCode": "TQBR",
    "side": "1",
    "orderType": "2",
    "averagePrice": 244.5,
    "orderId": "20241030-TQBR-12345678910",
    "executionId": "TQBR-Z3fE7c-S-1-1-N",
    "price": 244.5,
    "currency": "RUB",
    "clientCode": "123456",
    "transactionTime": "2024-10-30T09:01:00.000Z",
    "tradeDate": "2024-10-30",
    "orderNumber": "12345678910",
    "accruedCoupon": 0,
    "executionValue": 24450,
    "commission": 12.3,
    "securityExchange": "TQBR"
  }
}
```

--------------------------------

### Subscribe to Market Trades in C#

Source: https://trade-api.bcs.ru/websocket/market-data/trades

Use the built-in ClientWebSocket class to connect and subscribe to trade data. Set the Authorization header before connecting.

```csharp
using System;  
using System.Net.WebSockets;  
using System.Text;  
using System.Text.Json;  
using System.Threading;  
using System.Threading.Tasks;  

class Program  
{  
    static async Task Main()  
    {  
        using var ws = new ClientWebSocket();  
        ws.Options.SetRequestHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN");  

        await ws.ConnectAsync(  
            new Uri("wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws"),  
            CancellationToken.None  
        );  

        var subscribeMessage = new  
        {  
            subscribeType = 0,  
            dataType = 2,  
            instruments = new[]  
            {  
                new { ticker = "SBER", classCode = "TQBR" }  
            }  
        };  

        string payload = JsonSerializer.Serialize(subscribeMessage);  
```
Tokens:
Raw