Finam Trade API

https://tradeapi.finam.ru/docs/rest/
Admin
Finam Trade API is a REST API for trading operations providing access to accounts, market data,...
Tokens:47,010
Snippets:181
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Orders Response Example

Source: https://tradeapi.finam.ru/docs/rest/ordersservice_getorders.md

This is an example of a successful response when retrieving a list of orders. It details the structure of the 'orders' array and the properties of each individual order object.

```json
{
  "orders": [
    {
      "order_id": "string",
      "exec_id": "string",
      "status": "ORDER_STATUS_UNSPECIFIED",
      "order": {
        "account_id": "string",
        "symbol": "string",
        "quantity": {
          "value": "string"
        },
        "side": "SIDE_UNSPECIFIED",
        "type": "ORDER_TYPE_UNSPECIFIED",
        "time_in_force": "TIME_IN_FORCE_UNSPECIFIED",
        "limit_price": {
          "value": "string"
        },
        "stop_price": {
          "value": "string"
        },
        "stop_condition": "STOP_CONDITION_UNSPECIFIED",
        "legs": [
          {
            "symbol": "string",
            "quantity": {
              "value": "string"
            },
            "side": "SIDE_UNSPECIFIED"
          }
        ],
        "client_order_id": "string",
        "valid_before": "VALID_BEFORE_UNSPECIFIED",
        "comment": "string"
      },
      "transact_at": "string",
      "accept_at": "string",
      "withdraw_at": "string",
      "initial_quantity": {
        "value": "string"
      },
      "executed_quantity": {
        "value": "string"
      },
      "remaining_quantity": {
        "value": "string"
      },
      "sltp_order": {
        "account_id": "string",
        "symbol": "string",
        "side": "SIDE_UNSPECIFIED",
        "quantity_sl": {
          "value": "string"
        },
        "sl_price": {
          "value": "string"
        },
        "limit_price": {
          "value": "string"
        },
        "quantity_tp": {
          "value": "string"
        },
        "tp_price": {
          "value": "string"
        },
        "tp_guard_spread": {
          "value": "string"
        },
        "tp_spread_measure": "TP_SPREAD_MEASURE_UNDEFINED",
        "client_order_id": "string",
        "valid_before": "VALID_BEFORE_UNSPECIFIED",
        "valid_expiry_time": "string",
        "comment": "string"
      }
    }
  ]
}
```

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

### Get Order Book Example (JSON Response)

Source: https://tradeapi.finam.ru/docs/rest/marketdataservice_orderbook.md

This is an example of a successful JSON response when requesting an order book. It includes instrument symbol and order book details like price, size, and action.

```json
{
  "symbol": "string",
  "orderbook": {
    "rows": [
      {
        "price": {
          "value": "string"
        },
        "sell_size": {
          "value": "string"
        },
        "buy_size": {
          "value": "string"
        },
        "action": "ACTION_UNSPECIFIED",
        "mpid": "string",
        "timestamp": "string"
      }
    ]
  }
}
```

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

### Get Trading Parameters for an Asset

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_getassetparams.md

This example demonstrates how to fetch trading parameters for a specific asset using its symbol. It also shows how to include an account ID for personalized parameters.

```json
{
  "symbol": "string",
  "account_id": "string",
  "tradeable": false,
  "longable": {
    "value": "NOT_AVAILABLE",
    "halted_days": 0
  },
  "shortable": {
    "value": "NOT_AVAILABLE",
    "halted_days": 0
  },
  "long_risk_rate": {
    "value": "string"
  },
  "long_collateral": {
    "currency_code": "string",
    "units": "string",
    "nanos": 0
  },
  "short_risk_rate": {
    "value": "string"
  },
  "short_collateral": {
    "currency_code": "string",
    "units": "string",
    "nanos": 0
  },
  "long_initial_margin": {
    "currency_code": "string",
    "units": "string",
    "nanos": 0
  },
  "short_initial_margin": {
    "currency_code": "string",
    "units": "string",
    "nanos": 0
  },
  "is_tradable": false,
  "price_type": "UNKNOWN"
}
```

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

### Get Session Token and Place Order (Python)

Source: https://tradeapi.finam.ru/docs/rest/authservice_tokendetails.md

Shows how to authenticate by getting a session token with your API secret and then use it to submit an order. The token should be handled securely.

```python
import requests

auth_response = requests.post(
    "https://api.finam.ru/v1/sessions",
    json={
    "secret": "YOUR_API_TOKEN"
}
)
token = auth_response.json()["token"]

response = requests.post(
    "https://api.finam.ru/v1/accounts/YOUR_ACCOUNT_ID/orders",
    headers={
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json"
    },
    json={
    "symbol": "string",
    "quantity": {
        "value": "string"
    },
    "side": "SIDE_UNSPECIFIED",
    "type": "ORDER_TYPE_UNSPECIFIED",
    "time_in_force": "TIME_IN_FORCE_UNSPECIFIED",
    "limit_price": {
        "value": "string"
    },
    "stop_price": {
        "value": "string"
    },
    "stop_condition": "STOP_CONDITION_UNSPECIFIED",
    "legs": {
        "0": {
            "symbol": "string",
            "quantity": {
                "value": "string"
            },
            "side": "SIDE_UNSPECIFIED"
        }
    },
    "client_order_id": "string",
    "valid_before": "VALID_BEFORE_UNSPECIFIED",
    "comment": "string"
}
)
data = response.json()
```

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

### Get Options Chain - Python

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_optionschain.md

Retrieves an options chain for a given underlying asset using Python. This example demonstrates authentication and constructing the request with optional query parameters for filtering. Replace placeholders with your actual credentials and symbols.

```python
import requests

auth_response = requests.post(
    "https://api.finam.ru/v1/sessions",
    json={
    "secret": "YOUR_API_TOKEN"
}
)
token = auth_response.json()["token"]

response = requests.get(
    "https://api.finam.ru/v1/assets/YOUR_UNDERLYING_SYMBOL/options",
    headers={
        "Authorization": f"Bearer {token}"
    },
    params={
        "root": "YOUR_ROOT",
        "expiration_date.year": "YOUR_EXPIRATION_DATE.YEAR",
        "expiration_date.month": "YOUR_EXPIRATION_DATE.MONTH",
        "expiration_date.day": "YOUR_EXPIRATION_DATE.DAY"
    },
)
data = response.json()
```

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

### Get Bars Data Example (JSON Response)

Source: https://tradeapi.finam.ru/docs/rest/marketdataservice_bars.md

This is an example of a successful JSON response when requesting historical bar data.

```json
{
  "symbol": "string",
  "bars": [
    {
      "timestamp": "string",
      "open": {
        "value": "string"
      },
      "high": {
        "value": "string"
      },
      "low": {
        "value": "string"
      },
      "close": {
        "value": "string"
      },
      "volume": {
        "value": "string"
      }
    }
  ]
}
```

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

### GetOrder API Response Example (200 OK)

Source: https://tradeapi.finam.ru/docs/rest/ordersservice_getorder.md

This is a successful response example for the GetOrder endpoint, detailing the structure of order information.

```json
{
  "order_id": "string",
  "exec_id": "string",
  "status": "ORDER_STATUS_UNSPECIFIED",
  "order": {
    "account_id": "string",
    "symbol": "string",
    "quantity": {
      "value": "string"
    },
    "side": "SIDE_UNSPECIFIED",
    "type": "ORDER_TYPE_UNSPECIFIED",
    "time_in_force": "TIME_IN_FORCE_UNSPECIFIED",
    "limit_price": {
      "value": "string"
    },
    "stop_price": {
      "value": "string"
    },
    "stop_condition": "STOP_CONDITION_UNSPECIFIED",
    "legs": [
      {
        "symbol": "string",
        "quantity": {
          "value": "string"
        },
        "side": "SIDE_UNSPECIFIED"
      }
    ],
    "client_order_id": "string",
    "valid_before": "VALID_BEFORE_UNSPECIFIED",
    "comment": "string"
  },
  "transact_at": "string",
  "accept_at": "string",
  "withdraw_at": "string",
  "initial_quantity": {
    "value": "string"
  },
  "executed_quantity": {
    "value": "string"
  },
  "remaining_quantity": {
    "value": "string"
  },
  "sltp_order": {
    "account_id": "string",
    "symbol": "string",
    "side": "SIDE_UNSPECIFIED",
    "quantity_sl": {
      "value": "string"
    },
    "sl_price": {
      "value": "string"
    },
    "limit_price": {
      "value": "string"
    },
    "quantity_tp": {
      "value": "string"
    },
    "tp_price": {
      "value": "string"
    },
    "tp_guard_spread": {
      "value": "string"
    },
    "tp_spread_measure": "TP_SPREAD_MEASURE_UNDEFINED",
    "client_order_id": "string",
    "valid_before": "VALID_BEFORE_UNSPECIFIED",
    "valid_expiry_time": "string",
    "comment": "string"
  }
}
```

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

### Get Account Report Info Response Example (JSON)

Source: https://tradeapi.finam.ru/docs/rest/reportsservice_getaccountreportinfo.md

This JSON structure represents a successful response when retrieving information about an account report. It includes the report ID, status, date range, report form, account ID, and a URL to access the report if available.

```json
{
  "info": {
    "report_id": "string",
    "status": "NOT_FOUND",
    "date_range": {
      "date_begin": "string",
      "date_end": "string"
    },
    "report_form": "REPORT_FORM_UNKNOWN",
    "account_id": "string",
    "url": "string"
  }
}
```

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

### Get Latest Trades - Response Example

Source: https://tradeapi.finam.ru/docs/rest/marketdataservice_latesttrades.md

This JSON structure represents a successful response containing a list of the latest trades for a specified instrument.

```json
{
  "symbol": "string",
  "trades": [
    {
      "trade_id": "string",
      "mpid": "string",
      "timestamp": "string",
      "price": {
        "value": "string"
      },
      "size": {
        "value": "string"
      },
      "side": "SIDE_UNSPECIFIED",
      "open_interest": {
        "value": "string"
      }
    }
  ]
}
```

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

### Get Index Constituents

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_getconstituents.md

Retrieve the constituents of a stock market index by its symbol using Go. This example includes authentication and constructing the request with query parameters.

```go
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    authBody := []byte(`{"secret":"YOUR_API_TOKEN"}`)
    authReq, _ := http.NewRequest("POST", "https://api.finam.ru/v1/sessions", bytes.NewBuffer(authBody))
    authReq.Header.Set("Content-Type", "application/json")
    authResp, _ := http.DefaultClient.Do(authReq)
    defer authResp.Body.Close()
    var authResult map[string]interface{}
    json.NewDecoder(authResp.Body).Decode(&authResult)
    token := authResult["token"].(string)

    params := url.Values{}
    params.Set("root", "YOUR_ROOT")
    params.Set("expiration_date.year", "YOUR_EXPIRATION_DATE.YEAR")
    params.Set("expiration_date.month", "YOUR_EXPIRATION_DATE.MONTH")
    params.Set("expiration_date.day", "YOUR_EXPIRATION_DATE.DAY")
    req, _ := http.NewRequest("GET", "https://api.finam.ru/v1/assets/YOUR_UNDERLYING_SYMBOL/options?"+params.Encode(), nil)
    req.Header.Set("Authorization", "Bearer "+token)
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}
```

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

### Get Report Info Response Example

Source: https://tradeapi.finam.ru/docs/rest/#tag/ordersservice/get/v1/accounts/{accountId}/orders

This JSON object represents a successful response when retrieving information about a report. It includes the report's ID, status, date range, form, account ID, and a URL for accessing the report.

```json
{
"info": {
"report_id": "string",
"status": "NOT_FOUND",
"date_range": {
"date_begin": "string",
"date_end": "string"
},
"report_form": "REPORT_FORM_UNKNOWN",
"account_id": "string",
"url": "string"
}
}
```

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

### Get Last Quote Response Example

Source: https://tradeapi.finam.ru/docs/rest/marketdataservice_lastquote.md

This JSON structure represents a successful response containing the latest quote details for a financial instrument.

```json
{
  "symbol": "string",
  "quote": {
    "symbol": "string",
    "timestamp": "string",
    "ask": {
      "value": "string"
    },
    "ask_size": {
      "value": "string"
    },
    "bid": {
      "value": "string"
    },
    "bid_size": {
      "value": "string"
    },
    "last": {
      "value": "string"
    },
    "last_size": {
      "value": "string"
    },
    "volume": {
      "value": "string"
    },
    "turnover": {
      "value": "string"
    },
    "open": {
      "value": "string"
    },
    "high": {
      "value": "string"
    },
    "low": {
      "value": "string"
    },
    "close": {
      "value": "string"
    },
    "change": {
      "value": "string"
    },
    "open_interest": {
      "value": "string"
    },
    "option": {
      "open_interest": {
        "value": "string"
      },
      "implied_volatility": {
        "value": "string"
      },
      "theoretical_price": {
        "value": "string"
      },
      "delta": {
        "value": "string"
      },
      "gamma": {
        "value": "string"
      },
      "theta": {
        "value": "string"
      },
      "vega": {
        "value": "string"
      },
      "rho": {
        "value": "string"
      }
    }
  }
}
```

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

### AssetsService - GetAsset

Source: https://tradeapi.finam.ru/docs/rest/llms.txt

Get information about a specific instrument.

```APIDOC
## GET /GetAsset

### Description
Get information about a specific instrument.

### Method
GET

### Endpoint
/GetAsset

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The symbol of the instrument.

### Response
#### Success Response (200)
- **symbol** (string) - The instrument symbol.
- **description** (string) - The description of the instrument.
- **exchange** (string) - The exchange where the instrument is traded.
- **currency** (string) - The currency of the instrument.

### Response Example
```json
{
  "symbol": "AAPL",
  "description": "Apple Inc.",
  "exchange": "NASDAQ",
  "currency": "USD"
}
```
```

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

### Asset Response Example

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_assets.md

This JSON structure represents a successful response when retrieving a list of available trading assets.

```json
{
  "assets": [
    {
      "symbol": "string",
      "id": "string",
      "ticker": "string",
      "mic": "string",
      "isin": "string",
      "type": "string",
      "name": "string",
      "is_archived": false
    }
  ]
}
```

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

### AssetsService - Assets

Source: https://tradeapi.finam.ru/docs/rest/llms.txt

Get a list of available instruments for trading, including their descriptions.

```APIDOC
## GET /Assets

### Description
Get a list of available instruments for trading, including their descriptions.

### Method
GET

### Endpoint
/Assets

### Response
#### Success Response (200)
- **assets** (array) - A list of asset objects.
  - **symbol** (string) - The trading symbol.
  - **description** (string) - The description of the instrument.
  - **exchange** (string) - The exchange where the instrument is traded.

### Response Example
```json
{
  "assets": [
    {
      "symbol": "AAPL",
      "description": "Apple Inc.",
      "exchange": "NASDAQ"
    }
  ]
}
```
```

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

### AssetsService - Schedule

Source: https://tradeapi.finam.ru/docs/rest/llms.txt

Get the trading schedule for an instrument.

```APIDOC
## GET /Schedule

### Description
Get the trading schedule for an instrument.

### Method
GET

### Endpoint
/Schedule

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The symbol of the instrument.

### Response
#### Success Response (200)
- **trading_hours** (array) - A list of trading hour objects.
  - **day_of_week** (string) - The day of the week.
  - **open_time** (string) - The opening time.
  - **close_time** (string) - The closing time.

### Response Example
```json
{
  "trading_hours": [
    {
      "day_of_week": "Monday",
      "open_time": "09:30:00",
      "close_time": "16:00:00"
    }
  ]
}
```
```

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

### AssetsService - OptionsChain

Source: https://tradeapi.finam.ru/docs/rest/llms.txt

Get the options chain for an underlying asset.

```APIDOC
## GET /OptionsChain

### Description
Get the options chain for an underlying asset.

### Method
GET

### Endpoint
/OptionsChain

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The symbol of the underlying asset.

### Response
#### Success Response (200)
- **options** (array) - A list of option contracts.
  - **strike_price** (number) - The strike price of the option.
  - **expiration_date** (string) - The expiration date of the option.
  - **type** (string) - The type of option (call or put).
  - **symbol** (string) - The symbol of the option contract.

### Response Example
```json
{
  "options": [
    {
      "strike_price": 100.00,
      "expiration_date": "2023-12-15",
      "type": "call",
      "symbol": "GOOG-OPT-20231215-100"
    }
  ]
}
```
```

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

### AssetsService - AllAssets

Source: https://tradeapi.finam.ru/docs/rest/llms.txt

Get a list of all instruments, including indicative and archived ones, with their descriptions.

```APIDOC
## GET /AllAssets

### Description
Get a list of all instruments, including indicative and archived ones, with their descriptions.

### Method
GET

### Endpoint
/AllAssets

### Response
#### Success Response (200)
- **assets** (array) - A list of asset objects.
  - **symbol** (string) - The instrument symbol.
  - **description** (string) - The description of the instrument.
  - **type** (string) - The type of asset (e.g., stock, option, future).
  - **status** (string) - The status of the asset (e.g., active, inactive).

### Response Example
```json
{
  "assets": [
    {
      "symbol": "AAPL",
      "description": "Apple Inc.",
      "type": "stock",
      "status": "active"
    },
    {
      "symbol": "GOOG-OPT-20231215-100",
      "description": "Google Option",
      "type": "option",
      "status": "active"
    }
  ]
}
```
```

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

### Get All Assets

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_allassets.md

Fetches a list of all assets, supporting pagination and filtering by active or archived status.

```APIDOC
## GET /v1/assets/all

### Description
Retrieves a list of all instruments, including indicative and archived ones, along with their descriptions.

### Method
GET

### Endpoint
/v1/assets/all

### Query Parameters
#### Query Parameters
- **cursor** (string) - Optional - Cursor for pagination. Specifies the instrument's sec_id from which the list should start. Leave empty (value 0) for the first request. For subsequent requests, use the next_cursor value from the previous response.
- **only_active** (boolean) - Optional - Filter by instrument status: selects only active (non-archived) instruments. Defaults to false.
- **only_disabled** (boolean) - Optional - Filter by instrument status: selects only inactive (archived) instruments. Defaults to false.

### Response
#### Success Response (200)
- **assets** (array) - List of asset objects.
  - **symbol** (string) - The trading symbol of the asset.
  - **id** (string) - The unique identifier of the asset.
  - **ticker** (string) - The ticker symbol.
  - **mic** (string) - The Market Identifier Code.
  - **isin** (string) - The International Securities Identification Number.
  - **type** (string) - The type of the asset (e.g., stock, bond).
  - **name** (string) - The full name of the asset.
  - **is_archived** (boolean) - Indicates if the asset is archived.
- **next_cursor** (string) - Cursor for the next page of results.

#### Response Example (200)
{
  "assets": [
    {
      "symbol": "string",
      "id": "string",
      "ticker": "string",
      "mic": "string",
      "isin": "string",
      "type": "string",
      "name": "string",
      "is_archived": false
    }
  ],
  "next_cursor": "string"
}

#### Error Responses
- **401**: Token has expired or is invalid.
- **404**: Account not found in token.
- **429**: Too many requests. Available limit is 200 requests per minute.
- **500**: Internal service error. Please try again later.
- **503**: Service is currently unavailable. Please try again later.
- **504**: Gateway timeout.
- **default**: An unexpected error response.

#### Response Example (default)
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
```

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

### Get Order Book

Source: https://tradeapi.finam.ru/docs/rest/marketdataservice_orderbook.md

Fetches the current order book for a specified instrument.

```APIDOC
## GET /v1/instruments/{symbol}/orderbook

### Description
Retrieves the current order book for a given instrument.

### Method
GET

### Endpoint
/v1/instruments/{symbol}/orderbook

### Parameters
#### Path Parameters
- **symbol** (string) - Required - The symbol of the instrument.

### Response
#### Success Response (200)
- **symbol** (string) - The symbol of the instrument.
- **orderbook** (object) - Contains the order book details.
  - **rows** (array) - An array of order book entries.
    - **price** (object)
      - **value** (string) - The price of the order.
    - **sell_size** (object)
      - **value** (string) - The size of the sell order.
    - **buy_size** (object)
      - **value** (string) - The size of the buy order.
    - **action** (string) - The action associated with the order (e.g., ACTION_UNSPECIFIED).
    - **mpid** (string) - The market participant ID.
    - **timestamp** (string) - The timestamp of the order.

#### Response Example (200)
{
  "symbol": "string",
  "orderbook": {
    "rows": [
      {
        "price": {
          "value": "string"
        },
        "sell_size": {
          "value": "string"
        },
        "buy_size": {
          "value": "string"
        },
        "action": "ACTION_UNSPECIFIED",
        "mpid": "string",
        "timestamp": "string"
      }
    ]
  }
}

#### Error Response (401)
Unauthorized: Token expired or invalid.

#### Error Response (404)
Not Found: Account not found in token.

#### Error Response (429)
Too Many Requests: Exceeded the rate limit of 200 requests per minute.

#### Error Response (500)
Internal Server Error: Please try again later.

#### Error Response (503)
Service Unavailable: The service is currently unavailable. Please try again later.

#### Error Response (504)
Gateway Timeout: The operation timed out.

#### Error Response (default)
An unexpected error occurred.
```
        }
      }
    ]
  }
}
```

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

### Authenticate and Fetch Options Data in Go

Source: https://tradeapi.finam.ru/docs/rest/usagemetricsservice_getusagemetrics.md

This Go program illustrates the process of authenticating with the API to get a token and subsequently fetching options data. Remember to substitute the placeholder values with your actual API details.

```go
package main

import (
    "bytes",
    "encoding/json",
    "fmt",
    "io",
    "net/http",
    "net/url"
)

func main() {
    authBody := []byte(`{"secret":"YOUR_API_TOKEN"}`)
    authReq, _ := http.NewRequest("POST", "https://api.finam.ru/v1/sessions", bytes.NewBuffer(authBody))
    authReq.Header.Set("Content-Type", "application/json")
    authResp, _ := http.DefaultClient.Do(authReq)
    defer authResp.Body.Close()
    var authResult map[string]interface{}
    json.NewDecoder(authResp.Body).Decode(&authResult)
    token := authResult["token"].(string)

    params := url.Values{}
    params.Set("root", "YOUR_ROOT")
    params.Set("expiration_date.year", "YOUR_EXPIRATION_DATE.YEAR")
    params.Set("expiration_date.month", "YOUR_EXPIRATION_DATE.MONTH")
    params.Set("expiration_date.day", "YOUR_EXPIRATION_DATE.DAY")
    req, _ := http.NewRequest("GET", "https://api.finam.ru/v1/assets/YOUR_UNDERLYING_SYMBOL/options?"+params.Encode(), nil)
    req.Header.Set("Authorization", "Bearer "+token)
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}
```

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

### Get JWT Token and Place SLTP Order (Python)

Source: https://tradeapi.finam.ru/docs/rest/authservice_auth.md

Shows how to authenticate by obtaining a JWT token and then submitting an SLTP order. Replace placeholders with your actual API token and account ID.

```python
import requests

auth_response = requests.post(
    "https://api.finam.ru/v1/sessions",
    json={
    "secret": "YOUR_API_TOKEN"
}
)
token = auth_response.json()["token"]

response = requests.post(
    "https://api.finam.ru/v1/accounts/YOUR_ACCOUNT_ID/sltp-orders",
    headers={
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json"
    },
    json={
    "symbol": "string",
    "side": "SIDE_UNSPECIFIED",
    "quantity_sl": {
        "value": "string"
    },
    "sl_price": {
        "value": "string"
    },
    "limit_price": {
        "value": "string"
    },
    "quantity_tp": {
        "value": "string"
    },
    "tp_price": {
        "value": "string"
    },
    "tp_guard_spread": {
        "value": "string"
    },
    "tp_spread_measure": "TP_SPREAD_MEASURE_UNDEFINED",
    "client_order_id": "string",
    "valid_before": "VALID_BEFORE_UNSPECIFIED",
    "valid_expiry_time": "string",
    "comment": "string"
}
)
data = response.json()
```

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

### Get Asset Schedule

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_schedule.md

Retrieves the trading schedule for a specified financial instrument. The schedule includes details about trading sessions and their start and end times.

```APIDOC
## GET /v1/assets/{symbol}/schedule

### Description
Retrieves the trading schedule for a specified financial instrument.

### Method
GET

### Endpoint
/v1/assets/{symbol}/schedule

### Parameters
#### Path Parameters
- **symbol** (string) - Required - The symbol of the instrument (e.g., SBER@MISX).

### Response
#### Success Response (200)
- **symbol** (string) - The symbol of the instrument.
- **sessions** (array) - An array of trading sessions.
  - **type** (string) - The type of session.
  - **interval** (object) - The time interval for the session.
    - **start_time** (string) - The start time of the session.
    - **end_time** (string) - The end time of the session.

#### Response Example (200)
{
  "symbol": "string",
  "sessions": [
    {
      "type": "string",
      "interval": {
        "start_time": "string",
        "end_time": "string"
      }
    }
  ]
}

#### Error Response (400)
Bad Request: Invalid symbol format. Symbol must be in the format ticker@mic. Where ticker is, for example, SBER. And mic, for example, MISX.

#### Error Response (401)
Unauthorized: Token has expired or is invalid.

#### Error Response (404)
Not Found: Account not found in token.

#### Error Response (429)
Too Many Requests: Available limit is 200 requests per minute.

#### Error Response (500)
Internal Server Error: Please try again later.

#### Error Response (503)
Service Unavailable: The service is currently unavailable. Please try again later.

#### Error Response (504)
Gateway Timeout: The gateway did not receive a timely response from the upstream server.

#### Error Response (default)
An unexpected error response.
```json
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
```
```

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

### Authenticate and Fetch Options Schedule (JavaScript)

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_schedule.md

Demonstrates how to authenticate with the API using a secret token and then fetch options schedule data for a given symbol. Ensure your API token and symbol are correctly set.

```javascript
const authResponse = await fetch('https://api.finam.ru/v1/sessions', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"secret":"YOUR_API_TOKEN"})
});
const { token } = await authResponse.json();

const params = new URLSearchParams({
  root: 'YOUR_ROOT',
  'expiration_date.year': 'YOUR_EXPIRATION_DATE.YEAR',
  'expiration_date.month': 'YOUR_EXPIRATION_DATE.MONTH',
  'expiration_date.day': 'YOUR_EXPIRATION_DATE.DAY'
});

const response = await fetch(`https://api.finam.ru/v1/assets/YOUR_UNDERLYING_SYMBOL/options?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`
  },
});
const data = await response.json();
```

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

### Get Session Token and Place Order (JavaScript)

Source: https://tradeapi.finam.ru/docs/rest/authservice_tokendetails.md

Demonstrates how to obtain a session token using your API secret and then use that token to place an order. Ensure the token is kept secure.

```javascript
const authResponse = await fetch('https://api.finam.ru/v1/sessions', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"secret":"YOUR_API_TOKEN"})
});
const { token } = await authResponse.json();

const response = await fetch('https://api.finam.ru/v1/accounts/YOUR_ACCOUNT_ID/orders', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "symbol": "string",
    "quantity": {
      "value": "string"
    },
    "side": "SIDE_UNSPECIFIED",
    "type": "ORDER_TYPE_UNSPECIFIED",
    "time_in_force": "TIME_IN_FORCE_UNSPECIFIED",
    "limit_price": {
      "value": "string"
    },
    "stop_price": {
      "value": "string"
    },
    "stop_condition": "STOP_CONDITION_UNSPECIFIED",
    "legs": [
      {
        "symbol": "string",
        "quantity": {
          "value": "string"
        },
        "side": "SIDE_UNSPECIFIED"
      }
    ],
    "client_order_id": "string",
    "valid_before": "VALID_BEFORE_UNSPECIFIED",
    "comment": "string"
  })
});
const data = await response.json();
```

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

### Place Order using cURL

Source: https://tradeapi.finam.ru/docs/rest/ordersservice_placeorder.md

Use this cURL command to place an order. Ensure you have obtained your API token and account ID beforehand. The command includes parameters for symbol, quantity, side, type, and other order specifics.

```shell
TOKEN=$(curl -s -X POST 'https://api.finam.ru/v1/sessions' \
  -H 'Content-Type: application/json' \
  -d '{"secret":"YOUR_API_TOKEN"}' | jq -r '.token')

curl -X POST 'https://api.finam.ru/v1/accounts/YOUR_ACCOUNT_ID/orders' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "symbol": "string",
  "quantity": {
    "value": "string"
  },
  "side": "SIDE_UNSPECIFIED",
  "type": "ORDER_TYPE_UNSPECIFIED",
  "time_in_force": "TIME_IN_FORCE_UNSPECIFIED",
  "limit_price": {
    "value": "string"
  },
  "stop_price": {
    "value": "string"
  },
  "stop_condition": "STOP_CONDITION_UNSPECIFIED",
  "legs": [
    {
      "symbol": "string",
      "quantity": {
        "value": "string"
      },
      "side": "SIDE_UNSPECIFIED"
    }
  ],
  "client_order_id": "string",
  "valid_before": "VALID_BEFORE_UNSPECIFIED",
  "comment": "string" \
}'
```

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

### Get JWT Token and Place SLTP Order (Go)

Source: https://tradeapi.finam.ru/docs/rest/authservice_auth.md

Provides Go code to first acquire a JWT token and subsequently place an SLTP order. Remember to replace 'YOUR_API_TOKEN' and 'YOUR_ACCOUNT_ID' with your credentials.

```go
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
)

func main() {
    authBody := []byte(`{"secret":"YOUR_API_TOKEN"}`)
    authReq, _ := http.NewRequest("POST", "https://api.finam.ru/v1/sessions", bytes.NewBuffer(authBody))
    authReq.Header.Set("Content-Type", "application/json")
    authResp, _ := http.DefaultClient.Do(authReq)
    defer authResp.Body.Close()
    var authResult map[string]interface{}
    json.NewDecoder(authResp.Body).Decode(&authResult)
    token := authResult["token"].(string)

    body := []byte(`{
  "symbol": "string",
  "side": "SIDE_UNSPECIFIED",
  "quantity_sl": {
    "value": "string"
  },
  "sl_price": {
    "value": "string"
  },
  "limit_price": {
    "value": "string"
  },
  "quantity_tp": {
    "value": "string"
  },
  "tp_price": {
    "value": "string"
  },
  "tp_guard_spread": {
    "value": "string"
  },
  "tp_spread_measure": "TP_SPREAD_MEASURE_UNDEFINED",
  "client_order_id": "string",
  "valid_before": "VALID_BEFORE_UNSPECIFIED",
  "valid_expiry_time": "string",
  "comment": "string"
}`))
    req, _ := http.NewRequest("POST", "https://api.finam.ru/v1/accounts/YOUR_ACCOUNT_ID/sltp-orders", bytes.NewBuffer(body))
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}
```

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

### Get Server Time

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_clock.md

Retrieves the current server timestamp. This is a simple GET request to the /v1/assets/clock endpoint.

```json
{
  "timestamp": "string"
}
```

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

### Place LTP Order using cURL

Source: https://tradeapi.finam.ru/docs/rest/ordersservice_placesltporder.md

Use this cURL command to authenticate and place an LTP order. Ensure you replace YOUR_API_TOKEN and YOUR_ACCOUNT_ID with your actual credentials. The command first retrieves a token and then uses it to submit the order details.

```shell
TOKEN=$(curl -s -X POST 'https://api.finam.ru/v1/sessions' \
  -H 'Content-Type: application/json' \
  -d '{"secret":"YOUR_API_TOKEN"}' | jq -r '.token')

curl -X POST 'https://api.finam.ru/v1/accounts/YOUR_ACCOUNT_ID/orders' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "symbol": "string",
  "quantity": {
    "value": "string"
  },
  "side": "SIDE_UNSPECIFIED",
  "type": "ORDER_TYPE_UNSPECIFIED",
  "time_in_force": "TIME_IN_FORCE_UNSPECIFIED",
  "limit_price": {
    "value": "string"
  },
  "stop_price": {
    "value": "string"
  },
  "stop_condition": "STOP_CONDITION_UNSPECIFIED",
  "legs": [
    {
      "symbol": "string",
      "quantity": {
        "value": "string"
      },
      "side": "SIDE_UNSPECIFIED"
    }
  ],
  "client_order_id": "string",
  "valid_before": "VALID_BEFORE_UNSPECIFIED",
  "comment": "string"}'
```

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

### Cancel Order in Python

Source: https://tradeapi.finam.ru/docs/rest/ordersservice_cancelorder.md

Python example demonstrating how to cancel an order using the requests library. It includes obtaining an auth token and making the DELETE request.

```python
import requests

auth_response = requests.post(
    "https://api.finam.ru/v1/sessions",
    json={
    "secret": "YOUR_API_TOKEN"
}
)
token = auth_response.json()["token"]

response = requests.delete(
    "https://api.finam.ru/v1/accounts/YOUR_ACCOUNT_ID/orders/YOUR_ORDER_ID",
    headers={
        "Authorization": f"Bearer {token}"
    },
)
data = response.json()
```

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

### Get Account Information

Source: https://tradeapi.finam.ru/docs/rest/accountsservice_getaccount.md

Retrieve detailed information for a specific account using its ID. This involves authenticating with an API token and making a GET request to the /v1/accounts/{account_id} endpoint.

```json
{
  "account_id": "string",
  "type": "string",
  "status": "string",
  "equity": {
    "value": "string"
  },
  "unrealized_profit": {
    "value": "string"
  },
  "positions": [
    {
      "symbol": "string",
      "quantity": {
        "value": "string"
      },
      "average_price": {
        "value": "string"
      },
      "current_price": {
        "value": "string"
      },
      "maintenance_margin": {
        "value": "string"
      },
      "daily_pnl": {
        "value": "string"
      },
      "unrealized_pnl": {
        "value": "string"
      }
    }
  ],
  "cash": [
    {
      "currency_code": "string",
      "units": "string",
      "nanos": 0
    }
  ],
  "portfolio_mc": {
    "available_cash": {
      "value": "string"
    },
    "initial_margin": {
      "value": "string"
    },
    "maintenance_margin": {
      "value": "string"
    }
  },
  "portfolio_mct": "string",
  "portfolio_forts": {
    "available_cash": {
      "value": "string"
    },
    "money_reserved": {
      "value": "string"
    }
  },
  "open_account_date": "string",
  "first_trade_date": "string",
  "first_non_trade_date": "string"
}
```

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

### Place a Limit Buy Order

Source: https://tradeapi.finam.ru/docs/rest/#tag/ordersservice/get/v1/accounts/{accountId}/orders

Example of placing a limit buy order for SBER@MISX. The account ID is taken from the URL path, and other fields are provided in the request body.

```json
{
  "symbol": "SBER@MISX",
  "quantity": { "value": "10" },
  "side": "SIDE_BUY",
  "type": "ORDER_TYPE_LIMIT",
  "time_in_force": "TIME_IN_FORCE_DAY",
  "limit_price": { "value": "150.50" }
}
```

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

### AssetsService - GetAssetParams

Source: https://tradeapi.finam.ru/docs/rest/llms.txt

Get trading parameters for an instrument.

```APIDOC
## GET /GetAssetParams

### Description
Get trading parameters for an instrument.

### Method
GET

### Endpoint
/GetAssetParams

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The symbol of the instrument.

### Response
#### Success Response (200)
- **lot_size** (number) - The minimum tradeable quantity.
- **tick_size** (number) - The minimum price fluctuation.
- **margin_calc_mode** (string) - The margin calculation mode.

### Response Example
```json
{
  "lot_size": 1,
  "tick_size": 0.01,
  "margin_calc_mode": "short"
}
```
```

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

### Authenticate and Fetch Options Data - PHP

Source: https://tradeapi.finam.ru/docs/rest/assetsservice_clock.md

Illustrates how to authenticate and retrieve options data using PHP with cURL. This involves setting up cURL requests for authentication and data retrieval, including JSON encoding and decoding.

```php
<?php

$authCh = curl_init('https://api.finam.ru/v1/sessions');
curl_setopt($authCh, CURLOPT_RETURNTRANSFER, true);
curl_setopt($authCh, CURLOPT_POST, true);
curl_setopt($authCh, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($authCh, CURLOPT_POSTFIELDS, json_encode(['secret' => 'YOUR_API_TOKEN']));
$authResponse = json_decode(curl_exec($authCh), true);
curl_close($authCh);
$token = $authResponse['token'];

$ch = curl_init('https://api.finam.ru/v1/assets/YOUR_UNDERLYING_SYMBOL/options?' . http_build_query(['root' => 'YOUR_ROOT', 'expiration_date.year' => 'YOUR_EXPIRATION_DATE.YEAR', 'expiration_date.month' => 'YOUR_EXPIRATION_DATE.MONTH', 'expiration_date.day' => 'YOUR_EXPIRATION_DATE.DAY']));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $token]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

```

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

### Get JWT Token and Place SLTP Order (JavaScript)

Source: https://tradeapi.finam.ru/docs/rest/authservice_auth.md

Demonstrates how to obtain a JWT token using your API secret and then use it to place an SLTP order. Ensure your API secret and account ID are correctly substituted.

```javascript
const authResponse = await fetch('https://api.finam.ru/v1/sessions', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"secret":"YOUR_API_TOKEN"})
});
const { token } = await authResponse.json();

const response = await fetch('https://api.finam.ru/v1/accounts/YOUR_ACCOUNT_ID/sltp-orders', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "symbol": "string",
    "side": "SIDE_UNSPECIFIED",
    "quantity_sl": {
      "value": "string"
    },
    "sl_price": {
      "value": "string"
    },
    "limit_price": {
      "value": "string"
    },
    "quantity_tp": {
      "value": "string"
    },
    "tp_price": {
      "value": "string"
    },
    "tp_guard_spread": {
      "value": "string"
    },
    "tp_spread_measure": "TP_SPREAD_MEASURE_UNDEFINED",
    "client_order_id": "string",
    "valid_before": "VALID_BEFORE_UNSPECIFIED",
    "valid_expiry_time": "string",
    "comment": "string"
  })
});
const data = await response.json();
```

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

### AssetsService - Clock

Source: https://tradeapi.finam.ru/docs/rest/llms.txt

Get the current time on the server.

```APIDOC
## GET /Clock

### Description
Get the current time on the server.

### Method
GET

### Endpoint
/Clock

### Response
#### Success Response (200)
- **time** (string) - The current server time in ISO 8601 format.

### Response Example
```json
{
  "time": "2023-10-26T10:10:00Z"
}
```
```

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

### MarketDataService - LastQuote

Source: https://tradeapi.finam.ru/docs/rest/llms.txt

Get the last quote for an instrument.

```APIDOC
## GET /LastQuote

### Description
Get the last quote for an instrument.

### Method
GET

### Endpoint
/LastQuote

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The symbol of the instrument.

### Response
#### Success Response (200)
- **bid** (number) - The current bid price.
- **ask** (number) - The current ask price.
- **last** (number) - The price of the last trade.
- **timestamp** (string) - The timestamp of the last quote.

### Response Example
```json
{
  "bid": 150.90,
  "ask": 151.10,
  "last": 151.00,
  "timestamp": "2023-10-26T10:05:00Z"
}
```
```
Tokens:
Raw