-
Notifications
You must be signed in to change notification settings - Fork 90
/
Copy path3commas_openapidoc.yml
5037 lines (5031 loc) · 148 KB
/
3commas_openapidoc.yml
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: 3commas.io
description: Public API
contact:
url: https://github.com/3commas-io/3commas-official-api-docs
version: 1.0.0
servers:
- url: https://api.3commas.io/public/api
tags:
- name: bots
description: Operations about bots
- name: deals
description: Operations about deals
- name: users
description: Operations about users
- name: accounts
description: Operations about accounts
- name: marketplace
description: Operations about marketplaces
- name: grid_bots
description: Operations about grid_bots
- name: loose_accounts
description: Operations about loose_accounts
- name: ping
description: Operations about pings
- name: time
description: Operations about times
- name: smart_trades_v2
description: Operations about smart_trades_v2s
paths:
/ver1/bots/account_trade_info_smart_sell:
get:
description: account_trade_info_smart_sell
tags:
- bots
operationId: getVer1BotsAccountTradeInfoSmartSell
parameters:
- name: account_id
in: query
required: true
schema:
type: integer
format: int32
responses:
'200':
description: get AccountTradeInfoSmartSell(s)
content: {}
/ver1/bots/account_trade_info:
get:
description: account_trade_info
tags:
- bots
operationId: getVer1BotsAccountTradeInfo
parameters:
- name: account_id
in: query
required: true
schema:
type: integer
format: int32
responses:
'200':
description: get AccountTradeInfo(s)
content: {}
/ver1/bots/strategy_list:
get:
tags:
- bots
description: 'Available strategy list for bot (Permission: BOTS_READ, Security: SIGNED)'
operationId: getVer1BotsStrategyList
parameters:
- name: account_id
in: query
description: id from GET /ver1/accounts
schema:
type: integer
format: int32
- name: type
in: query
schema:
type: string
enum:
- simple
- composite
- name: strategy
in: query
schema:
type: string
enum:
- long
- short
responses:
'200':
description: 'Available strategy list for bot (Permission: BOTS_READ, Security: SIGNED)'
content: {}
/ver1/bots/pairs_black_list:
get:
tags:
- bots
description: 'Black List for bot pairs (Permission: BOTS_READ, Security: SIGNED)'
operationId: getVer1BotsPairsBlackList
responses:
'200':
description: 'Black List for bot pairs (Permission: BOTS_READ, Security: SIGNED)'
content: {}
/ver1/bots/update_pairs_black_list:
post:
tags:
- bots
description:
'Create or Update pairs BlackList for bots (Permission: BOTS_WRITE,
Security: SIGNED)'
operationId: postVer1BotsUpdatePairsBlackList
requestBody:
content:
application/json:
schema:
required:
- pairs
properties:
pairs:
type: array
items:
type: string
required: true
responses:
'201':
description:
'Create or Update pairs BlackList for bots (Permission: BOTS_WRITE,
Security: SIGNED)'
content: {}
/ver1/bots/create_bot:
post:
tags:
- bots
description: 'Create bot (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1BotsCreateBot
requestBody:
content:
application/json:
schema:
required:
- account_id
- active_safety_orders_count
- base_order_volume
- martingale_step_coefficient
- martingale_volume_coefficient
- max_safety_orders
- name
- pairs
- safety_order_step_percentage
- safety_order_volume
- strategy_list
- take_profit
- take_profit_type
properties:
name:
type: string
account_id:
type: integer
description: id from GET /ver1/accounts
format: int32
pairs:
type: array
description:
Pass single pair to create SingleBot or any other number
of pairs to create MultiBot
items:
type: string
max_active_deals:
type: integer
format: int32
default: 1
base_order_volume:
type: number
description: Base order size
format: double
base_order_volume_type:
$ref: '#/components/schemas/OrderVolumeEnum'
take_profit:
type: number
description: Target profit(percentage)
format: double
safety_order_volume:
type: number
description: Safety trade size
format: double
safety_order_volume_type:
$ref: '#/components/schemas/OrderVolumeEnum'
martingale_volume_coefficient:
type: number
format: double
default: 1.0
martingale_step_coefficient:
type: number
format: double
default: 1.0
max_safety_orders:
type: integer
description: Max safety trades count
format: int32
active_safety_orders_count:
type: integer
description: Max active safety trades count
format: int32
stop_loss_percentage:
type: number
format: double
cooldown:
type: number
format: double
trailing_enabled:
type: boolean
description: Enable trailing take profit. Binance only.
trailing_deviation:
type: number
description: required if trailing_enabled
format: double
btc_price_limit:
type: number
format: double
strategy:
type: string
default: long
enum:
- short
- long
safety_order_step_percentage:
type: number
description: Price deviation to open safety trades(percentage)
format: double
take_profit_type:
type: string
description: 'Percentage: base – from base order, total – from total volume'
default: base
enum:
- base
- total
strategy_list:
type: array
description:
"For manual signals: [{\"strategy\":\"manual\"}] or\
\ []<br>\n \
\ For non-stop(1 pair only): [{\"strategy\":\"nonstop\"}]<br>\n\
\ QFL:\
\ {\"options\": {\"type\": \"original\"}, {\"percent\": 3}, \"\
strategy\": \"qfl\"}] <br>\n \
\ TradingView: [{\"options\": {\"time\"\
: \"5m\", \"type\": \"buy_or_strong_buy\"}, \"strategy\": \"trading_view\"\
} "
leverage_type:
$ref: '#/components/schemas/LeverageTypeBitmex'
leverage_custom_value:
type: number
description: required if leverage_type is isolated
format: double
min_price:
type: number
description: minimum price to open deal
format: double
max_price:
type: number
description: maximum price to open deal
format: double
stop_loss_timeout_enabled:
type: boolean
stop_loss_timeout_in_seconds:
type: integer
description: StopLoss timeout in seconds if StopLoss timeout enabled
format: int32
min_volume_btc_24h:
type: number
format: double
tsl_enabled:
type: boolean
description: Enable trailing stop loss. Bitmex only.
deal_start_delay_seconds:
type: integer
description: Deal start delay in seconds
format: int32
profit_currency:
$ref: '#/components/schemas/ProfitCurrencyEnum'
start_order_type:
$ref: '#/components/schemas/OrderType'
stop_loss_type:
$ref: '#/components/schemas/StopLossType'
disable_after_deals_count:
type: integer
description: Bot will be disabled after opening this number of deals
format: int32
allowed_deals_on_same_pair:
type: integer
description: Allow specific number of deals on the same pair. Multibot only.
format: int32
close_deals_timeout:
type: integer
description: Close bot deals after given number of seconds. Must be greater than 60.
format: int32
required: true
responses:
'201':
description: 'Create bot (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/bots:
get:
tags:
- bots
description: 'User bots (Permission: BOTS_READ, Security: SIGNED)'
operationId: getVer1Bots
parameters:
- name: limit
in: query
description: 'Limit records. Max: 100'
schema:
type: integer
format: int32
default: 50
- name: offset
in: query
description: Offset records
schema:
type: integer
format: int32
- name: from
in: query
description: Param for a filter by created date
schema:
type: string
- name: account_id
in: query
description:
Account to show bots on. Return all if not specified. Gather
this from GET /ver1/accounts
schema:
type: integer
format: int32
- name: scope
in: query
schema:
type: string
enum:
- enabled
- disabled
- name: strategy
in: query
schema:
type: string
enum:
- long
- short
- name: sort_by
in: query
schema:
type: string
default: created_at
enum:
- profit
- created_at
- updated_at
- name: sort_direction
in: query
schema:
type: string
default: desc
enum:
- asc
- desc
- name: quote
in: query
description: Quote currency
schema:
type: string
responses:
'200':
description: 'User bots (Permission: BOTS_READ, Security: SIGNED)'
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/BotEntity'
/ver1/bots/stats:
get:
tags:
- bots
description: 'Get bot stats (Permission: BOTS_READ, Security: SIGNED)'
operationId: getVer1BotsStats
parameters:
- name: account_id
in: query
description:
Account to show on. Null - show for all. Gather this from GET
/ver1/accounts
schema:
type: integer
format: int32
- name: bot_id
in: query
description: Bots to show on. Null - show for all
schema:
type: integer
format: int32
responses:
'200':
description: 'Get bot stats (Permission: BOTS_READ, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/copy_and_create:
post:
tags:
- bots
description:
'POST /bots/:id/copy_and_create. Permission: BOTS_WRITE, Security:
SIGNED'
operationId: postVer1BotsBotIdCopyAndCreate
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
required:
- name
- secret
properties:
name:
type: string
secret:
type: string
amount:
type: number
description: Max amount for bot usage (Based on current rate)
format: double
required: true
responses:
'201':
description:
'POST /bots/:id/copy_and_create. Permission: BOTS_WRITE, Security:
SIGNED'
content: {}
/ver1/bots/{bot_id}/update:
patch:
tags:
- bots
description: 'Edit bot (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: patchVer1BotsBotIdUpdate
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
required:
- active_safety_orders_count
- base_order_volume
- martingale_step_coefficient
- martingale_volume_coefficient
- max_safety_orders
- name
- pairs
- safety_order_step_percentage
- safety_order_volume
- strategy_list
- take_profit
- take_profit_type
properties:
name:
type: string
pairs:
type: array
items:
type: string
max_active_deals:
type: integer
format: int32
default: 1
base_order_volume:
type: number
description: Base order size
format: double
base_order_volume_type:
$ref: '#/components/schemas/OrderVolumeEnum'
take_profit:
type: number
description: Target profit(percentage)
format: double
safety_order_volume:
type: number
description: Safety trade size
format: double
safety_order_volume_type:
$ref: '#/components/schemas/OrderVolumeEnum'
martingale_volume_coefficient:
type: number
format: double
default: 1.0
martingale_step_coefficient:
type: number
format: double
default: 1.0
max_safety_orders:
type: integer
description: Max safety trades count
format: int32
active_safety_orders_count:
type: integer
description: Max active safety trades count
format: int32
stop_loss_percentage:
type: number
format: double
cooldown:
type: number
format: double
trailing_enabled:
type: boolean
description: Enable trailing take profit. Binance only.
trailing_deviation:
type: number
description: required if trailing_enabled
format: double
btc_price_limit:
type: number
format: double
safety_order_step_percentage:
type: number
description: Price deviation to open safety trades(percentage)
format: double
take_profit_type:
type: string
description:
'Percentage: base – from base order, total – from total
volume'
default: total
enum:
- total
- base
strategy_list:
type: array
description:
"For manual signals: [{\"strategy\":\"manual\"}] or\
\ []<br>\n \
\ For non-stop(1 pair only): [{\"strategy\":\"nonstop\"}]<br>\n\
\ QFL:\
\ {\"options\": {\"type\": \"original\"}, {\"percent\": 3}, \"\
strategy\": \"qfl\"}] <br>\n \
\ TradingView: [{\"options\": {\"time\"\
: \"5m\", \"type\": \"buy_or_strong_buy\", \"strategy\": \"trading_view\"\
} "
leverage_type:
$ref: '#/components/schemas/LeverageTypeBitmex'
leverage_custom_value:
type: number
description: required if leverage_type is isolated
format: double
min_price:
type: number
description: minimum price to open deal
format: double
max_price:
type: number
description: maximum price to open deal
format: double
stop_loss_timeout_enabled:
type: boolean
stop_loss_timeout_in_seconds:
type: integer
description: StopLoss timeout in seconds if StopLoss timeout enabled
format: int32
min_volume_btc_24h:
type: number
format: double
tsl_enabled:
type: boolean
description: Enable trailing stop loss. Bitmex only.
deal_start_delay_seconds:
type: integer
description: Deal start delay in seconds
format: int32
profit_currency:
$ref: '#/components/schemas/ProfitCurrencyEnum'
start_order_type:
$ref: '#/components/schemas/OrderType'
stop_loss_type:
$ref: '#/components/schemas/StopLossType'
disable_after_deals_count:
type: integer
description: Bot will be disabled after opening this number of deals
format: int32
allowed_deals_on_same_pair:
type: integer
description:
Allow specific number of deals on the same pair. Multibot
only.
format: int32
close_deals_timeout:
type: integer
description:
Close bot deals after given number of seconds. Must
be greater than 60.
format: int32
required: true
responses:
'200':
description: 'Edit bot (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/disable:
post:
tags:
- bots
description: 'Disable bot (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1BotsBotIdDisable
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'201':
description: 'Disable bot (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/enable:
post:
tags:
- bots
description: 'Enable bot (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1BotsBotIdEnable
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'201':
description: 'Enable bot (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/start_new_deal:
post:
tags:
- bots
description: 'Start new deal asap (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1BotsBotIdStartNewDeal
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
pair:
type: string
description: Can be omited for simple bot
skip_signal_checks:
type: boolean
description:
If false or not specified then all paramaters like
signals or volume filters will be checked. If true - those checks
will be skipped
skip_open_deals_checks:
type: boolean
description:
If true then you will be allowed to open more then
one deal per pair in composite bot
responses:
'201':
description: 'Start new deal asap (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/delete:
post:
tags:
- bots
description: 'Delete bot (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1BotsBotIdDelete
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'201':
description: 'Delete bot (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/panic_sell_all_deals:
post:
tags:
- bots
description: 'Panic sell all bot deals (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1BotsBotIdPanicSellAllDeals
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'201':
description: 'Panic sell all bot deals (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/cancel_all_deals:
post:
tags:
- bots
description: 'Cancel all bot deals (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1BotsBotIdCancelAllDeals
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'201':
description: 'Cancel all bot deals (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/deals_stats:
get:
tags:
- bots
description: 'Bot deals stats (Permission: BOTS_READ, Security: SIGNED)'
operationId: getVer1BotsBotIdDealsStats
parameters:
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'200':
description: 'Bot deals stats (Permission: BOTS_READ, Security: SIGNED)'
content: {}
/ver1/bots/{bot_id}/show:
get:
tags:
- bots
description: 'Bot info (Permission: BOTS_READ, Security: SIGNED)'
operationId: getVer1BotsBotIdShow
parameters:
- name: include_events
in: query
schema:
type: boolean
- name: bot_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'200':
description: 'Bot info (Permission: BOTS_READ, Security: SIGNED)'
content: {}
/ver1/deals:
get:
tags:
- deals
description: 'User deals (Permission: BOTS_READ, Security: SIGNED)'
operationId: getVer1Deals
parameters:
- name: limit
in: query
description: 'Limit records. Max: 1_000'
schema:
type: integer
format: int32
default: 50
- name: offset
in: query
description: Offset records
schema:
type: integer
format: int32
- name: from
in: query
description: Param for a filter by created date
schema:
type: string
- name: account_id
in: query
description:
Account to show bots on. Return all if not specified. Gather
this from GET /ver1/accounts
schema:
type: integer
format: int32
- name: bot_id
in: query
description: Bot show deals on. Return all if not specified
schema:
type: integer
format: int32
- name: scope
in: query
description:
active - active deals, finished - finished deals, completed -
successfully completed, cancelled - cancelled deals, failed - failed deals,
any other value or null (default) - all deals
schema:
type: string
- name: order
in: query
schema:
type: string
default: created_at
enum:
- created_at
- updated_at
- closed_at
- profit
- profit_percentage
- name: order_direction
in: query
schema:
type: string
default: desc
enum:
- asc
- desc
- name: base
in: query
description: Base currency
schema:
type: string
- name: quote
in: query
description: Quote currency
schema:
type: string
responses:
'200':
description: 'User deals (Permission: BOTS_READ, Security: SIGNED)'
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/DealEntity'
/ver1/deals/{deal_id}/convert_to_smart_trade:
post:
tags:
- deals
description: 'Convert to smart trade (Permission: SMART_TRADE_WRITE, Security: SIGNED)'
operationId: postVer1DealsDealIdConvertToSmartTrade
parameters:
- name: deal_id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
stop_bot:
type: boolean
responses:
'201':
description: 'Convert to smart trade (Permission: SMART_TRADE_WRITE, Security: SIGNED)'
content: {}
/ver1/deals/{deal_id}/update_max_safety_orders:
post:
tags:
- deals
description: 'Update max safety orders (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1DealsDealIdUpdateMaxSafetyOrders
parameters:
- name: deal_id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
required:
- max_safety_orders
properties:
max_safety_orders:
type: integer
description: New maximum safety orders value
format: int32
required: true
responses:
'201':
description: 'Update max safety orders (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/deals/{deal_id}/panic_sell:
post:
tags:
- deals
description: 'Panic sell deal (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1DealsDealIdPanicSell
parameters:
- name: deal_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'201':
description: 'Panic sell deal (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/deals/{deal_id}/cancel:
post:
tags:
- deals
description: 'Cancel deal (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: postVer1DealsDealIdCancel
parameters:
- name: deal_id
in: path
required: true
schema:
type: integer
format: int32
responses:
'201':
description: 'Cancel deal (Permission: BOTS_WRITE, Security: SIGNED)'
content: {}
/ver1/deals/{deal_id}/update_deal:
patch:
tags:
- deals
description: 'Update deal (Permission: BOTS_WRITE, Security: SIGNED)'
operationId: patchVer1DealsDealIdUpdateDeal
parameters:
- name: deal_id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
take_profit:
type: number
description: New take profit value
format: double
profit_currency:
$ref: '#/components/schemas/ProfitCurrencyEnum'
take_profit_type:
type: string
description: base – from base order, total – from total volume
trailing_enabled:
type: boolean
trailing_deviation:
type: number
description: New trailing deviation value
format: double
stop_loss_percentage:
type: number
description: New stop loss percentage value
format: double
max_safety_orders:
type: integer
description: New max safety orders value
format: int32
active_safety_orders_count:
type: integer
description: New active safety orders count value
format: int32
stop_loss_timeout_enabled:
type: boolean
stop_loss_timeout_in_seconds:
type: integer
description: StopLoss timeout in seconds if StopLoss timeout enabled
format: int32
tsl_enabled:
type: boolean