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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 2x 1x 1x 1x 1x | import { Common, MoneyValue, Quotation } from './'
/**
* Направление операции
* @see https://tinkoff.github.io/investAPI/orders/#orderdirection
*/
export enum OrderDirection {
/** Значение не указано */
ORDER_DIRECTION_UNSPECIFIED,
/** Покупка */
ORDER_DIRECTION_BUY,
/** Продажа */
ORDER_DIRECTION_SELL
}
/**
* Тип заявки
* @see https://tinkoff.github.io/investAPI/orders/#ordertype
*/
export enum OrderType {
/** Значение не указано */
ORDER_TYPE_UNSPECIFIED,
/** Лимитная */
ORDER_TYPE_LIMIT,
/** Рыночная */
ORDER_TYPE_MARKET,
/** Лучшая цена */
ORDER_TYPE_BESTPRICE
}
/**
* Текущий статус заявки (поручения)
* @see https://tinkoff.github.io/investAPI/orders/#orderexecutionreportstatus
*/
export enum OrderExecutionReportStatus {
/** none */
EXECUTION_REPORT_STATUS_UNSPECIFIED,
/** Исполнена */
EXECUTION_REPORT_STATUS_FILL,
/** Отклонена */
EXECUTION_REPORT_STATUS_REJECTED,
/** Отменена пользователем */
EXECUTION_REPORT_STATUS_CANCELLED,
/** Новая */
EXECUTION_REPORT_STATUS_NEW,
/** Частично исполнена */
EXECUTION_REPORT_STATUS_PARTIALLYFILL
}
/**
* Тип цены
* @see https://tinkoff.github.io/investAPI/orders/#pricetype
*/
export enum PriceType {
/** Значение не определено */
PRICE_TYPE_UNSPECIFIED,
/** Цена в пунктах (только для фьючерсов и облигаций) */
PRICE_TYPE_POINT,
/** Цена в валюте расчётов по инструменту */
PRICE_TYPE_CURRENCY
}
/**
* Сделки в рамках торгового поручения
* @see https://tinkoff.github.io/investAPI/orders/#orderstage
*/
export interface OrderStage {
/**
* Цена за 1 инструмент
* @description Для получения стоимости лота требуется умножить на лотность инструмента
*/
price: MoneyValue
/**
* Количество лотов
* @remarks `int64`
*/
quantity: string
/** Идентификатор сделки */
tradeId: string
}
/**
* Запрос выставления торгового поручения
* @see https://tinkoff.github.io/investAPI/orders/#postorderrequest
*/
export interface PostOrderRequest {
/**
* Количество лотов
* @remarks `int64`
*/
quantity: string
/**
* Цена за 1 инструмент
* @description Для получения стоимости лота требуется умножить на лотность инструмента. Игнорируется для рыночных поручений
*/
price: Quotation
/** Направление операции */
direction: OrderDirection
/** Номер счёта */
accountId: string
/** Тип заявки */
orderType: OrderType
/**
* Идентификатор запроса выставления поручения для целей идемпотентности в формате `UID`
* @description Максимальная длина 36 символов
*/
orderId?: string
/** Идентификатор инструмента, принимает значения `Figi` или `InstrumentUid` */
instrumentId: string
/**
* Figi-идентификатор инструмента
* @deprecated Необходимо использовать `instrumentId`
*/
figi?: string
}
/**
* Информация о выставлении поручения
* @see https://tinkoff.github.io/investAPI/orders/#postorderresponse
*/
export interface PostOrderResponse {
/** Биржевой идентификатор заявки */
orderId: string
/** Текущий статус заявки */
executionReportStatus: OrderExecutionReportStatus
/**
* Запрошено лотов
* @remarks `int64`
*/
lotsRequested: string
/**
* Исполнено лотов
* @remarks `int64`
*/
lotsExecuted: string
/**
* Начальная цена заявки
* @description Произведение количества запрошенных лотов на цену
*/
initialOrderPrice: MoneyValue
/** Исполненная средняя цена одного инструмента в заявке */
executedOrderPrice: MoneyValue
/** Итоговая стоимость заявки, включающая все комиссии */
totalOrderAmount: MoneyValue
/**
* Начальная комиссия
* @description Комиссия рассчитанная при выставлении заявки
*/
initialCommission: MoneyValue
/** Фактическая комиссия по итогам исполнения заявки */
executedCommission: MoneyValue
/**
* Значение НКД (накопленного купонного дохода) на дату
* @description Подробнее: НКД при выставлении торговых поручений
*/
aciValue: MoneyValue
/** Figi-идентификатор инструмента */
figi: string
/** Направление сделки */
direction: OrderDirection
/**
* Начальная цена за 1 инструмент
* @description Для получения стоимости лота требуется умножить на лотность инструмента
*/
initialSecurityPrice: MoneyValue
/** Тип заявки */
orderType: OrderType
/** Дополнительные данные об исполнении заявки */
message: string
/** Начальная цена заявки в пунктах (для фьючерсов) */
initialOrderPricePt: Quotation
/** UID идентификатор инструмента */
instrumentUid: string
}
/**
* Запрос отмены торгового поручения
* @see https://tinkoff.github.io/investAPI/orders/#cancelorderrequest
*/
export interface CancelOrderRequest {
/** Номер счёта */
accountId: string
/** Идентификатор заявки */
orderId: string
}
/**
* Результат отмены торгового поручения
* @see https://tinkoff.github.io/investAPI/orders/#cancelorderresponse
*/
export interface CancelOrderResponse {
/**
* Дата и время отмены заявки в часовом поясе UTC
* @remarks `google.protobuf.Timestamp`
*/
time: string
}
/**
* Запрос получения статуса торгового поручения
* @see https://tinkoff.github.io/investAPI/orders/#getorderstaterequest
*/
export interface GetOrderStateRequest {
/** Номер счёта */
accountId: string
/** Идентификатор заявки */
orderId: string
}
/**
* Информация о торговом поручении
* @see https://tinkoff.github.io/investAPI/orders/#orderstate
*/
export interface OrderState {
/** Биржевой идентификатор заявки */
orderId: string
/** Текущий статус заявки */
executionReportStatus: OrderExecutionReportStatus
/**
* Запрошено лотов
* @remarks `int64`
*/
lotsRequested: string
/**
* Исполнено лотов
* @remarks `int64`
*/
lotsExecuted: string
/**
* Начальная цена заявки
* @description Произведение количества запрошенных лотов на цену
*/
initialOrderPrice: MoneyValue
/**
* Исполненная цена заявки
* @description Произведение средней цены покупки на количество лотов
*/
executedOrderPrice: MoneyValue
/** Итоговая стоимость заявки, включающая все комиссии */
totalOrderAmount: MoneyValue
/** Средняя цена позиции по сделке */
averagePositionPrice: MoneyValue
/**
* Начальная комиссия
* @description Комиссия, рассчитанная на момент подачи заявки
*/
initialCommission: MoneyValue
/** Фактическая комиссия по итогам исполнения заявки */
executedCommission: MoneyValue
/** Figi-идентификатор инструмента */
figi: string
/** Направление заявки */
direction: OrderDirection
/**
* Начальная цена за 1 инструмент
* @description Для получения стоимости лота требуется умножить на лотность инструмента
*/
initialSecurityPrice: MoneyValue
/** Стадии выполнения заявки */
stages: OrderStage[]
/** Сервисная комиссия */
serviceCommission: MoneyValue
/** Валюта заявки */
currency: string
/** Тип заявки */
orderType: OrderType
/**
* Дата и время выставления заявки в часовом поясе UTC
* @remarks `google.protobuf.Timestamp`
*/
orderDate: string
/** UID идентификатор инструмента */
instrumentUid: string
/**
* Идентификатор ключа идемпотентности, переданный клиентом, в формате UID
* @description Максимальная длина 36 символов.
*/
orderRequestId: string
}
/**
* Запрос получения списка активных торговых поручений
* @see https://tinkoff.github.io/investAPI/orders/#getordersrequest
*/
export interface GetOrdersRequest {
/** Номер счёта */
accountId: string
}
/**
* Список активных торговых поручений
* @see https://tinkoff.github.io/investAPI/orders/#getordersresponse
*/
export interface GetOrdersResponse {
/** Массив активных заявок */
orders: OrderState[]
}
/**
* Запрос изменения выставленной заявки
* @see https://tinkoff.github.io/investAPI/orders/#replaceorderrequest
*/
export interface ReplaceOrderRequest {
/** Номер счета */
accountId: string
/** Идентификатор заявки на бирже */
orderId: string
/**
* Новый идентификатор запроса выставления поручения для целей идемпотентности
* @description Максимальная длина 36 символов. Перезатирает старый ключ.
*/
idempotencyKey: string
/**
* Количество лотов
* @remarks `int64`
*/
quantity: string
/**
* Цена за 1 инструмент
*/
price: Quotation
/** Тип цены */
priceType: PriceType
}
/**
* Сервис предназначен для работы с торговыми поручениями:
* 1. выставление;
* 2. отмена;
* 3. получение статуса;
* 4. расчёт полной стоимости;
* 5. получение списка заявок.
* @see https://tinkoff.github.io/investAPI/orders/#ordersservice
*/
export class OrdersService extends Common {
/**
* Метод выставления заявки
* ```js
* import { OrdersService, OrderDirection, OrderType } from '@tomasevich/tinkoff'
*
* const ordersService = new OrdersService('TOKEN', false)
* const postOrder = await ordersService.PostOrder({
* figi: '',
* quantity: "1",
* price: OrdersService.Quotation('100.1'),
* direction: OrderDirection.STOP_ORDER_DIRECTION_BUY,
* accountId: '<ACCOUNT_ID>',
* orderType: OrderType.ORDER_TYPE_MARKET,
* orderId: '',
* instrumentId: '6afa6f80-03a7-4d83-9cf0-c19d7d021f76'
* })
*
* console.log(postOrder)
* ```
* @see https://tinkoff.github.io/investAPI/orders/#postorder
*/
public PostOrder(body: PostOrderRequest): Promise<PostOrderResponse> {
return this.request('OrdersService', 'PostOrder', body)
}
/**
* Метод отмены биржевой заявки
* ```js
* import { OrdersService, OrderDirection, OrderType } from '@tomasevich/tinkoff'
*
* const ordersService = new OrdersService('TOKEN', false)
* const postOrder = await ordersService.CancelOrder({
* accountId: '<ACCOUNT_ID>',
* orderId: '<ORDER_ID>'
* })
*
* console.log(postOrder)
* ```
* @see https://tinkoff.github.io/investAPI/orders/#cancelorder
*/
public CancelOrder(body: CancelOrderRequest): Promise<CancelOrderResponse> {
return this.request('OrdersService', 'CancelOrder', body)
}
/**
* Метод получения статуса торгового поручения
* ```js
* import { OrdersService } from '@tomasevich/tinkoff'
*
* const ordersService = new OrdersService('TOKEN', false)
* const orderState = await ordersService.GetOrderState({
* accountId: '<ACCOUNT_ID>',
* orderId: '<ORDER_ID>'
* })
*
* console.log(orderState)
* ```
* @see https://tinkoff.github.io/investAPI/orders/#getorderstate
*/
public GetOrderState(body: GetOrderStateRequest): Promise<OrderState> {
return this.request('OrdersService', 'GetOrderState', body)
}
/**
* Метод получения списка активных заявок по счёту
* ```js
* import { OrdersService } from '@tomasevich/tinkoff'
*
* const ordersService = new OrdersService('TOKEN', false)
* const { orders } = await ordersService.GetOrders({
* accountId: '<ACCOUNT_ID>'
* })
*
* console.log(orders)
* ```
* @see https://tinkoff.github.io/investAPI/orders/#getorders
*/
public GetOrders(body: GetOrdersRequest): Promise<GetOrdersResponse> {
return this.request('OrdersService', 'GetOrders', body)
}
/**
* Метод изменения выставленной заявки
* ```js
* import { OrdersService, PriceType } from '@tomasevich/tinkoff'
*
* const ordersService = new OrdersService('TOKEN', false)
* const replaceOrder = await ordersService.ReplaceOrder({
* quantity: "1",
* price: OrdersService.Quotation('100.1'),
* priceType: PriceType.PRICE_TYPE_CURRENCY,
* accountId: '<ACCOUNT_ID>',
* orderId: '<ORDER_ID>',
* idempotencyKey: ''
* })
*
* console.log(replaceOrder)
* ```
* @see https://tinkoff.github.io/investAPI/orders/#replaceorder
*/
public ReplaceOrder(body: ReplaceOrderRequest): Promise<PostOrderResponse> {
return this.request('OrdersService', 'ReplaceOrder', body)
}
}
|