All files StopOrdersService.ts

100% Statements 18/18
100% Branches 6/6
100% Functions 6/6
100% Lines 18/18

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 26524x           24x   24x   24x   24x             24x   24x   24x   24x             24x   24x   24x   24x   24x                                                                                                                                                                                                                                                                                                                 24x                                                     1x                                       1x                                         1x      
import { Common, MoneyValue, Quotation } from './'
 
/**
 * Направление сделки стоп-заявки
 * @see https://tinkoff.github.io/investAPI/stoporders/#stoporderdirection
 */
export enum StopOrderDirection {
  /** Значение не указано */
  STOP_ORDER_DIRECTION_UNSPECIFIED,
  /** Покупка */
  STOP_ORDER_DIRECTION_BUY,
  /** Продажа */
  STOP_ORDER_DIRECTION_SELL
}
 
/**
 * Тип экспирации стоп-заявке
 * @see https://tinkoff.github.io/investAPI/stoporders/#stoporderexpirationtype
 */
export enum StopOrderExpirationType {
  /** Значение не указано */
  STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED,
  /** Действительно до отмены */
  STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL,
  /** Действительно до даты снятия */
  STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE
}
 
/**
 * Тип стоп-заявки
 * @see https://tinkoff.github.io/investAPI/stoporders/#stopordertype
 */
export enum StopOrderType {
  /** Значение не указано */
  STOP_ORDER_TYPE_UNSPECIFIED,
  /** Take-profit заявка */
  STOP_ORDER_TYPE_TAKE_PROFIT,
  /** Stop-loss заявка */
  STOP_ORDER_TYPE_STOP_LOSS,
  /** Stop-limit заявка */
  STOP_ORDER_TYPE_STOP_LIMIT
}
 
/**
 * Информация о стоп-заявке
 * @see https://tinkoff.github.io/investAPI/stoporders/#stoporder
 */
export interface StopOrder {
  /** Идентификатор-идентификатор стоп-заявки */
  stopOrderId: string
  /**
   * Запрошено лотов
   * @remarks `int64`
   */
  lotsRequested: string
  /** Figi-идентификатор инструмента */
  figi: string
  /** Направление операции */
  direction: StopOrderDirection
  /** Валюта стоп-заявки */
  currency: string
  /** Тип стоп-заявки */
  orderType: StopOrderType
  /**
   * Дата и время выставления заявки в часовом поясе UTC
   * @remarks `google.protobuf.Timestamp`
   */
  createDate: string
  /**
   * Дата и время конвертации стоп-заявки в биржевую в часовом поясе UTC
   * @remarks `google.protobuf.Timestamp`
   */
  activationDateTime: string
  /**
   * Дата и время снятия заявки в часовом поясе UTC
   * @remarks `google.protobuf.Timestamp`
   */
  expirationTime: string
  /**
   * Цена заявки за 1 инструмент
   * @description Для получения стоимости лота требуется умножить на лотность инструмента
   */
  price: MoneyValue
  /**
   * Цена активации стоп-заявки за 1 инструмент
   * @description Для получения стоимости лота требуется умножить на лотность инструмента
   */
  stopPrice: MoneyValue
  /** instrumentUid идентификатор инструмента */
  instrumentUid: string
}
 
/**
 * Запрос выставления стоп-заявки
 * @see https://tinkoff.github.io/investAPI/stoporders/#poststoporderrequest
 */
export interface PostStopOrderRequest {
  /**
   * Figi-идентификатор инструмента
   * @description Необходимо использовать instrumentId
   * @deprecated Deprecated
   */
  figi?: string
  /**
   * Количество лотов
   * @remarks `int64`
   */
  quantity: string
  /**
   * Цена за 1 инструмент
   * @description Для получения стоимости лота требуется умножить на лотность инструмента
   */
  price: Quotation
  /**
   * Стоп-цена заявки за 1 инструмент
   * @description Для получения стоимости лота требуется умножить на лотность инструмента
   */
  stopPrice: Quotation
  /** Направление операции */
  direction: StopOrderDirection
  /** Номер счёта */
  accountId: string
  /** Тип экспирации заявки */
  expirationType: StopOrderExpirationType
  /** Тип заявки */
  stopOrderType: StopOrderType
  /**
   * Дата и время окончания действия стоп-заявки в часовом поясе UTC
   * @description Для ExpirationType = GoodTillDate заполнение обязательно
   * @remarks `google.protobuf.Timestamp`
   */
  expireDate?: string
  /** Идентификатор инструмента, принимает значения Figi или instrumentUid */
  instrumentId: string
}
 
/**
 * Результат выставления стоп-заявки
 * @see https://tinkoff.github.io/investAPI/stoporders/#poststoporderresponse
 */
export interface PostStopOrderResponse {
  /** Уникальный идентификатор стоп-заявки */
  stopOrderId: string
}
 
/**
 * Запрос получения списка активных стоп-заявок
 * @see https://tinkoff.github.io/investAPI/stoporders/#getstopordersrequest
 */
export interface GetStopOrdersRequest {
  /** Идентификатор счёта клиента */
  accountId: string
}
 
/**
 * Список активных стоп-заявок
 * @see https://tinkoff.github.io/investAPI/stoporders/#getstopordersresponse
 */
export interface GetStopOrdersResponse {
  /** Массив стоп-заявок по счёту */
  stopOrders: StopOrder[]
}
 
/**
 * Запрос отмены выставленной стоп-заявки
 * @see https://tinkoff.github.io/investAPI/stoporders/#cancelstoporderrequest
 */
export interface CancelStopOrderRequest {
  /** Идентификатор счёта клиента */
  accountId: string
  /** Уникальный идентификатор стоп-заявки */
  stopOrderId: string
}
 
/**
 * Результат отмены выставленной стоп-заявки
 * @see https://tinkoff.github.io/investAPI/stoporders/#cancelstoporderresponse
 */
export interface CancelStopOrderResponse {
  /**
   * Время отмены заявки в часовом поясе UTC
   * @remarks `google.protobuf.Timestamp`
   */
  time: string
}
 
/**
 * Сервис предназначен для работы со стоп-заявками:
 * 1. выставление;
 * 2. отмена;
 * 3. получение списка стоп-заявок.
 * @see https://tinkoff.github.io/investAPI/stoporders/#stopordersservice
 */
export class StopOrdersService extends Common {
  /**
   * Метод выставления стоп-заявки
   * ```js
   * import { StopOrdersService, StopOrderDirection, StopOrderType, StopOrderExpirationType } from '@tomasevich/tinkoff'
   *
   * const stopOrdersService = new StopOrdersService('TOKEN', false)
   * const { stopOrderId } = await stopOrdersService.PostStopOrder({
   *  figi: '',
   *  quantity: "1",
   *  price: StopOrdersService.Quotation('100.1'),
   *  stopPrice: StopOrdersService.Quotation('102.1'),
   *  direction: StopOrderDirection.STOP_ORDER_DIRECTION_BUY,
   *  accountId: '<ACCOUNT_ID>'
   *  expirationType: StopOrderExpirationType.STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL,
   *  stopOrderType: StopOrderType.STOP_ORDER_TYPE_STOP_LOSS,
   *  expireDate: ''
   *  instrumentId: '6afa6f80-03a7-4d83-9cf0-c19d7d021f76'
   * })
   *
   * console.log(stopOrderId)
   * ```
   * @see https://tinkoff.github.io/investAPI/stoporders/#poststoporder
   */
  public PostStopOrder(
    body: PostStopOrderRequest
  ): Promise<PostStopOrderResponse> {
    return this.request('StopOrdersService', 'PostStopOrder', body)
  }
 
  /**
   * Метод получения списка активных стоп заявок по счёту
   * ```js
   * import { StopOrdersService } from '@tomasevich/tinkoff'
   *
   * const stopOrdersService = new StopOrdersService('TOKEN', false)
   * const { stopOrders } = await stopOrdersService.GetStopOrders({
   *  accountId: '<ACCOUNT_ID>',
   * })
   *
   * console.log(stopOrders)
   * ```
   * @see https://tinkoff.github.io/investAPI/stoporders/#getstoporders
   */
  public GetStopOrders(
    body: GetStopOrdersRequest
  ): Promise<GetStopOrdersResponse> {
    return this.request('StopOrdersService', 'GetStopOrders', body)
  }
 
  /**
   * Метод отмены стоп-заявки
   * ```js
   * import { StopOrdersService } from '@tomasevich/tinkoff'
   *
   * const stopOrdersService = new StopOrdersService('TOKEN', false)
   * const { time } = await stopOrdersService.CancelStopOrder({
   *  accountId: '<ACCOUNT_ID>',
   *  stopOrderId: '<STOP_ORDER_ID>',
   * })
   *
   * console.log(time)
   * ```
   * @see https://tinkoff.github.io/investAPI/stoporders/#cancelstoporder
   */
  public CancelStopOrder(
    body: CancelStopOrderRequest
  ): Promise<CancelStopOrderResponse> {
    return this.request('StopOrdersService', 'CancelStopOrder', body)
  }
}