-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexchange.yaml
More file actions
3023 lines (2911 loc) · 97.1 KB
/
exchange.yaml
File metadata and controls
3023 lines (2911 loc) · 97.1 KB
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.1.0"
info:
title: Upbit Exchange API
description: |
업비트 거래 및 자산 관리(Exchange) API 명세.
인증이 필요한 API입니다 (JWT Bearer).
## 공통 사항
- TLS 1.2 이상 필요 (1.3 권장)
- Content-Type: application/json; charset=utf-8
- POST 요청은 반드시 JSON 형식으로 본문(Body)을 전송해야 합니다 (Form 방식 지원 종료, 2022-03)
- 모든 Rate Limit은 계정 단위로 측정됩니다
- 응답 헤더 Remaining-Req로 잔여 요청 횟수를 확인할 수 있습니다
(형식: "group=default; min=1800; sec=29")
- 모든 금액/수량 값은 정밀도를 위해 문자열(string)로 반환됩니다
version: "1.6.1"
contact:
name: Upbit Open API
url: https://docs.upbit.com
servers:
- url: https://api.upbit.com
description: Upbit Production
security:
- jwt: []
tags:
- name: accounts
description: 계정 잔고 조회
- name: orders
description: 주문 생성/조회/취소
- name: deposits
description: 입금 조회/요청
- name: withdrawals
description: 출금 조회/요청
- name: travel_rule
description: 트래블룰 검증
- name: service
description: 서비스 상태 및 API Key 관리
# ─────────────────────────── paths ───────────────────────────
paths:
# ── Accounts ──
/v1/accounts:
get:
operationId: listAccounts
summary: 계정 잔고 조회
description: 계정이 보유하고 있는 자산 목록과 잔고를 조회합니다.
tags: [accounts]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
responses:
"200":
description: 자산 목록
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Account"
"401":
$ref: "#/components/responses/Unauthorized"
# ── Orders ──
/v1/orders:
post:
operationId: createOrder
summary: 주문 생성
description: |
특정 페어를 매수/매도하기 위한 주문을 생성합니다.
주문 유형(ord_type):
- `limit`: 지정가 주문
- `price`: 시장가 매수 주문
- `market`: 시장가 매도 주문
- `best`: 최유리 지정가 주문
주문 체결 조건(time_in_force):
- `ioc`: IOC (Immediate or Cancel)
- `fok`: FOK (Fill or Kill)
- `post_only`: Post Only (지정가 주문에서만 사용 가능)
tags: [orders]
x-rate-limit:
group: order
max_per_sec: 8
unit: account
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderRequest"
responses:
"201":
description: 생성된 주문 정보
content:
application/json:
schema:
$ref: "#/components/schemas/OrderCreated"
"400":
$ref: "#/components/responses/BadRequest"
"403":
$ref: "#/components/responses/Forbidden"
/v1/orders/test:
post:
operationId: createOrderTest
summary: 주문 생성 테스트
description: |
실제 주문을 생성하지 않고 주문 요청 형식과 주문 가능 여부를 검증합니다.
실제 주문 API를 호출하기 전 이 API를 통해 거래 수수료 없이 주문 생성 가능 여부를 테스트하고,
발생 가능한 오류를 사전에 확인할 수 있습니다.
테스트 주문은 실제 주문과 동일한 검증 과정을 거치지만, 주문이 실제로 생성되지는 않습니다.
따라서 응답으로 반환된 UUID(혹은 identifier)는 주문 조회나 취소 요청에 사용할 수 없습니다.
tags: [orders]
x-rate-limit:
group: order_test
max_per_sec: 8
unit: account
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderRequest"
responses:
"201":
description: 테스트 주문 결과
content:
application/json:
schema:
$ref: "#/components/schemas/OrderCreated"
"400":
$ref: "#/components/responses/BadRequest"
"403":
$ref: "#/components/responses/Forbidden"
/v1/order:
get:
operationId: getOrder
summary: 개별 주문 조회
description: |
주문의 UUID 또는 Identifier로 단일 주문 정보를 조회합니다.
uuid 또는 identifier 중 하나는 반드시 포함해야 합니다.
uuid와 identifier를 모두 사용하는 경우, uuid를 기준으로 조회됩니다.
tags: [orders]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: uuid
in: query
required: false
description: 조회하고자 하는 주문의 유일식별자(UUID)
schema:
type: string
- name: identifier
in: query
required: false
description: 조회하고자 하는 주문의 클라이언트 지정 식별자
schema:
type: string
responses:
"200":
description: 주문 상세 정보
content:
application/json:
schema:
$ref: "#/components/schemas/OrderDetail"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
delete:
operationId: cancelOrder
summary: 개별 주문 취소 접수
description: |
UUID 또는 Identifier로 주문을 취소합니다.
uuid 또는 identifier 중 하나는 반드시 포함해야 합니다.
uuid와 identifier를 모두 사용하는 경우, uuid를 기준으로 취소됩니다.
tags: [orders]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: uuid
in: query
required: false
description: 취소하고자 하는 주문의 유일식별자(UUID)
schema:
type: string
- name: identifier
in: query
required: false
description: 취소하고자 하는 주문의 클라이언트 지정 식별자
schema:
type: string
responses:
"200":
description: 취소 접수된 주문 정보
content:
application/json:
schema:
$ref: "#/components/schemas/OrderCanceled"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
/v1/orders/open:
get:
operationId: listOpenOrders
summary: 체결 대기 주문 목록 조회
description: |
체결 대기 중인 주문(Open Orders) 목록을 조회합니다.
state와 states[]는 동시에 사용할 수 없습니다.
tags: [orders]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: market
in: query
required: false
description: 조회하고자 하는 페어(거래쌍)
schema:
type: string
example: "KRW-BTC"
- name: state
in: query
required: false
description: "주문의 상태. `wait`(체결 대기), `watch`(예약 주문 대기)"
schema:
type: string
enum: [wait, watch]
default: wait
- name: states[]
in: query
required: false
description: "주문의 상태 (배열). `wait`, `watch`"
style: form
explode: true
schema:
type: array
items:
type: string
enum: [wait, watch]
- name: page
in: query
required: false
description: 조회할 페이지 번호
schema:
type: integer
default: 1
- name: limit
in: query
required: false
description: "요청 개수 (default: 100, max: 100)"
schema:
type: integer
default: 100
maximum: 100
- $ref: "#/components/parameters/OrderByParam"
responses:
"200":
description: 체결 대기 주문 목록
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OrderOpen"
"400":
$ref: "#/components/responses/BadRequest"
delete:
operationId: batchCancelOrders
summary: 주문 일괄 취소 접수
description: |
조건을 지정하여 해당 조건을 만족하는 최대 300개의 주문을 일괄 취소합니다.
일괄 취소 API로는 오직 체결 대기(WAIT) 상태의 주문만 취소할 수 있습니다.
예약 주문(WATCH) 상태의 주문은 개별 주문 취소 접수 또는 id로 주문 목록 취소 접수 API를 사용해주세요.
이 API는 쿼리 파라미터 형식만 지원합니다.
페어(pairs)과 마켓(quote_currencies) 조건은 동시에 사용할 수 없습니다.
tags: [orders]
x-rate-limit:
group: batch_cancel
max_per_sec: 0.5
unit: account
parameters:
- name: quote_currencies
in: query
required: false
description: "주문 취소 대상 마켓 목록. KRW, BTC, USDT 등"
schema:
type: string
example: "KRW"
- name: cancel_side
in: query
required: false
description: "취소하고자 하는 주문의 매수/매도 방향. `all`(전체), `ask`(매도), `bid`(매수)"
schema:
type: string
enum: [all, ask, bid]
default: all
- name: count
in: query
required: false
description: "취소할 주문의 최대 개수. 최대값 300, 기본값 20"
schema:
type: integer
default: 20
maximum: 300
- name: order_by
in: query
required: false
description: "취소할 주문의 정렬 방식. `asc`(오름차순), `desc`(내림차순, 기본값)"
schema:
type: string
enum: [asc, desc]
default: desc
- name: pairs
in: query
required: false
description: "페어(거래쌍) 목록. 최대 20개, 쉼표 구분"
schema:
type: string
example: "KRW-BTC,KRW-ETH"
- name: exclude_pairs
in: query
required: false
description: "취소 제외 페어 목록. 최대 20개, 쉼표 구분"
schema:
type: string
example: "KRW-BTC,KRW-ETH"
responses:
"200":
description: 일괄 취소 결과
content:
application/json:
schema:
$ref: "#/components/schemas/CancelResult"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
/v1/orders/closed:
get:
operationId: listClosedOrders
summary: 종료 주문 목록 조회
description: |
종료 주문(Closed Order) 목록을 조회합니다.
종료 주문은 전량 체결 주문과 취소 주문을 포함합니다.
조회 기간을 정하는 경우 최대 7일 구간(window)을 조회할 수 있습니다.
state와 states[]는 동시에 사용할 수 없습니다.
tags: [orders]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: market
in: query
required: false
description: 조회하고자 하는 페어(거래쌍)
schema:
type: string
example: "KRW-BTC"
- name: state
in: query
required: false
description: "주문의 상태. `done,cancel`(전체), `done`(체결 완료만), `cancel`(취소만)"
schema:
type: string
default: "done,cancel"
- name: states[]
in: query
required: false
description: "주문의 상태 (배열). `done`, `cancel`"
style: form
explode: true
schema:
type: array
items:
type: string
enum: [done, cancel]
- name: start_time
in: query
required: false
description: "조회 기간의 시작 시각. ISO 8601 형식 또는 밀리초 타임스탬프. 최대 7일 구간"
schema:
type: string
- name: end_time
in: query
required: false
description: "조회 기간의 종료 시각. ISO 8601 형식 또는 밀리초 타임스탬프. 최대 7일 구간"
schema:
type: string
- name: limit
in: query
required: false
description: "요청 개수 (default: 100, max: 1,000)"
schema:
type: integer
default: 100
maximum: 1000
- $ref: "#/components/parameters/OrderByParam"
responses:
"200":
description: 종료 주문 목록
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OrderClosed"
"400":
$ref: "#/components/responses/BadRequest"
/v1/orders/uuids:
get:
operationId: listOrdersByIds
summary: id로 주문 목록 조회
description: |
UUID 또는 Identifier 목록으로 주문을 조회합니다.
uuid[] 또는 identifier[]를 반드시 포함해야 합니다.
두 파라미터를 동시에 사용할 수 없습니다.
tags: [orders]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: market
in: query
required: false
description: 조회하고자 하는 페어(거래쌍)
schema:
type: string
example: "KRW-BTC"
- name: uuids[]
in: query
required: false
description: "조회하고자 하는 주문의 UUID 목록. 최대 100개"
style: form
explode: true
schema:
type: array
items:
type: string
- name: identifiers[]
in: query
required: false
description: "조회하고자 하는 주문의 클라이언트 지정 식별자 목록. 최대 100개"
style: form
explode: true
schema:
type: array
items:
type: string
- $ref: "#/components/parameters/OrderByParam"
responses:
"200":
description: 주문 목록
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OrderByIds"
"400":
$ref: "#/components/responses/BadRequest"
delete:
operationId: cancelOrdersByIds
summary: id로 주문 목록 취소 접수
description: |
UUID 또는 Identifier 목록으로 취소 대상 주문을 지정 취소합니다.
한 번의 요청으로 최대 20개의 주문을 취소할 수 있습니다.
이 API는 쿼리 파라미터 형식만 지원합니다.
uuid[] 또는 identifier[]를 반드시 포함해야 합니다.
두 파라미터를 동시에 사용할 수 없습니다.
tags: [orders]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: uuids[]
in: query
required: false
description: "취소하고자 하는 주문의 UUID 목록. 최대 20개"
style: form
explode: true
schema:
type: array
items:
type: string
- name: identifiers[]
in: query
required: false
description: "취소하고자 하는 주문의 클라이언트 지정 식별자 목록. 최대 20개"
style: form
explode: true
schema:
type: array
items:
type: string
responses:
"200":
description: 취소 결과
content:
application/json:
schema:
$ref: "#/components/schemas/CancelResult"
"400":
$ref: "#/components/responses/BadRequest"
/v1/orders/cancel_and_new:
post:
operationId: cancelAndNewOrder
summary: 취소 후 재주문
description: |
한 번의 요청으로 기존 주문을 취소하고 신규 주문을 생성합니다.
신규 주문은 기존 주문과 동일한 페어, 동일한 주문 방향에 대해서만 생성 가능합니다.
기존 주문의 취소가 완료된 이후 신규 주문이 생성됩니다.
prev_order_uuid 또는 prev_order_identifier를 반드시 포함해야 합니다.
tags: [orders]
x-rate-limit:
group: order
max_per_sec: 8
unit: account
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CancelAndNewOrderRequest"
responses:
"201":
description: 취소 및 재주문 결과
content:
application/json:
schema:
$ref: "#/components/schemas/CancelAndNewOrderResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
description: 서버 내부 오류
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v1/orders/chance:
get:
operationId: getOrderChance
summary: 페어별 주문 가능 정보 조회
description: |
지정한 페어의 주문 가능 정보를 조회합니다.
적용 수수료율, 지원 주문 방향 및 유형, 기준/호가 자산의 통화 및
최소/최대 주문 가능 금액, 계정 잔고 등을 확인할 수 있습니다.
tags: [orders]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: market
in: query
required: true
description: 조회하고자 하는 페어(거래쌍)
schema:
type: string
example: "KRW-BTC"
responses:
"200":
description: 주문 가능 정보
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/OrderChance"
"400":
$ref: "#/components/responses/BadRequest"
# ── Deposits ──
/v1/deposit:
get:
operationId: getDeposit
summary: 개별 입금 조회
description: |
최신 입금 이력을 조회합니다.
특정 입금 정보를 조회하고자 하는 경우 입금의 UUID 또는 트랜잭션 ID(TXID), 통화 코드로 지정할 수 있습니다.
tags: [deposits]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: currency
in: query
required: false
description: 조회하고자 하는 통화 코드
schema:
type: string
- name: uuid
in: query
required: false
description: "조회하고자 하는 입금의 유일식별자(UUID). uuid와 txid를 모두 입력하지 않는 경우 최신 입금 정보가 반환됩니다."
schema:
type: string
- name: txid
in: query
required: false
description: "조회하고자 하는 입금의 트랜잭션 ID. uuid와 txid를 모두 입력하지 않는 경우 최신 입금 정보가 반환됩니다."
schema:
type: string
responses:
"200":
description: 입금 정보
content:
application/json:
schema:
$ref: "#/components/schemas/Deposit"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
$ref: "#/components/responses/NotFound"
/v1/deposits:
get:
operationId: listDeposits
summary: 입금 목록 조회
description: |
최신 입금 목록을 조회합니다.
조회 조건을 설정하여 해당 조건을 만족하는 입금 목록만 조회할 수 있습니다.
통화, 입금 진행 상태, UUID 목록 또는 TXID 목록을 필터 파라미터로 사용할 수 있습니다.
조건을 별도로 지정하지 않는 경우 최근 100개 입금 이력이 반환됩니다.
tags: [deposits]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: currency
in: query
required: false
description: 조회하고자 하는 통화 코드
schema:
type: string
- name: state
in: query
required: false
description: "입금 처리 상태. `PROCESSING`, `ACCEPTED`, `CANCELLED`, `REJECTED`, `TRAVEL_RULE_SUSPECTED`, `REFUNDING`, `REFUNDED`"
schema:
type: string
enum: [PROCESSING, ACCEPTED, CANCELLED, REJECTED, TRAVEL_RULE_SUSPECTED, REFUNDING, REFUNDED]
- name: uuids[]
in: query
required: false
description: "조회하고자 하는 유일식별자(UUID) 목록"
style: form
explode: true
schema:
type: array
items:
type: string
- name: txids[]
in: query
required: false
description: "조회하고자 하는 트랜잭션 ID 목록"
style: form
explode: true
schema:
type: array
items:
type: string
- name: limit
in: query
required: false
description: "요청 개수 (default: 100, max: 100)"
schema:
type: integer
default: 100
maximum: 100
- name: page
in: query
required: false
description: 조회할 페이지 번호
schema:
type: integer
default: 1
- $ref: "#/components/parameters/OrderByParam"
- name: from
in: query
required: false
description: "Pagination을 위한 조회 범위 지정용 커서. 응답에 포함된 uuid 값을 입력하여 해당 입금 시각 이후 limit개의 이력을 이어서 조회할 수 있습니다."
schema:
type: string
- name: to
in: query
required: false
description: "Pagination을 위한 조회 범위 지정용 커서. 응답에 포함된 uuid 값을 입력하여 해당 입금 시각 이전 limit개의 이력을 조회할 수 있습니다."
schema:
type: string
responses:
"200":
description: 입금 목록
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Deposit"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
/v1/deposits/generate_coin_address:
post:
operationId: createDepositAddress
summary: 입금 주소 생성 요청
description: |
개인 지갑 또는 타 거래소 자산을 업비트로 입금하기 위한 입금 주소 생성을 요청합니다.
입금 주소 생성은 비동기 방식으로 동작합니다.
- 최초 요청 직후: 주소 생성 요청의 접수 성공 여부를 반환 (201)
- 생성 완료 후 재요청: 생성된 주소 정보 반환 (200)
tags: [deposits]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [currency, net_type]
properties:
currency:
type: string
description: 입금 주소가 생성된 통화 코드
net_type:
type: string
description: 네트워크 유형
responses:
"200":
description: 생성된 입금 주소 정보
content:
application/json:
schema:
$ref: "#/components/schemas/DepositAddress"
"201":
description: 입금 주소 생성 요청 접수 완료
content:
application/json:
schema:
type: object
required: [success, message]
properties:
success:
type: boolean
description: 입금 주소 생성 요청의 성공 여부
message:
type: string
description: 입금 주소 생성 요청 결과에 대한 메시지
"400":
$ref: "#/components/responses/BadRequest"
/v1/deposits/coin_address:
get:
operationId: getDepositAddress
summary: 개별 입금 주소 조회
description: |
지정한 통화의 입금 주소 정보를 조회합니다.
입금 주소 생성 요청 후 주소가 생성되기 전에 이 API를 호출하는 경우,
응답의 deposit_address 필드가 null로 반환될 수 있습니다.
tags: [deposits]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: currency
in: query
required: true
description: 조회하고자 하는 통화 코드
schema:
type: string
- name: net_type
in: query
required: true
description: 디지털 자산 입출금에 사용되는 블록체인 네트워크 식별자
schema:
type: string
responses:
"200":
description: 입금 주소 정보
content:
application/json:
schema:
$ref: "#/components/schemas/DepositAddress"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
/v1/deposits/coin_addresses:
get:
operationId: listDepositAddresses
summary: 입금 주소 목록 조회
description: 계정의 모든 입금 주소 목록을 조회합니다. 정상적으로 생성된 모든 입금 주소 목록이 반환됩니다.
tags: [deposits]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
responses:
"200":
description: 입금 주소 목록
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/DepositAddress"
/v1/deposits/krw:
post:
operationId: depositKrw
summary: 원화 입금
description: 입출금 계좌로부터 원화를 지정한 금액만큼 입금합니다.
tags: [deposits]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [amount, two_factor_type]
properties:
amount:
type: string
description: 입금하고자 하는 원화의 금액
two_factor_type:
type: string
enum: [kakao, naver, hana]
description: "원화 입출금 시 사용할 2차 인증 수단. `kakao`: 카카오 인증, `naver`: 네이버 인증, `hana`: 하나인증서 인증"
responses:
"201":
description: 원화 입금 결과
content:
application/json:
schema:
$ref: "#/components/schemas/Deposit"
"400":
$ref: "#/components/responses/BadRequest"
/v1/deposits/chance/coin:
get:
operationId: getDepositChanceCoin
summary: 디지털 자산 입금 가능 정보 조회
description: |
지정한 통화에 대한 입금 가능 정보를 조회합니다.
입금 가능 정보 조회 API는 실시간 상태 조회를 보장하지 않으며 반영은 수 분 정도 지연될 수 있습니다.
tags: [deposits]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: currency
in: query
required: true
description: 조회하고자 하는 통화 코드
schema:
type: string
- name: net_type
in: query
required: true
description: 디지털 자산 입출금에 사용되는 블록체인 네트워크 식별자
schema:
type: string
responses:
"200":
description: 입금 가능 정보
content:
application/json:
schema:
$ref: "#/components/schemas/DepositChanceCoin"
"400":
$ref: "#/components/responses/BadRequest"
# ── Withdrawals ──
/v1/withdraw:
get:
operationId: getWithdrawal
summary: 개별 출금 조회
description: |
최신 단일 출금 정보를 조회합니다.
특정 출금 정보를 조회하고자 하는 경우 출금의 UUID 또는 트랜잭션 ID(TXID)로 지정할 수 있습니다.
tags: [withdrawals]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: uuid
in: query
required: false
description: "조회하고자 하는 출금의 유일식별자(UUID). uuid와 txid를 모두 입력하지 않는 경우 최신 출금 정보가 반환됩니다."
schema:
type: string
- name: txid
in: query
required: false
description: "조회하고자 하는 출금의 트랜잭션 ID. uuid와 txid를 모두 입력하지 않는 경우 최신 출금 정보가 반환됩니다."
schema:
type: string
- name: currency
in: query
required: false
description: 조회하고자 하는 통화 코드
schema:
type: string
responses:
"200":
description: 출금 정보
content:
application/json:
schema:
$ref: "#/components/schemas/Withdrawal"
"404":
$ref: "#/components/responses/NotFound"
/v1/withdraws:
get:
operationId: listWithdrawals
summary: 출금 목록 조회
description: |
최신 출금 목록을 조회합니다.
조회 조건을 설정하여 해당 조건을 만족하는 출금 목록만 조회할 수 있습니다.
통화, 출금 진행 상태, UUID 목록 또는 TXID 목록을 필터 파라미터로 사용할 수 있습니다.
조건을 별도로 지정하지 않는 경우 최근 100개 출금 이력이 반환됩니다.
tags: [withdrawals]
x-rate-limit:
group: default
max_per_sec: 30
unit: account
parameters:
- name: currency
in: query
required: false
description: 조회하고자 하는 통화 코드
schema:
type: string
- name: state