@finam/grpc-tradeapi 2.14.0

package/grpc/tradeapi/v1/accounts/accounts_service_pb.d.ts

@@ -0,0 +1,671 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file grpc/tradeapi/v1/accounts/accounts_service.proto (package grpc.tradeapi.v1.accounts, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { Decimal } from "../../../../google/type/decimal_pb.js";
+import type { Money } from "../../../../google/type/money_pb.js";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { Interval } from "../../../../google/type/interval_pb.js";
+import type { AccountTrade } from "../trade_pb.js";
+
+/**
+ * Describes the file grpc/tradeapi/v1/accounts/accounts_service.proto.
+ */
+export declare const file_grpc_tradeapi_v1_accounts_accounts_service: GenFile;
+
+/**
+ * Запрос получения информации по конкретному аккаунту
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.GetAccountRequest
+ */
+export declare type GetAccountRequest = Message<"grpc.tradeapi.v1.accounts.GetAccountRequest"> & {
+  /**
+   * Идентификатор аккаунта
+   *
+   * @generated from field: string account_id = 1;
+   */
+  accountId: string;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.GetAccountRequest.
+ * Use `create(GetAccountRequestSchema)` to create a new message.
+ */
+export declare const GetAccountRequestSchema: GenMessage<GetAccountRequest>;
+
+/**
+ * Информация о конкретном аккаунте
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.GetAccountResponse
+ */
+export declare type GetAccountResponse = Message<"grpc.tradeapi.v1.accounts.GetAccountResponse"> & {
+  /**
+   * Идентификатор аккаунта
+   *
+   * @generated from field: string account_id = 1;
+   */
+  accountId: string;
+
+  /**
+   * Тип аккаунта
+   *
+   * @generated from field: string type = 2;
+   */
+  type: string;
+
+  /**
+   * Статус аккаунта
+   *
+   * @generated from field: string status = 3;
+   */
+  status: string;
+
+  /**
+   * Доступные средства плюс стоимость открытых позиций
+   *
+   * @generated from field: google.type.Decimal equity = 4;
+   */
+  equity?: Decimal;
+
+  /**
+   * Нереализованная прибыль
+   *
+   * @generated from field: google.type.Decimal unrealized_profit = 5;
+   */
+  unrealizedProfit?: Decimal;
+
+  /**
+   * Позиции. Открытые, плюс теоретические (по неисполненным активным заявкам)
+   *
+   * @generated from field: repeated grpc.tradeapi.v1.accounts.Position positions = 6;
+   */
+  positions: Position[];
+
+  /**
+   * Сумма собственных денежных средств на счете, доступная для торговли. Не включает маржинальные средства.
+   *
+   * @generated from field: repeated google.type.Money cash = 7;
+   */
+  cash: Money[];
+
+  /**
+   * @generated from oneof grpc.tradeapi.v1.accounts.GetAccountResponse.portfolio
+   */
+  portfolio: {
+    /**
+     * Общий тип для счетов Московской Биржи. Включает в себя как единые, так и моно счета.
+     *
+     * @generated from field: grpc.tradeapi.v1.accounts.MC portfolio_mc = 8;
+     */
+    value: MC;
+    case: "portfolioMc";
+  } | {
+    /**
+     * Тип портфеля для счетов на американских рынках.
+     *
+     * @generated from field: grpc.tradeapi.v1.accounts.MCT portfolio_mct = 9;
+     */
+    value: MCT;
+    case: "portfolioMct";
+  } | {
+    /**
+     * Тип портфеля для торговли на срочном рынке Московской Биржи.
+     *
+     * @generated from field: grpc.tradeapi.v1.accounts.FORTS portfolio_forts = 10;
+     */
+    value: FORTS;
+    case: "portfolioForts";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * Дата открытия счета
+   *
+   * @generated from field: google.protobuf.Timestamp open_account_date = 11;
+   */
+  openAccountDate?: Timestamp;
+
+  /**
+   * Дата первой торговой транзакции
+   *
+   * @generated from field: google.protobuf.Timestamp first_trade_date = 12;
+   */
+  firstTradeDate?: Timestamp;
+
+  /**
+   * Дата первой неторговой транзакции
+   *
+   * @generated from field: google.protobuf.Timestamp first_non_trade_date = 13;
+   */
+  firstNonTradeDate?: Timestamp;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.GetAccountResponse.
+ * Use `create(GetAccountResponseSchema)` to create a new message.
+ */
+export declare const GetAccountResponseSchema: GenMessage<GetAccountResponse>;
+
+/**
+ * Общий тип для счетов Московской Биржи. Включает в себя как единые, так и специализированные (моно) счета для разных секций биржи.
+ * Единый торговый счет (ЕТС): Позволяет торговать на нескольких рынках (фондовый, валютный. срочный, spb, иностранные бумаги, иностранные фьючерсы) с единой денежной позиции.
+ * Моно-счет фондового рынка MOEX: Изолированный счет для торговли акциями, облигациями и паями.
+ * Моно-счет валютного рынка MOEX: Изолированный счет для операций с валютными парами (например, CNYRUB_TOM).
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.MC
+ */
+export declare type MC = Message<"grpc.tradeapi.v1.accounts.MC"> & {
+  /**
+   * Сумма собственных денежных средств на счете, доступная для торговли. Включает маржинальные средства.
+   *
+   * @generated from field: google.type.Decimal available_cash = 1;
+   */
+  availableCash?: Decimal;
+
+  /**
+   * Начальная маржа
+   *
+   * @generated from field: google.type.Decimal initial_margin = 2;
+   */
+  initialMargin?: Decimal;
+
+  /**
+   * Минимальная маржа
+   *
+   * @generated from field: google.type.Decimal maintenance_margin = 3;
+   */
+  maintenanceMargin?: Decimal;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.MC.
+ * Use `create(MCSchema)` to create a new message.
+ */
+export declare const MCSchema: GenMessage<MC>;
+
+/**
+ * Тип портфеля для счетов на американских рынках.
+ * Предоставляет доступ к биржам США: NYSE, NASDAQ, CBOE, CME, сделки с американскими акциями, фьючерсами и опционами.
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.MCT
+ */
+export declare type MCT = Message<"grpc.tradeapi.v1.accounts.MCT"> & {
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.MCT.
+ * Use `create(MCTSchema)` to create a new message.
+ */
+export declare const MCTSchema: GenMessage<MCT>;
+
+/**
+ * Тип портфеля для торговли на срочном рынке Московской Биржи.
+ * Предназначен для работы с производными финансовыми инструментами: фьючерсами и опционами.
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.FORTS
+ */
+export declare type FORTS = Message<"grpc.tradeapi.v1.accounts.FORTS"> & {
+  /**
+   * Сумма собственных денежных средств на счете, доступная для торговли. Включает маржинальные средства.
+   *
+   * @generated from field: google.type.Decimal available_cash = 1;
+   */
+  availableCash?: Decimal;
+
+  /**
+   * Минимальная маржа (необходимая сумма обеспечения под открытые позиции)
+   *
+   * @generated from field: google.type.Decimal money_reserved = 2;
+   */
+  moneyReserved?: Decimal;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.FORTS.
+ * Use `create(FORTSSchema)` to create a new message.
+ */
+export declare const FORTSSchema: GenMessage<FORTS>;
+
+/**
+ * Запрос получения истории по сделкам
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.TradesRequest
+ */
+export declare type TradesRequest = Message<"grpc.tradeapi.v1.accounts.TradesRequest"> & {
+  /**
+   * Идентификатор аккаунта
+   *
+   * @generated from field: string account_id = 1;
+   */
+  accountId: string;
+
+  /**
+   * Лимит количества сделок
+   *
+   * @generated from field: int32 limit = 2;
+   */
+  limit: number;
+
+  /**
+   * Начало и окончание запрашиваемого периода, Unix epoch time
+   *
+   * @generated from field: google.type.Interval interval = 3;
+   */
+  interval?: Interval;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.TradesRequest.
+ * Use `create(TradesRequestSchema)` to create a new message.
+ */
+export declare const TradesRequestSchema: GenMessage<TradesRequest>;
+
+/**
+ * История по сделкам
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.TradesResponse
+ */
+export declare type TradesResponse = Message<"grpc.tradeapi.v1.accounts.TradesResponse"> & {
+  /**
+   * Сделки по аккаунту
+   *
+   * @generated from field: repeated grpc.tradeapi.v1.AccountTrade trades = 1;
+   */
+  trades: AccountTrade[];
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.TradesResponse.
+ * Use `create(TradesResponseSchema)` to create a new message.
+ */
+export declare const TradesResponseSchema: GenMessage<TradesResponse>;
+
+/**
+ * Запрос получения списка транзакций
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.TransactionsRequest
+ */
+export declare type TransactionsRequest = Message<"grpc.tradeapi.v1.accounts.TransactionsRequest"> & {
+  /**
+   * Идентификатор аккаунта
+   *
+   * @generated from field: string account_id = 1;
+   */
+  accountId: string;
+
+  /**
+   * Лимит количества транзакций
+   *
+   * @generated from field: int32 limit = 2;
+   */
+  limit: number;
+
+  /**
+   * Начало и окончание запрашиваемого периода, Unix epoch time
+   *
+   * @generated from field: google.type.Interval interval = 3;
+   */
+  interval?: Interval;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.TransactionsRequest.
+ * Use `create(TransactionsRequestSchema)` to create a new message.
+ */
+export declare const TransactionsRequestSchema: GenMessage<TransactionsRequest>;
+
+/**
+ * Список транзакций
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.TransactionsResponse
+ */
+export declare type TransactionsResponse = Message<"grpc.tradeapi.v1.accounts.TransactionsResponse"> & {
+  /**
+   * Транзакции по аккаунту
+   *
+   * @generated from field: repeated grpc.tradeapi.v1.accounts.Transaction transactions = 1;
+   */
+  transactions: Transaction[];
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.TransactionsResponse.
+ * Use `create(TransactionsResponseSchema)` to create a new message.
+ */
+export declare const TransactionsResponseSchema: GenMessage<TransactionsResponse>;
+
+/**
+ * Информация о позиции
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.Position
+ */
+export declare type Position = Message<"grpc.tradeapi.v1.accounts.Position"> & {
+  /**
+   * Символ инструмента
+   *
+   * @generated from field: string symbol = 1;
+   */
+  symbol: string;
+
+  /**
+   * Количество в шт., значение со знаком определяющее (long-short)
+   *
+   * @generated from field: google.type.Decimal quantity = 2;
+   */
+  quantity?: Decimal;
+
+  /**
+   * Средняя цена. Не заполняется для FORTS позиций
+   *
+   * @generated from field: google.type.Decimal average_price = 3;
+   */
+  averagePrice?: Decimal;
+
+  /**
+   * Текущая цена
+   *
+   * @generated from field: google.type.Decimal current_price = 4;
+   */
+  currentPrice?: Decimal;
+
+  /**
+   * Поддерживающее гарантийное обеспечение. Заполняется только для FORTS позиций
+   *
+   * @generated from field: google.type.Decimal maintenance_margin = 5;
+   */
+  maintenanceMargin?: Decimal;
+
+  /**
+   * Прибыль или убыток за текущий день (PnL). Не заполняется для FORTS позиций
+   *
+   * @generated from field: google.type.Decimal daily_pnl = 6;
+   */
+  dailyPnl?: Decimal;
+
+  /**
+   * Суммарная нереализованная прибыль или убыток (PnL) текущей позиции
+   *
+   * @generated from field: google.type.Decimal unrealized_pnl = 7;
+   */
+  unrealizedPnl?: Decimal;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.Position.
+ * Use `create(PositionSchema)` to create a new message.
+ */
+export declare const PositionSchema: GenMessage<Position>;
+
+/**
+ * Информация о транзакции
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.Transaction
+ */
+export declare type Transaction = Message<"grpc.tradeapi.v1.accounts.Transaction"> & {
+  /**
+   * Идентификатор транзакции
+   *
+   * @generated from field: string id = 1;
+   */
+  id: string;
+
+  /**
+   * Тип транзакции из TransactionCategory
+   *
+   * @generated from field: string category = 2 [deprecated = true];
+   * @deprecated
+   */
+  category: string;
+
+  /**
+   * Метка времени
+   *
+   * @generated from field: google.protobuf.Timestamp timestamp = 4;
+   */
+  timestamp?: Timestamp;
+
+  /**
+   * Символ инструмента
+   *
+   * @generated from field: string symbol = 5;
+   */
+  symbol: string;
+
+  /**
+   * Изменение в деньгах
+   *
+   * @generated from field: google.type.Money change = 6;
+   */
+  change?: Money;
+
+  /**
+   * Информация о сделке
+   *
+   * @generated from field: grpc.tradeapi.v1.accounts.Transaction.Trade trade = 7;
+   */
+  trade?: Transaction_Trade;
+
+  /**
+   * Категория транзакции из TransactionCategory.
+   *
+   * @generated from field: grpc.tradeapi.v1.accounts.Transaction.TransactionCategory transaction_category = 8;
+   */
+  transactionCategory: Transaction_TransactionCategory;
+
+  /**
+   * Наименование транзакции
+   *
+   * @generated from field: string transaction_name = 9;
+   */
+  transactionName: string;
+
+  /**
+   * Изменение в штуках, только для трансфера бумаг (для TransactionCategory = TRANSFER)
+   *
+   * @generated from field: google.type.Decimal change_qty = 10;
+   */
+  changeQty?: Decimal;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.Transaction.
+ * Use `create(TransactionSchema)` to create a new message.
+ */
+export declare const TransactionSchema: GenMessage<Transaction>;
+
+/**
+ * Объект заполняется для торговых типов транзакций
+ *
+ * @generated from message grpc.tradeapi.v1.accounts.Transaction.Trade
+ */
+export declare type Transaction_Trade = Message<"grpc.tradeapi.v1.accounts.Transaction.Trade"> & {
+  /**
+   * Количество в шт.
+   *
+   * @generated from field: google.type.Decimal size = 1;
+   */
+  size?: Decimal;
+
+  /**
+   * Цена сделки за штуку. Цена исполнения/Размер премии по опциону. Это цена заключения, значение берется из сделки.
+   *
+   * @generated from field: google.type.Decimal price = 2;
+   */
+  price?: Decimal;
+
+  /**
+   * НКД. Заполнено если в сделке есть НКД
+   *
+   * @generated from field: google.type.Decimal accrued_interest = 3;
+   */
+  accruedInterest?: Decimal;
+};
+
+/**
+ * Describes the message grpc.tradeapi.v1.accounts.Transaction.Trade.
+ * Use `create(Transaction_TradeSchema)` to create a new message.
+ */
+export declare const Transaction_TradeSchema: GenMessage<Transaction_Trade>;
+
+/**
+ * Категории транзакции.
+ *
+ * @generated from enum grpc.tradeapi.v1.accounts.Transaction.TransactionCategory
+ */
+export enum Transaction_TransactionCategory {
+  /**
+   * Прочее
+   *
+   * @generated from enum value: OTHERS = 0;
+   */
+  OTHERS = 0,
+
+  /**
+   * Ввод ДС
+   *
+   * @generated from enum value: DEPOSIT = 1;
+   */
+  DEPOSIT = 1,
+
+  /**
+   * Вывод ДС
+   *
+   * @generated from enum value: WITHDRAW = 2;
+   */
+  WITHDRAW = 2,
+
+  /**
+   * Доход
+   *
+   * @generated from enum value: INCOME = 5;
+   */
+  INCOME = 5,
+
+  /**
+   * Комиссия
+   *
+   * @generated from enum value: COMMISSION = 7;
+   */
+  COMMISSION = 7,
+
+  /**
+   * Налог
+   *
+   * @generated from enum value: TAX = 8;
+   */
+  TAX = 8,
+
+  /**
+   * Наследство
+   *
+   * @generated from enum value: INHERITANCE = 9;
+   */
+  INHERITANCE = 9,
+
+  /**
+   * Перевод ДС
+   *
+   * @generated from enum value: TRANSFER = 11;
+   */
+  TRANSFER = 11,
+
+  /**
+   * Расторжение договора
+   *
+   * @generated from enum value: CONTRACT_TERMINATION = 12;
+   */
+  CONTRACT_TERMINATION = 12,
+
+  /**
+   * Расходы
+   *
+   * @generated from enum value: OUTCOMES = 13;
+   */
+  OUTCOMES = 13,
+
+  /**
+   * Штраф
+   *
+   * @generated from enum value: FINE = 15;
+   */
+  FINE = 15,
+
+  /**
+   * Займ
+   *
+   * @generated from enum value: LOAN = 19;
+   */
+  LOAN = 19,
+}
+
+/**
+ * Describes the enum grpc.tradeapi.v1.accounts.Transaction.TransactionCategory.
+ */
+export declare const Transaction_TransactionCategorySchema: GenEnum<Transaction_TransactionCategory>;
+
+/**
+ * Сервис аккаунтов
+ *
+ * @generated from service grpc.tradeapi.v1.accounts.AccountsService
+ */
+export declare const AccountsService: GenService<{
+  /**
+   * Получение информации по конкретному аккаунту
+   * Пример HTTP запроса:
+   * GET /v1/accounts/A12345
+   * Authorization: <token>
+   *
+   * @generated from rpc grpc.tradeapi.v1.accounts.AccountsService.GetAccount
+   */
+  getAccount: {
+    methodKind: "unary";
+    input: typeof GetAccountRequestSchema;
+    output: typeof GetAccountResponseSchema;
+  },
+  /**
+   * Получение истории по сделкам аккаунта
+   * Пример HTTP запроса:
+   * GET /v1/accounts/A12345/trades?limit=50&interval.start_time=2023-01-01T00:00:00Z&interval.end_time=2023-01-31T23:59:59Z
+   * Authorization: <token>
+   *
+   * Параметры:
+   * - account_id - передается в URL пути
+   * - limit и interval - передаются как query-параметры
+   *
+   * @generated from rpc grpc.tradeapi.v1.accounts.AccountsService.Trades
+   */
+  trades: {
+    methodKind: "unary";
+    input: typeof TradesRequestSchema;
+    output: typeof TradesResponseSchema;
+  },
+  /**
+   * Получение списка транзакций аккаунта
+   * Пример HTTP запроса:
+   * GET /v1/accounts/A12345/transactions?limit=50&interval.start_time=2023-01-01T00:00:00Z&interval.end_time=2023-01-31T23:59:59Z
+   * Authorization: <token>
+   *
+   * Параметры:
+   * - account_id - передается в URL пути
+   * - limit и interval - передаются как query-параметры
+   *
+   * @generated from rpc grpc.tradeapi.v1.accounts.AccountsService.Transactions
+   */
+  transactions: {
+    methodKind: "unary";
+    input: typeof TransactionsRequestSchema;
+    output: typeof TransactionsResponseSchema;
+  },
+  /**
+   * Подписка на информацию по аккаунту. Стрим метод
+   *
+   * @generated from rpc grpc.tradeapi.v1.accounts.AccountsService.SubscribeAccount
+   */
+  subscribeAccount: {
+    methodKind: "server_streaming";
+    input: typeof GetAccountRequestSchema;
+    output: typeof GetAccountResponseSchema;
+  },
+}>;
+