This is page 7 of 8. Use http://codebase.md/sammcj/bybit-mcp?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .env.example
├── .gitignore
├── client
│ ├── .env.example
│ ├── .gitignore
│ ├── package.json
│ ├── pnpm-lock.yaml
│ ├── README.md
│ ├── src
│ │ ├── cli.ts
│ │ ├── client.ts
│ │ ├── config.ts
│ │ ├── env.ts
│ │ ├── index.ts
│ │ └── launch.ts
│ └── tsconfig.json
├── DEV_PLAN.md
├── docs
│ └── HTTP_SERVER.md
├── eslint.config.js
├── jest.config.js
├── LICENSE
├── package-lock.json
├── package.json
├── pnpm-lock.yaml
├── README.md
├── specs
│ ├── bybit
│ │ ├── bybit-api-v5-openapi.yaml
│ │ └── bybit-api-v5-postman-collection.json
│ ├── mcp
│ │ ├── mcp-schema.json
│ │ └── mcp-schema.ts
│ └── README.md
├── src
│ ├── __tests__
│ │ ├── GetMLRSI.test.ts
│ │ ├── integration.test.ts
│ │ ├── test-setup.ts
│ │ └── tools.test.ts
│ ├── constants.ts
│ ├── env.ts
│ ├── httpServer.ts
│ ├── index.ts
│ ├── tools
│ │ ├── BaseTool.ts
│ │ ├── GetInstrumentInfo.ts
│ │ ├── GetKline.ts
│ │ ├── GetMarketInfo.ts
│ │ ├── GetMarketStructure.ts
│ │ ├── GetMLRSI.ts
│ │ ├── GetOrderBlocks.ts
│ │ ├── GetOrderbook.ts
│ │ ├── GetOrderHistory.ts
│ │ ├── GetPositions.ts
│ │ ├── GetTicker.ts
│ │ ├── GetTrades.ts
│ │ └── GetWalletBalance.ts
│ └── utils
│ ├── knnAlgorithm.ts
│ ├── mathUtils.ts
│ ├── toolLoader.ts
│ └── volumeAnalysis.ts
├── tsconfig.json
└── webui
├── .dockerignore
├── .env.example
├── build-docker.sh
├── docker-compose.yml
├── docker-entrypoint.sh
├── docker-healthcheck.sh
├── DOCKER.md
├── Dockerfile
├── index.html
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── public
│ ├── favicon.svg
│ └── inter.woff2
├── README.md
├── screenshot.png
├── src
│ ├── assets
│ │ └── fonts
│ │ └── fonts.css
│ ├── components
│ │ ├── AgentDashboard.ts
│ │ ├── chat
│ │ │ ├── DataCard.ts
│ │ │ └── MessageRenderer.ts
│ │ ├── ChatApp.ts
│ │ ├── DataVerificationPanel.ts
│ │ ├── DebugConsole.ts
│ │ └── ToolsManager.ts
│ ├── main.ts
│ ├── services
│ │ ├── agentConfig.ts
│ │ ├── agentMemory.ts
│ │ ├── aiClient.ts
│ │ ├── citationProcessor.ts
│ │ ├── citationStore.ts
│ │ ├── configService.ts
│ │ ├── logService.ts
│ │ ├── mcpClient.ts
│ │ ├── multiStepAgent.ts
│ │ ├── performanceOptimiser.ts
│ │ └── systemPrompt.ts
│ ├── styles
│ │ ├── agent-dashboard.css
│ │ ├── base.css
│ │ ├── citations.css
│ │ ├── components.css
│ │ ├── data-cards.css
│ │ ├── main.css
│ │ ├── processing.css
│ │ ├── variables.css
│ │ └── verification-panel.css
│ ├── types
│ │ ├── agent.ts
│ │ ├── ai.ts
│ │ ├── citation.ts
│ │ ├── mcp.ts
│ │ └── workflow.ts
│ └── utils
│ ├── dataDetection.ts
│ └── formatters.ts
├── tsconfig.json
└── vite.config.ts
```
# Files
--------------------------------------------------------------------------------
/specs/bybit/bybit-api-v5-openapi.yaml:
--------------------------------------------------------------------------------
```yaml
1 | openapi: 3.0.0
2 | info:
3 | title: Open API V5 english standard
4 | version: 1.0.0
5 | servers:
6 | - url: http://{{url}}
7 | tags:
8 | - name: Market
9 | - name: Order
10 | - name: Position
11 | - name: Account
12 | - name: Pre-Uprgade
13 | - name: Asset
14 | - name: Asset > Convert
15 | - name: Asset > Balance
16 | - name: Asset > Transfer
17 | - name: Asset > Deposit
18 | - name: Asset > Withdraw
19 | - name: User
20 | - name: Spot-lever-token
21 | - name: Spot-Margin-Trade
22 | - name: Institutional Loan
23 | - name: Crypto Loan
24 | - name: Broker
25 | - name: Broker > Reward
26 | paths:
27 | /v5/market/time:
28 | get:
29 | tags:
30 | - Market
31 | summary: server-time
32 | responses:
33 | '200':
34 | description: Successful response
35 | content:
36 | application/json: {}
37 | /v5/market/kline:
38 | get:
39 | tags:
40 | - Market
41 | summary: kline
42 | parameters:
43 | - name: Content-Type
44 | in: header
45 | schema:
46 | type: string
47 | example: application/json
48 | - name: symbol
49 | in: query
50 | schema:
51 | type: string
52 | example: BTCUSDT
53 | - name: interval
54 | in: query
55 | schema:
56 | type: integer
57 | example: '5'
58 | - name: limit
59 | in: query
60 | schema:
61 | type: integer
62 | example: '1'
63 | - name: category
64 | in: query
65 | schema:
66 | type: string
67 | example: spot
68 | responses:
69 | '200':
70 | description: Successful response
71 | content:
72 | application/json: {}
73 | /v5/market/mark-price-kline:
74 | get:
75 | tags:
76 | - Market
77 | summary: mark-price-kline
78 | parameters:
79 | - name: X-BAPI-SIGN-TYPE
80 | in: header
81 | schema:
82 | type: integer
83 | example: '2'
84 | - name: X-BAPI-SIGN
85 | in: header
86 | schema:
87 | type: string
88 | example: '{{signed}}'
89 | - name: X-BAPI-API-KEY
90 | in: header
91 | schema:
92 | type: string
93 | example: '{{api_key}}'
94 | - name: X-BAPI-TIMESTAMP
95 | in: header
96 | schema:
97 | type: string
98 | example: '{{timestamp}}'
99 | - name: X-BAPI-RECV-WINDOW
100 | in: header
101 | schema:
102 | type: string
103 | example: '{{recvWindow}}'
104 | - name: Content-Type
105 | in: header
106 | schema:
107 | type: string
108 | example: application/json
109 | - name: symbol
110 | in: query
111 | schema:
112 | type: string
113 | example: BTCUSDT
114 | - name: interval
115 | in: query
116 | schema:
117 | type: integer
118 | example: '15'
119 | responses:
120 | '200':
121 | description: Successful response
122 | content:
123 | application/json: {}
124 | /v5/market/index-price-kline:
125 | get:
126 | tags:
127 | - Market
128 | summary: index-price-kline
129 | parameters:
130 | - name: X-BAPI-SIGN-TYPE
131 | in: header
132 | schema:
133 | type: integer
134 | example: '2'
135 | - name: X-BAPI-SIGN
136 | in: header
137 | schema:
138 | type: string
139 | example: '{{signed}}'
140 | - name: X-BAPI-API-KEY
141 | in: header
142 | schema:
143 | type: string
144 | example: '{{api_key}}'
145 | - name: X-BAPI-TIMESTAMP
146 | in: header
147 | schema:
148 | type: string
149 | example: '{{timestamp}}'
150 | - name: X-BAPI-RECV-WINDOW
151 | in: header
152 | schema:
153 | type: string
154 | example: '{{recvWindow}}'
155 | - name: Content-Type
156 | in: header
157 | schema:
158 | type: string
159 | example: application/json
160 | - name: category
161 | in: query
162 | schema:
163 | type: string
164 | example: inverse
165 | - name: symbol
166 | in: query
167 | schema:
168 | type: string
169 | example: BTCUSDT
170 | - name: interval
171 | in: query
172 | schema:
173 | type: integer
174 | example: '1'
175 | responses:
176 | '200':
177 | description: Successful response
178 | content:
179 | application/json: {}
180 | /v5/market/premium-index-price-kline:
181 | get:
182 | tags:
183 | - Market
184 | summary: premium-index-price-kline
185 | parameters:
186 | - name: X-BAPI-SIGN-TYPE
187 | in: header
188 | schema:
189 | type: integer
190 | example: '2'
191 | - name: X-BAPI-SIGN
192 | in: header
193 | schema:
194 | type: string
195 | example: '{{signed}}'
196 | - name: X-BAPI-API-KEY
197 | in: header
198 | schema:
199 | type: string
200 | example: '{{api_key}}'
201 | - name: X-BAPI-TIMESTAMP
202 | in: header
203 | schema:
204 | type: string
205 | example: '{{timestamp}}'
206 | - name: X-BAPI-RECV-WINDOW
207 | in: header
208 | schema:
209 | type: string
210 | example: '{{recvWindow}}'
211 | - name: Content-Type
212 | in: header
213 | schema:
214 | type: string
215 | example: application/json
216 | - name: category
217 | in: query
218 | schema:
219 | type: string
220 | example: inverse
221 | - name: symbol
222 | in: query
223 | schema:
224 | type: string
225 | example: BTCUSDT
226 | - name: interval
227 | in: query
228 | schema:
229 | type: integer
230 | example: '5'
231 | responses:
232 | '200':
233 | description: Successful response
234 | content:
235 | application/json: {}
236 | /v5/market/orderbook:
237 | get:
238 | tags:
239 | - Market
240 | summary: orderbook
241 | parameters:
242 | - name: X-BAPI-SIGN-TYPE
243 | in: header
244 | schema:
245 | type: integer
246 | example: '2'
247 | - name: X-BAPI-SIGN
248 | in: header
249 | schema:
250 | type: string
251 | example: '{{signed}}'
252 | - name: X-BAPI-API-KEY
253 | in: header
254 | schema:
255 | type: string
256 | example: '{{api_key}}'
257 | - name: X-BAPI-TIMESTAMP
258 | in: header
259 | schema:
260 | type: string
261 | example: '{{timestamp}}'
262 | - name: X-BAPI-RECV-WINDOW
263 | in: header
264 | schema:
265 | type: string
266 | example: '{{recvWindow}}'
267 | - name: Content-Type
268 | in: header
269 | schema:
270 | type: string
271 | example: application/json
272 | - name: category
273 | in: query
274 | schema:
275 | type: string
276 | description: linear inverse
277 | example: option
278 | - name: symbol
279 | in: query
280 | schema:
281 | type: string
282 | example: BTC-6JAN23-16000-C
283 | - name: limit
284 | in: query
285 | schema:
286 | type: integer
287 | example: '2'
288 | responses:
289 | '200':
290 | description: Successful response
291 | content:
292 | application/json: {}
293 | /v5/market/instruments-info:
294 | get:
295 | tags:
296 | - Market
297 | summary: instruments-info
298 | parameters:
299 | - name: X-BAPI-SIGN-TYPE
300 | in: header
301 | schema:
302 | type: integer
303 | example: '2'
304 | - name: X-BAPI-SIGN
305 | in: header
306 | schema:
307 | type: string
308 | example: '{{signed}}'
309 | - name: X-BAPI-API-KEY
310 | in: header
311 | schema:
312 | type: string
313 | example: '{{api_key}}'
314 | - name: X-BAPI-TIMESTAMP
315 | in: header
316 | schema:
317 | type: string
318 | example: '{{timestamp}}'
319 | - name: X-BAPI-RECV-WINDOW
320 | in: header
321 | schema:
322 | type: string
323 | example: '{{recvWindow}}'
324 | - name: Content-Type
325 | in: header
326 | schema:
327 | type: string
328 | example: application/json
329 | - name: category
330 | in: query
331 | schema:
332 | type: string
333 | example: linear
334 | - name: symbol
335 | in: query
336 | schema:
337 | type: string
338 | description: BTCUSDH23
339 | example: BTCUSDT
340 | - name: limit
341 | in: query
342 | schema:
343 | type: integer
344 | example: '10'
345 | responses:
346 | '200':
347 | description: Successful response
348 | content:
349 | application/json: {}
350 | /v5/market/tickers:
351 | get:
352 | tags:
353 | - Market
354 | summary: tickers
355 | parameters:
356 | - name: X-BAPI-SIGN-TYPE
357 | in: header
358 | schema:
359 | type: integer
360 | example: '2'
361 | - name: X-BAPI-SIGN
362 | in: header
363 | schema:
364 | type: string
365 | example: '{{signed}}'
366 | - name: X-BAPI-API-KEY
367 | in: header
368 | schema:
369 | type: string
370 | example: '{{api_key}}'
371 | - name: X-BAPI-TIMESTAMP
372 | in: header
373 | schema:
374 | type: string
375 | example: '{{timestamp}}'
376 | - name: X-BAPI-RECV-WINDOW
377 | in: header
378 | schema:
379 | type: string
380 | example: '{{recvWindow}}'
381 | - name: Content-Type
382 | in: header
383 | schema:
384 | type: string
385 | example: application/json
386 | - name: category
387 | in: query
388 | schema:
389 | type: string
390 | description: linear inverse
391 | example: option
392 | - name: baseCoin
393 | in: query
394 | schema:
395 | type: string
396 | example: BTC
397 | responses:
398 | '200':
399 | description: Successful response
400 | content:
401 | application/json: {}
402 | /v5/market/funding/history:
403 | get:
404 | tags:
405 | - Market
406 | summary: funding/history
407 | parameters:
408 | - name: X-BAPI-SIGN-TYPE
409 | in: header
410 | schema:
411 | type: integer
412 | example: '2'
413 | - name: X-BAPI-SIGN
414 | in: header
415 | schema:
416 | type: string
417 | example: '{{signed}}'
418 | - name: X-BAPI-API-KEY
419 | in: header
420 | schema:
421 | type: string
422 | example: '{{api_key}}'
423 | - name: X-BAPI-TIMESTAMP
424 | in: header
425 | schema:
426 | type: string
427 | example: '{{timestamp}}'
428 | - name: X-BAPI-RECV-WINDOW
429 | in: header
430 | schema:
431 | type: string
432 | example: '{{recvWindow}}'
433 | - name: Content-Type
434 | in: header
435 | schema:
436 | type: string
437 | example: application/json
438 | - name: category
439 | in: query
440 | schema:
441 | type: string
442 | example: linear
443 | - name: symbol
444 | in: query
445 | schema:
446 | type: string
447 | example: BTCUSDT
448 | responses:
449 | '200':
450 | description: Successful response
451 | content:
452 | application/json: {}
453 | /v5/market/risk-limit:
454 | get:
455 | tags:
456 | - Market
457 | summary: risk-limit
458 | parameters:
459 | - name: X-BAPI-SIGN-TYPE
460 | in: header
461 | schema:
462 | type: integer
463 | example: '2'
464 | - name: X-BAPI-SIGN
465 | in: header
466 | schema:
467 | type: string
468 | example: '{{signed}}'
469 | - name: X-BAPI-API-KEY
470 | in: header
471 | schema:
472 | type: string
473 | example: '{{api_key}}'
474 | - name: X-BAPI-TIMESTAMP
475 | in: header
476 | schema:
477 | type: string
478 | example: '{{timestamp}}'
479 | - name: X-BAPI-RECV-WINDOW
480 | in: header
481 | schema:
482 | type: string
483 | example: '{{recvWindow}}'
484 | - name: Content-Type
485 | in: header
486 | schema:
487 | type: string
488 | example: application/json
489 | - name: category
490 | in: query
491 | schema:
492 | type: string
493 | example: linear
494 | - name: symbol
495 | in: query
496 | schema:
497 | type: string
498 | description: BTCPERP
499 | example: BTCUSDT
500 | responses:
501 | '200':
502 | description: Successful response
503 | content:
504 | application/json: {}
505 | /v5/market/open-interest:
506 | get:
507 | tags:
508 | - Market
509 | summary: open-interest
510 | parameters:
511 | - name: category
512 | in: query
513 | schema:
514 | type: string
515 | description: linear
516 | example: linear
517 | - name: symbol
518 | in: query
519 | schema:
520 | type: string
521 | example: BTCUSDT
522 | - name: intervalTime
523 | in: query
524 | schema:
525 | type: string
526 | example: 5min
527 | responses:
528 | '200':
529 | description: Successful response
530 | content:
531 | application/json: {}
532 | /v5/market/insurance:
533 | get:
534 | tags:
535 | - Market
536 | summary: insurance
537 | responses:
538 | '200':
539 | description: Successful response
540 | content:
541 | application/json: {}
542 | /v5/market/recent-trade:
543 | get:
544 | tags:
545 | - Market
546 | summary: recent-trade
547 | parameters:
548 | - name: category
549 | in: query
550 | schema:
551 | type: string
552 | description: linear
553 | example: option
554 | - name: symbol
555 | in: query
556 | schema:
557 | type: string
558 | example: ETH-30JUN23-2050-C
559 | responses:
560 | '200':
561 | description: Successful response
562 | content:
563 | application/json: {}
564 | /v5/market/delivery-price:
565 | get:
566 | tags:
567 | - Market
568 | summary: delivery-price
569 | parameters:
570 | - name: category
571 | in: query
572 | schema:
573 | type: string
574 | example: option
575 | - name: baseCoin
576 | in: query
577 | schema:
578 | type: string
579 | example: BTC
580 | - name: limit
581 | in: query
582 | schema:
583 | type: integer
584 | example: '10'
585 | responses:
586 | '200':
587 | description: Successful response
588 | content:
589 | application/json: {}
590 | /v5/market/account-ratio:
591 | get:
592 | tags:
593 | - Market
594 | summary: Get Long Short Ratio
595 | parameters:
596 | - name: category
597 | in: query
598 | schema:
599 | type: string
600 | example: linear
601 | - name: symbol
602 | in: query
603 | schema:
604 | type: string
605 | example: BTCUSDT
606 | - name: period
607 | in: query
608 | schema:
609 | type: string
610 | example: 1h
611 | - name: limit
612 | in: query
613 | schema:
614 | type: integer
615 | example: '50'
616 | responses:
617 | '200':
618 | description: Successful response
619 | content:
620 | application/json: {}
621 | /v5/market/historical-volatility:
622 | get:
623 | tags:
624 | - Market
625 | summary: historical-volatility
626 | parameters:
627 | - name: category
628 | in: query
629 | schema:
630 | type: string
631 | example: option
632 | - name: period
633 | in: query
634 | schema:
635 | type: integer
636 | example: '7'
637 | responses:
638 | '200':
639 | description: Successful response
640 | content:
641 | application/json: {}
642 | /v5/order/create:
643 | post:
644 | tags:
645 | - Order
646 | summary: create（Conditional Order）
647 | requestBody:
648 | content:
649 | '*/*':
650 | schema:
651 | type: string
652 | example: >-
653 | "{\n \"category\":\"spot\",\n \"symbol\":
654 | \"BTCUSDT\",\n \"side\": \"Buy\",\n \"positionIdx\":
655 | 0,\n \"orderType\": \"Limit\",\n \"qty\": \"0.001\",\n
656 | \"price\": \"20000\",\n \"triggerDirection\": 1,\n
657 | \"triggerPrice\": \"27265\",\n \"triggerBy\":
658 | \"MarkPrice\",\n \"timeInForce\": \"GTC\",\n
659 | \"orderLinkId\": \"1234566\",\n \"takeProfit\": \"\",\n
660 | \"stopLoss\": \"\",\n \"reduce_only\": false,\n
661 | \"closeOnTrigger\": false,\n
662 | \"orderFilter\":\"tpslOrder\"\n}"
663 | parameters:
664 | - name: X-BAPI-SIGN-TYPE
665 | in: header
666 | schema:
667 | type: integer
668 | example: '2'
669 | - name: X-BAPI-SIGN
670 | in: header
671 | schema:
672 | type: string
673 | example: '{{signature}}'
674 | - name: X-BAPI-API-KEY
675 | in: header
676 | schema:
677 | type: string
678 | example: '{{bybit-api-key}}'
679 | - name: X-BAPI-TIMESTAMP
680 | in: header
681 | schema:
682 | type: string
683 | example: '{{timestamp}}'
684 | - name: X-BAPI-RECV-WINDOW
685 | in: header
686 | schema:
687 | type: string
688 | example: '{{recvWindow}}'
689 | - name: Content-Type
690 | in: header
691 | schema:
692 | type: string
693 | example: application/json
694 | responses:
695 | '200':
696 | description: Successful response
697 | content:
698 | application/json: {}
699 | /v5/order/create-batch:
700 | post:
701 | tags:
702 | - Order
703 | summary: create-batch
704 | requestBody:
705 | content:
706 | '*/*':
707 | schema:
708 | type: string
709 | example: >-
710 | "{\n \"category\":\"option\", \n \"request\": [ \n { \n
711 | \"category\":\"option\", \n \"symbol\":\"BTC-10FEB23-24000-C\",
712 | \n \"orderType\":\"Limit\", \n \"side\":\"Buy\", \n
713 | \"qty\":\"0.1\", \n \"price\":\"5\", \n \"iv\":\"0.1\", \n
714 | \"timeInForce\":\"GTC\", \n \"orderLinkId\":\"9b381bb1-401\",
715 | \n \"mmp\":false, \n \"reduceOnly\":false \n },\n { \n
716 | \"category\":\"option\", \n \"symbol\":\"BTC-10FEB23-24000-C\",
717 | \n \"orderType\":\"Limit\", \n \"side\":\"Buy\", \n
718 | \"qty\":\"0.1\", \n \"price\":\"5\", \n \"iv\":\"0.1\", \n
719 | \"timeInForce\":\"GTC\", \n \"orderLinkId\":\"82ee86dd-001\",
720 | \n \"mmp\":false, \n \"reduceOnly\":false \n } \n ]\n}"
721 | parameters:
722 | - name: X-BAPI-SIGN-TYPE
723 | in: header
724 | schema:
725 | type: integer
726 | example: '2'
727 | - name: X-BAPI-SIGN
728 | in: header
729 | schema:
730 | type: string
731 | example: '{{signature}}'
732 | - name: X-BAPI-API-KEY
733 | in: header
734 | schema:
735 | type: string
736 | example: '{{bybit-api-key}}'
737 | - name: X-BAPI-TIMESTAMP
738 | in: header
739 | schema:
740 | type: string
741 | example: '{{timestamp}}'
742 | - name: X-BAPI-RECV-WINDOW
743 | in: header
744 | schema:
745 | type: string
746 | example: '{{recvWindow}}'
747 | - name: Content-Type
748 | in: header
749 | schema:
750 | type: string
751 | example: application/json
752 | responses:
753 | '200':
754 | description: Successful response
755 | content:
756 | application/json: {}
757 | /v5/order/amend-batch:
758 | post:
759 | tags:
760 | - Order
761 | summary: amend-batch
762 | requestBody:
763 | content:
764 | '*/*':
765 | schema:
766 | type: string
767 | example: >-
768 | " {\n \"category\":\"option\", \n \"request\": [ \n { \n
769 | \"category\":\"null\", \n \"symbol\":\"BTC-30DEC22-44000-C\",
770 | \n \"qty\":\"0.1\", \n \"orderLinkId\":\"\", \n
771 | \"orderId\":\"\", \n \"iv\":\"0.1\" \n },\n { \n
772 | \"category\":\"null\", \n \"symbol\":\"\", \n \"qty\":\"0.1\",
773 | \n \"orderLinkId\":\"82ee86dd-00\", \n
774 | \"orderId\":\"60c257f9-57cc-47a3-95cb-811f55fa793c\", \n
775 | \"iv\":\"0.1\" \n }\n ]\n}"
776 | parameters:
777 | - name: X-BAPI-SIGN-TYPE
778 | in: header
779 | schema:
780 | type: integer
781 | example: '2'
782 | - name: X-BAPI-SIGN
783 | in: header
784 | schema:
785 | type: string
786 | example: '{{signature}}'
787 | - name: X-BAPI-API-KEY
788 | in: header
789 | schema:
790 | type: string
791 | example: '{{bybit-api-key}}'
792 | - name: X-BAPI-TIMESTAMP
793 | in: header
794 | schema:
795 | type: string
796 | example: '{{timestamp}}'
797 | - name: X-BAPI-RECV-WINDOW
798 | in: header
799 | schema:
800 | type: string
801 | example: '{{recvWindow}}'
802 | - name: Content-Type
803 | in: header
804 | schema:
805 | type: string
806 | example: application/json
807 | responses:
808 | '200':
809 | description: Successful response
810 | content:
811 | application/json: {}
812 | /v5/order/cancel-batch:
813 | post:
814 | tags:
815 | - Order
816 | summary: cancel-batch
817 | requestBody:
818 | content:
819 | '*/*':
820 | schema:
821 | type: string
822 | example: >-
823 | " {\n \"category\":\"option\", \n \"request\": [ \n { \n
824 | \"category\":\"null\", \n \"symbol\":\"BTC-30DEC22-44000-C\",
825 | \n \"orderLinkId\":\"4197d261-d2\", \n
826 | \"orderId\":\"0ccd205e-5145-4f27-9402-2f47674098fa\" \n },\n
827 | { \n \"category\":\"null\", \n
828 | \"symbol\":\"BTC-30DEC22-44000-C\", \n
829 | \"orderLinkId\":\"90d272e8-24\", \n
830 | \"orderId\":\"17f51491-584f-41c4-ae22-c9cdf916b1db\" \n }\n ]\n
831 | }"
832 | parameters:
833 | - name: X-BAPI-SIGN-TYPE
834 | in: header
835 | schema:
836 | type: integer
837 | example: '2'
838 | - name: X-BAPI-SIGN
839 | in: header
840 | schema:
841 | type: string
842 | example: '{{signature}}'
843 | - name: X-BAPI-API-KEY
844 | in: header
845 | schema:
846 | type: string
847 | example: '{{bybit-api-key}}'
848 | - name: X-BAPI-TIMESTAMP
849 | in: header
850 | schema:
851 | type: string
852 | example: '{{timestamp}}'
853 | - name: X-BAPI-RECV-WINDOW
854 | in: header
855 | schema:
856 | type: string
857 | example: '{{recvWindow}}'
858 | - name: Content-Type
859 | in: header
860 | schema:
861 | type: string
862 | example: application/json
863 | responses:
864 | '200':
865 | description: Successful response
866 | content:
867 | application/json: {}
868 | /v5/order/amend:
869 | post:
870 | tags:
871 | - Order
872 | summary: amend
873 | requestBody:
874 | content:
875 | '*/*':
876 | schema:
877 | type: string
878 | example: >-
879 | "{\n \"category\":\"linear\",\n
880 | \"symbol\":\"BTCUSDT\",\n
881 | \"orderId\":\"a51bdc00-40e8-494f-b38a-1120fdaeecc3\",\n
882 | \"price\": \"28000\",\n \"qty\":\"0.001\"\n}"
883 | parameters:
884 | - name: X-BAPI-SIGN-TYPE
885 | in: header
886 | schema:
887 | type: integer
888 | example: '2'
889 | - name: X-BAPI-SIGN
890 | in: header
891 | schema:
892 | type: string
893 | example: '{{signature}}'
894 | - name: X-BAPI-API-KEY
895 | in: header
896 | schema:
897 | type: string
898 | example: '{{bybit-api-key}}'
899 | - name: X-BAPI-TIMESTAMP
900 | in: header
901 | schema:
902 | type: string
903 | example: '{{timestamp}}'
904 | - name: X-BAPI-RECV-WINDOW
905 | in: header
906 | schema:
907 | type: string
908 | example: '{{recvWindow}}'
909 | - name: Content-Type
910 | in: header
911 | schema:
912 | type: string
913 | example: application/json
914 | responses:
915 | '200':
916 | description: Successful response
917 | content:
918 | application/json: {}
919 | /v5/order/cancel:
920 | post:
921 | tags:
922 | - Order
923 | summary: cancel
924 | requestBody:
925 | content:
926 | '*/*':
927 | schema:
928 | type: string
929 | example: >-
930 | "{\n \"category\": \"linear\",\n \"symbol\": \"BTCUSDT\",\n
931 | \"orderId\":\"9d3ef617-f214-4818-979e-20b44256dbec\"\n}"
932 | parameters:
933 | - name: X-BAPI-SIGN-TYPE
934 | in: header
935 | schema:
936 | type: integer
937 | example: '2'
938 | - name: X-BAPI-SIGN
939 | in: header
940 | schema:
941 | type: string
942 | example: '{{signature}}'
943 | - name: X-BAPI-API-KEY
944 | in: header
945 | schema:
946 | type: string
947 | example: '{{bybit-api-key}}'
948 | - name: X-BAPI-TIMESTAMP
949 | in: header
950 | schema:
951 | type: string
952 | example: '{{timestamp}}'
953 | - name: X-BAPI-RECV-WINDOW
954 | in: header
955 | schema:
956 | type: string
957 | example: '{{recvWindow}}'
958 | - name: Content-Type
959 | in: header
960 | schema:
961 | type: string
962 | example: application/json
963 | responses:
964 | '200':
965 | description: Successful response
966 | content:
967 | application/json: {}
968 | /v5/order/cancel-all:
969 | post:
970 | tags:
971 | - Order
972 | summary: cancel-all Copy
973 | requestBody:
974 | content:
975 | '*/*':
976 | schema:
977 | type: string
978 | example: '"{\n \"category\": \"spot\",\n \"settleCoin\":\"USDT\"\n}"'
979 | parameters:
980 | - name: X-BAPI-SIGN-TYPE
981 | in: header
982 | schema:
983 | type: integer
984 | example: '2'
985 | - name: X-BAPI-SIGN
986 | in: header
987 | schema:
988 | type: string
989 | example: '{{signature}}'
990 | - name: X-BAPI-API-KEY
991 | in: header
992 | schema:
993 | type: string
994 | example: '{{bybit-api-key}}'
995 | - name: X-BAPI-TIMESTAMP
996 | in: header
997 | schema:
998 | type: string
999 | example: '{{timestamp}}'
1000 | - name: X-BAPI-RECV-WINDOW
1001 | in: header
1002 | schema:
1003 | type: string
1004 | example: '{{recvWindow}}'
1005 | - name: Content-Type
1006 | in: header
1007 | schema:
1008 | type: string
1009 | example: application/json
1010 | responses:
1011 | '200':
1012 | description: Successful response
1013 | content:
1014 | application/json: {}
1015 | /v5/order/realtime:
1016 | get:
1017 | tags:
1018 | - Order
1019 | summary: Get Open & Closed Orders
1020 | parameters:
1021 | - name: X-BAPI-SIGN-TYPE
1022 | in: header
1023 | schema:
1024 | type: integer
1025 | example: '2'
1026 | - name: X-BAPI-SIGN
1027 | in: header
1028 | schema:
1029 | type: string
1030 | example: '{{signature}}'
1031 | - name: X-BAPI-API-KEY
1032 | in: header
1033 | schema:
1034 | type: string
1035 | example: '{{bybit-api-key}}'
1036 | - name: X-BAPI-TIMESTAMP
1037 | in: header
1038 | schema:
1039 | type: string
1040 | example: '{{timestamp}}'
1041 | - name: X-BAPI-RECV-WINDOW
1042 | in: header
1043 | schema:
1044 | type: string
1045 | example: '{{recvWindow}}'
1046 | - name: Content-Type
1047 | in: header
1048 | schema:
1049 | type: string
1050 | example: application/json
1051 | - name: cdn-request-id
1052 | in: header
1053 | schema:
1054 | type: string
1055 | example: tttt
1056 | - name: orderId
1057 | in: query
1058 | schema:
1059 | type: integer
1060 | example: '1401404332739465472'
1061 | - name: category
1062 | in: query
1063 | schema:
1064 | type: string
1065 | example: spot
1066 | responses:
1067 | '200':
1068 | description: Successful response
1069 | content:
1070 | application/json: {}
1071 | /v5/order/history:
1072 | get:
1073 | tags:
1074 | - Order
1075 | summary: Get Order History
1076 | parameters:
1077 | - name: X-BAPI-SIGN-TYPE
1078 | in: header
1079 | schema:
1080 | type: integer
1081 | example: '2'
1082 | - name: X-BAPI-SIGN
1083 | in: header
1084 | schema:
1085 | type: string
1086 | example: '{{signature}}'
1087 | - name: X-BAPI-API-KEY
1088 | in: header
1089 | schema:
1090 | type: string
1091 | example: '{{bybit-api-key}}'
1092 | - name: X-BAPI-TIMESTAMP
1093 | in: header
1094 | schema:
1095 | type: string
1096 | example: '{{timestamp}}'
1097 | - name: X-BAPI-RECV-WINDOW
1098 | in: header
1099 | schema:
1100 | type: string
1101 | example: '{{recvWindow}}'
1102 | - name: Content-Type
1103 | in: header
1104 | schema:
1105 | type: string
1106 | example: application/json
1107 | - name: category
1108 | in: query
1109 | schema:
1110 | type: string
1111 | example: spot
1112 | - name: orderId
1113 | in: query
1114 | schema:
1115 | type: integer
1116 | example: '1402058681081733376'
1117 | responses:
1118 | '200':
1119 | description: Successful response
1120 | content:
1121 | application/json: {}
1122 | /v5/order/spot-borrow-check:
1123 | get:
1124 | tags:
1125 | - Order
1126 | summary: Get Borrow Quota (Spot)
1127 | parameters:
1128 | - name: X-BAPI-SIGN-TYPE
1129 | in: header
1130 | schema:
1131 | type: integer
1132 | example: '2'
1133 | - name: X-BAPI-SIGN
1134 | in: header
1135 | schema:
1136 | type: string
1137 | example: '{{signature}}'
1138 | - name: X-BAPI-API-KEY
1139 | in: header
1140 | schema:
1141 | type: string
1142 | example: '{{bybit-api-key}}'
1143 | - name: X-BAPI-TIMESTAMP
1144 | in: header
1145 | schema:
1146 | type: string
1147 | example: '{{timestamp}}'
1148 | - name: X-BAPI-RECV-WINDOW
1149 | in: header
1150 | schema:
1151 | type: string
1152 | example: '{{recvWindow}}'
1153 | - name: Content-Type
1154 | in: header
1155 | schema:
1156 | type: string
1157 | example: application/json
1158 | - name: category
1159 | in: query
1160 | schema:
1161 | type: string
1162 | example: spot
1163 | - name: symbol
1164 | in: query
1165 | schema:
1166 | type: string
1167 | example: BTCUSDT
1168 | - name: side
1169 | in: query
1170 | schema:
1171 | type: string
1172 | example: Sell
1173 | responses:
1174 | '200':
1175 | description: Successful response
1176 | content:
1177 | application/json: {}
1178 | /v5/execution/list:
1179 | get:
1180 | tags:
1181 | - Order
1182 | summary: Get Trade History
1183 | parameters:
1184 | - name: X-BAPI-SIGN-TYPE
1185 | in: header
1186 | schema:
1187 | type: integer
1188 | example: '2'
1189 | - name: X-BAPI-SIGN
1190 | in: header
1191 | schema:
1192 | type: string
1193 | example: '{{signature}}'
1194 | - name: X-BAPI-API-KEY
1195 | in: header
1196 | schema:
1197 | type: string
1198 | example: '{{bybit-api-key}}'
1199 | - name: X-BAPI-TIMESTAMP
1200 | in: header
1201 | schema:
1202 | type: string
1203 | example: '{{timestamp}}'
1204 | - name: X-BAPI-RECV-WINDOW
1205 | in: header
1206 | schema:
1207 | type: string
1208 | example: '{{recvWindow}}'
1209 | - name: Content-Type
1210 | in: header
1211 | schema:
1212 | type: string
1213 | example: application/json
1214 | - name: category
1215 | in: query
1216 | schema:
1217 | type: string
1218 | example: linear
1219 | - name: symbol
1220 | in: query
1221 | schema:
1222 | type: string
1223 | example: XRPUSDT
1224 | - name: execType
1225 | in: query
1226 | schema:
1227 | type: string
1228 | example: Funding
1229 | responses:
1230 | '200':
1231 | description: Successful response
1232 | content:
1233 | application/json: {}
1234 | /v5/position/list:
1235 | get:
1236 | tags:
1237 | - Position
1238 | summary: position/list
1239 | parameters:
1240 | - name: X-BAPI-SIGN-TYPE
1241 | in: header
1242 | schema:
1243 | type: integer
1244 | example: '2'
1245 | - name: X-BAPI-SIGN
1246 | in: header
1247 | schema:
1248 | type: string
1249 | example: '{{signature}}'
1250 | - name: X-BAPI-API-KEY
1251 | in: header
1252 | schema:
1253 | type: string
1254 | example: '{{bybit-api-key}}'
1255 | - name: X-BAPI-TIMESTAMP
1256 | in: header
1257 | schema:
1258 | type: string
1259 | example: '{{timestamp}}'
1260 | - name: X-BAPI-RECV-WINDOW
1261 | in: header
1262 | schema:
1263 | type: string
1264 | example: '{{recvWindow}}'
1265 | - name: Content-Type
1266 | in: header
1267 | schema:
1268 | type: string
1269 | example: application/json
1270 | - name: symbol
1271 | in: query
1272 | schema:
1273 | type: string
1274 | example: BTCPERP
1275 | - name: category
1276 | in: query
1277 | schema:
1278 | type: string
1279 | example: linear
1280 | responses:
1281 | '200':
1282 | description: Successful response
1283 | content:
1284 | application/json: {}
1285 | /v5/position/switch-isolated:
1286 | post:
1287 | tags:
1288 | - Position
1289 | summary: switch-isolated
1290 | requestBody:
1291 | content:
1292 | '*/*':
1293 | schema:
1294 | type: string
1295 | example: >-
1296 | "{\n \"category\":\"linear\",\n
1297 | \"symbol\":\"BTC-31MAR23\",\n \"tradeMode\":\"0\",\n
1298 | \"buyLeverage\":\"5\",\n \"sellLeverage\":\"5\"\n}"
1299 | parameters:
1300 | - name: X-BAPI-SIGN-TYPE
1301 | in: header
1302 | schema:
1303 | type: integer
1304 | example: '2'
1305 | - name: X-BAPI-SIGN
1306 | in: header
1307 | schema:
1308 | type: string
1309 | example: '{{signature}}'
1310 | - name: X-BAPI-API-KEY
1311 | in: header
1312 | schema:
1313 | type: string
1314 | example: '{{bybit-api-key}}'
1315 | - name: X-BAPI-TIMESTAMP
1316 | in: header
1317 | schema:
1318 | type: string
1319 | example: '{{timestamp}}'
1320 | - name: X-BAPI-RECV-WINDOW
1321 | in: header
1322 | schema:
1323 | type: string
1324 | example: '{{recvWindow}}'
1325 | - name: Content-Type
1326 | in: header
1327 | schema:
1328 | type: string
1329 | example: application/json
1330 | responses:
1331 | '200':
1332 | description: Successful response
1333 | content:
1334 | application/json: {}
1335 | /v5/position/switch-mode:
1336 | post:
1337 | tags:
1338 | - Position
1339 | summary: switch-mode
1340 | requestBody:
1341 | content:
1342 | '*/*':
1343 | schema:
1344 | type: string
1345 | example: >-
1346 | "{\n \"category\":\"linear\",\n
1347 | \"symbol\":\"BTCUSDT\",\n \"mode\": 3\n}"
1348 | parameters:
1349 | - name: X-BAPI-SIGN-TYPE
1350 | in: header
1351 | schema:
1352 | type: integer
1353 | example: '2'
1354 | - name: X-BAPI-SIGN
1355 | in: header
1356 | schema:
1357 | type: string
1358 | example: '{{signature}}'
1359 | - name: X-BAPI-API-KEY
1360 | in: header
1361 | schema:
1362 | type: string
1363 | example: '{{bybit-api-key}}'
1364 | - name: X-BAPI-TIMESTAMP
1365 | in: header
1366 | schema:
1367 | type: string
1368 | example: '{{timestamp}}'
1369 | - name: X-BAPI-RECV-WINDOW
1370 | in: header
1371 | schema:
1372 | type: string
1373 | example: '{{recvWindow}}'
1374 | - name: Content-Type
1375 | in: header
1376 | schema:
1377 | type: string
1378 | example: application/json
1379 | responses:
1380 | '200':
1381 | description: Successful response
1382 | content:
1383 | application/json: {}
1384 | /v5/position/trading-stop:
1385 | post:
1386 | tags:
1387 | - Position
1388 | summary: trading-stop
1389 | requestBody:
1390 | content:
1391 | '*/*':
1392 | schema:
1393 | type: string
1394 | example: >-
1395 | "{\n \"category\":\"linear\",\n \"symbol\":
1396 | \"BTCUSDT\",\n \"takeProfit\": \"20000\",\n \"stopLoss\":
1397 | \"10000\",\n \"tpTriggerBy\": \"MarkPrice\",\n
1398 | \"slTriggerBy\": \"IndexPrice\",\n \"positionIdx\": 0\n}"
1399 | parameters:
1400 | - name: X-BAPI-SIGN-TYPE
1401 | in: header
1402 | schema:
1403 | type: integer
1404 | example: '2'
1405 | - name: X-BAPI-SIGN
1406 | in: header
1407 | schema:
1408 | type: string
1409 | example: '{{signature}}'
1410 | - name: X-BAPI-API-KEY
1411 | in: header
1412 | schema:
1413 | type: string
1414 | example: '{{bybit-api-key}}'
1415 | - name: X-BAPI-TIMESTAMP
1416 | in: header
1417 | schema:
1418 | type: string
1419 | example: '{{timestamp}}'
1420 | - name: X-BAPI-RECV-WINDOW
1421 | in: header
1422 | schema:
1423 | type: string
1424 | example: '{{recvWindow}}'
1425 | - name: Content-Type
1426 | in: header
1427 | schema:
1428 | type: string
1429 | example: application/json
1430 | responses:
1431 | '200':
1432 | description: Successful response
1433 | content:
1434 | application/json: {}
1435 | /v5/position/set-leverage:
1436 | post:
1437 | tags:
1438 | - Position
1439 | summary: set-leverage
1440 | requestBody:
1441 | content:
1442 | '*/*':
1443 | schema:
1444 | type: string
1445 | example: >-
1446 | "{\n \"category\": \"linear\",\n
1447 | \"symbol\":\"BTCPERP\",\n \"buyLeverage\":\"2\",\n
1448 | \"sellLeverage\":\"2\"\n}"
1449 | parameters:
1450 | - name: X-BAPI-SIGN-TYPE
1451 | in: header
1452 | schema:
1453 | type: integer
1454 | example: '2'
1455 | - name: X-BAPI-SIGN
1456 | in: header
1457 | schema:
1458 | type: string
1459 | example: '{{signature}}'
1460 | - name: X-BAPI-API-KEY
1461 | in: header
1462 | schema:
1463 | type: string
1464 | example: '{{bybit-api-key}}'
1465 | - name: X-BAPI-TIMESTAMP
1466 | in: header
1467 | schema:
1468 | type: string
1469 | example: '{{timestamp}}'
1470 | - name: X-BAPI-RECV-WINDOW
1471 | in: header
1472 | schema:
1473 | type: string
1474 | example: '{{recvWindow}}'
1475 | - name: Content-Type
1476 | in: header
1477 | schema:
1478 | type: string
1479 | example: application/json
1480 | responses:
1481 | '200':
1482 | description: Successful response
1483 | content:
1484 | application/json: {}
1485 | /v5/position/set-auto-add-margin:
1486 | post:
1487 | tags:
1488 | - Position
1489 | summary: set-auto-add-margin
1490 | requestBody:
1491 | content:
1492 | '*/*':
1493 | schema:
1494 | type: string
1495 | example: >-
1496 | "{\n \"category\": \"linear\",\n \"symbol\":
1497 | \"BTCPERP\",\n \"autoAddmargin\": 1,\n \"positionIdx\":
1498 | 1\n}"
1499 | parameters:
1500 | - name: X-BAPI-SIGN-TYPE
1501 | in: header
1502 | schema:
1503 | type: integer
1504 | example: '2'
1505 | - name: X-BAPI-SIGN
1506 | in: header
1507 | schema:
1508 | type: string
1509 | example: '{{signature}}'
1510 | - name: X-BAPI-API-KEY
1511 | in: header
1512 | schema:
1513 | type: string
1514 | example: '{{bybit-api-key}}'
1515 | - name: X-BAPI-TIMESTAMP
1516 | in: header
1517 | schema:
1518 | type: string
1519 | example: '{{timestamp}}'
1520 | - name: X-BAPI-RECV-WINDOW
1521 | in: header
1522 | schema:
1523 | type: string
1524 | example: '{{recvWindow}}'
1525 | - name: Content-Type
1526 | in: header
1527 | schema:
1528 | type: string
1529 | example: application/json
1530 | responses:
1531 | '200':
1532 | description: Successful response
1533 | content:
1534 | application/json: {}
1535 | /v5/position/closed-pnl:
1536 | get:
1537 | tags:
1538 | - Position
1539 | summary: closed-pnl
1540 | parameters:
1541 | - name: X-BAPI-SIGN-TYPE
1542 | in: header
1543 | schema:
1544 | type: integer
1545 | example: '2'
1546 | - name: X-BAPI-SIGN
1547 | in: header
1548 | schema:
1549 | type: string
1550 | example: '{{signature}}'
1551 | - name: X-BAPI-API-KEY
1552 | in: header
1553 | schema:
1554 | type: string
1555 | example: '{{bybit-api-key}}'
1556 | - name: X-BAPI-TIMESTAMP
1557 | in: header
1558 | schema:
1559 | type: string
1560 | example: '{{timestamp}}'
1561 | - name: X-BAPI-RECV-WINDOW
1562 | in: header
1563 | schema:
1564 | type: string
1565 | example: '{{recvWindow}}'
1566 | - name: Content-Type
1567 | in: header
1568 | schema:
1569 | type: string
1570 | example: application/json
1571 | - name: category
1572 | in: query
1573 | schema:
1574 | type: string
1575 | example: linear
1576 | - name: symbol
1577 | in: query
1578 | schema:
1579 | type: string
1580 | description: LINKUSDT
1581 | example: BTCUSDT
1582 | responses:
1583 | '200':
1584 | description: Successful response
1585 | content:
1586 | application/json: {}
1587 | /v5/position/set-tpsl-mode:
1588 | post:
1589 | tags:
1590 | - Position
1591 | summary: set-tpsl-mode(Depreciated)
1592 | requestBody:
1593 | content:
1594 | '*/*':
1595 | schema:
1596 | type: string
1597 | example: >-
1598 | "{\n \"symbol\": \"BTCUSDT\",\n \"category\":
1599 | \"linear\",\n \"tpSlMode\": \"Full\"\n}"
1600 | parameters:
1601 | - name: X-BAPI-SIGN-TYPE
1602 | in: header
1603 | schema:
1604 | type: integer
1605 | example: '2'
1606 | - name: X-BAPI-SIGN
1607 | in: header
1608 | schema:
1609 | type: string
1610 | example: '{{signature}}'
1611 | - name: X-BAPI-API-KEY
1612 | in: header
1613 | schema:
1614 | type: string
1615 | example: '{{bybit-api-key}}'
1616 | - name: X-BAPI-TIMESTAMP
1617 | in: header
1618 | schema:
1619 | type: string
1620 | example: '{{timestamp}}'
1621 | - name: X-BAPI-RECV-WINDOW
1622 | in: header
1623 | schema:
1624 | type: string
1625 | example: '{{recvWindow}}'
1626 | - name: Content-Type
1627 | in: header
1628 | schema:
1629 | type: string
1630 | example: application/json
1631 | responses:
1632 | '200':
1633 | description: Successful response
1634 | content:
1635 | application/json: {}
1636 | /v5/position/set-risk-limit:
1637 | post:
1638 | tags:
1639 | - Position
1640 | summary: set-risk-limit(Depreciated)
1641 | requestBody:
1642 | content:
1643 | '*/*':
1644 | schema:
1645 | type: string
1646 | example: >-
1647 | "{\n \"category\": \"linear\",\n \"symbol\": \"BTCUSDT\",
1648 | \n \"riskId\": \"1\", \n \"positionIdx\": 0\n}"
1649 | parameters:
1650 | - name: X-BAPI-SIGN-TYPE
1651 | in: header
1652 | schema:
1653 | type: integer
1654 | example: '2'
1655 | - name: X-BAPI-SIGN
1656 | in: header
1657 | schema:
1658 | type: string
1659 | example: '{{signature}}'
1660 | - name: X-BAPI-API-KEY
1661 | in: header
1662 | schema:
1663 | type: string
1664 | example: '{{bybit-api-key}}'
1665 | - name: X-BAPI-TIMESTAMP
1666 | in: header
1667 | schema:
1668 | type: string
1669 | example: '{{timestamp}}'
1670 | - name: X-BAPI-RECV-WINDOW
1671 | in: header
1672 | schema:
1673 | type: string
1674 | example: '{{recvWindow}}'
1675 | - name: Content-Type
1676 | in: header
1677 | schema:
1678 | type: string
1679 | example: application/json
1680 | responses:
1681 | '200':
1682 | description: Successful response
1683 | content:
1684 | application/json: {}
1685 | /v5/position/move-positions:
1686 | post:
1687 | tags:
1688 | - Position
1689 | summary: move position Copy
1690 | requestBody:
1691 | content:
1692 | '*/*':
1693 | schema:
1694 | type: string
1695 | example: >-
1696 | "{\n \"fromUid\": \"1635703\",\n \"toUid\":
1697 | \"100503864\",\n \"list\": [\n {\n
1698 | \"category\": \"spot\",\n \"symbol\":
1699 | \"BTCUSDT\",\n \"price\": \"45000\",\n
1700 | \"side\": \"Sell\",\n \"qty\": \"0.01\"\n
1701 | }\n ]\n}"
1702 | parameters:
1703 | - name: X-BAPI-SIGN-TYPE
1704 | in: header
1705 | schema:
1706 | type: integer
1707 | example: '2'
1708 | - name: X-BAPI-SIGN
1709 | in: header
1710 | schema:
1711 | type: string
1712 | example: '{{signature}}'
1713 | - name: X-BAPI-API-KEY
1714 | in: header
1715 | schema:
1716 | type: string
1717 | example: '{{bybit-api-key}}'
1718 | - name: X-BAPI-TIMESTAMP
1719 | in: header
1720 | schema:
1721 | type: string
1722 | example: '{{timestamp}}'
1723 | - name: X-BAPI-RECV-WINDOW
1724 | in: header
1725 | schema:
1726 | type: string
1727 | example: '{{recvWindow}}'
1728 | - name: Content-Type
1729 | in: header
1730 | schema:
1731 | type: string
1732 | example: application/json
1733 | responses:
1734 | '200':
1735 | description: Successful response
1736 | content:
1737 | application/json: {}
1738 | /v5/position/move-history:
1739 | get:
1740 | tags:
1741 | - Position
1742 | summary: get move position history Copy
1743 | parameters:
1744 | - name: X-BAPI-SIGN-TYPE
1745 | in: header
1746 | schema:
1747 | type: integer
1748 | example: '2'
1749 | - name: X-BAPI-SIGN
1750 | in: header
1751 | schema:
1752 | type: string
1753 | example: '{{signature}}'
1754 | - name: X-BAPI-API-KEY
1755 | in: header
1756 | schema:
1757 | type: string
1758 | example: '{{bybit-api-key}}'
1759 | - name: X-BAPI-TIMESTAMP
1760 | in: header
1761 | schema:
1762 | type: string
1763 | example: '{{timestamp}}'
1764 | - name: X-BAPI-RECV-WINDOW
1765 | in: header
1766 | schema:
1767 | type: string
1768 | example: '{{recvWindow}}'
1769 | - name: Content-Type
1770 | in: header
1771 | schema:
1772 | type: string
1773 | example: application/json
1774 | responses:
1775 | '200':
1776 | description: Successful response
1777 | content:
1778 | application/json: {}
1779 | /v5/account/wallet-balance:
1780 | get:
1781 | tags:
1782 | - Account
1783 | summary: wallet-balance
1784 | parameters:
1785 | - name: X-BAPI-SIGN-TYPE
1786 | in: header
1787 | schema:
1788 | type: integer
1789 | example: '2'
1790 | - name: X-BAPI-SIGN
1791 | in: header
1792 | schema:
1793 | type: string
1794 | example: '{{signature}}'
1795 | - name: X-BAPI-API-KEY
1796 | in: header
1797 | schema:
1798 | type: string
1799 | example: '{{bybit-api-key}}'
1800 | - name: X-BAPI-TIMESTAMP
1801 | in: header
1802 | schema:
1803 | type: string
1804 | example: '{{timestamp}}'
1805 | - name: X-BAPI-RECV-WINDOW
1806 | in: header
1807 | schema:
1808 | type: string
1809 | example: '{{recvWindow}}'
1810 | - name: Content-Type
1811 | in: header
1812 | schema:
1813 | type: string
1814 | example: application/json
1815 | - name: accountType
1816 | in: query
1817 | schema:
1818 | type: string
1819 | example: UNIFIED
1820 | responses:
1821 | '200':
1822 | description: Successful response
1823 | content:
1824 | application/json: {}
1825 | /v5/asset/coin-greeks:
1826 | get:
1827 | tags:
1828 | - Account
1829 | summary: coin-greeks
1830 | parameters:
1831 | - name: X-BAPI-SIGN-TYPE
1832 | in: header
1833 | schema:
1834 | type: integer
1835 | example: '2'
1836 | - name: X-BAPI-SIGN
1837 | in: header
1838 | schema:
1839 | type: string
1840 | example: '{{signature}}'
1841 | - name: X-BAPI-API-KEY
1842 | in: header
1843 | schema:
1844 | type: string
1845 | example: '{{bybit-api-key}}'
1846 | - name: X-BAPI-TIMESTAMP
1847 | in: header
1848 | schema:
1849 | type: string
1850 | example: '{{timestamp}}'
1851 | - name: X-BAPI-RECV-WINDOW
1852 | in: header
1853 | schema:
1854 | type: string
1855 | example: '{{recvWindow}}'
1856 | - name: Content-Type
1857 | in: header
1858 | schema:
1859 | type: string
1860 | example: application/json
1861 | - name: baseCoin
1862 | in: query
1863 | schema:
1864 | type: string
1865 | example: BTC
1866 | responses:
1867 | '200':
1868 | description: Successful response
1869 | content:
1870 | application/json: {}
1871 | /v5/account/collateral-info:
1872 | get:
1873 | tags:
1874 | - Account
1875 | summary: collateral-info
1876 | parameters:
1877 | - name: X-BAPI-SIGN-TYPE
1878 | in: header
1879 | schema:
1880 | type: integer
1881 | example: '2'
1882 | - name: X-BAPI-SIGN
1883 | in: header
1884 | schema:
1885 | type: string
1886 | example: '{{signature}}'
1887 | - name: X-BAPI-API-KEY
1888 | in: header
1889 | schema:
1890 | type: string
1891 | example: '{{bybit-api-key}}'
1892 | - name: X-BAPI-TIMESTAMP
1893 | in: header
1894 | schema:
1895 | type: string
1896 | example: '{{timestamp}}'
1897 | - name: X-BAPI-RECV-WINDOW
1898 | in: header
1899 | schema:
1900 | type: string
1901 | example: '{{recvWindow}}'
1902 | - name: Content-Type
1903 | in: header
1904 | schema:
1905 | type: string
1906 | example: application/json
1907 | - name: currency
1908 | in: query
1909 | schema:
1910 | type: string
1911 | example: AVAX
1912 | responses:
1913 | '200':
1914 | description: Successful response
1915 | content:
1916 | application/json: {}
1917 | /v5/account/info:
1918 | get:
1919 | tags:
1920 | - Account
1921 | summary: account/info
1922 | parameters:
1923 | - name: X-BAPI-SIGN-TYPE
1924 | in: header
1925 | schema:
1926 | type: integer
1927 | example: '2'
1928 | - name: X-BAPI-SIGN
1929 | in: header
1930 | schema:
1931 | type: string
1932 | example: '{{signature}}'
1933 | - name: X-BAPI-API-KEY
1934 | in: header
1935 | schema:
1936 | type: string
1937 | example: '{{bybit-api-key}}'
1938 | - name: X-BAPI-TIMESTAMP
1939 | in: header
1940 | schema:
1941 | type: string
1942 | example: '{{timestamp}}'
1943 | - name: X-BAPI-RECV-WINDOW
1944 | in: header
1945 | schema:
1946 | type: string
1947 | example: '{{recvWindow}}'
1948 | - name: Content-Type
1949 | in: header
1950 | schema:
1951 | type: string
1952 | example: application/json
1953 | responses:
1954 | '200':
1955 | description: Successful response
1956 | content:
1957 | application/json: {}
1958 | /v5/account/fee-rate:
1959 | get:
1960 | tags:
1961 | - Account
1962 | summary: fee-rate
1963 | parameters:
1964 | - name: X-BAPI-SIGN-TYPE
1965 | in: header
1966 | schema:
1967 | type: integer
1968 | example: '2'
1969 | - name: X-BAPI-SIGN
1970 | in: header
1971 | schema:
1972 | type: string
1973 | example: '{{signature}}'
1974 | - name: X-BAPI-API-KEY
1975 | in: header
1976 | schema:
1977 | type: string
1978 | example: '{{bybit-api-key}}'
1979 | - name: X-BAPI-TIMESTAMP
1980 | in: header
1981 | schema:
1982 | type: string
1983 | example: '{{timestamp}}'
1984 | - name: X-BAPI-RECV-WINDOW
1985 | in: header
1986 | schema:
1987 | type: string
1988 | example: '{{recvWindow}}'
1989 | - name: Content-Type
1990 | in: header
1991 | schema:
1992 | type: string
1993 | example: application/json
1994 | responses:
1995 | '200':
1996 | description: Successful response
1997 | content:
1998 | application/json: {}
1999 | /v5/account/transaction-log:
2000 | get:
2001 | tags:
2002 | - Account
2003 | summary: transaction-log UTA
2004 | parameters:
2005 | - name: X-BAPI-SIGN-TYPE
2006 | in: header
2007 | schema:
2008 | type: integer
2009 | example: '2'
2010 | - name: X-BAPI-SIGN
2011 | in: header
2012 | schema:
2013 | type: string
2014 | example: '{{signature}}'
2015 | - name: X-BAPI-API-KEY
2016 | in: header
2017 | schema:
2018 | type: string
2019 | example: '{{bybit-api-key}}'
2020 | - name: X-BAPI-TIMESTAMP
2021 | in: header
2022 | schema:
2023 | type: string
2024 | example: '{{timestamp}}'
2025 | - name: X-BAPI-RECV-WINDOW
2026 | in: header
2027 | schema:
2028 | type: string
2029 | example: '{{recvWindow}}'
2030 | - name: Content-Type
2031 | in: header
2032 | schema:
2033 | type: string
2034 | example: application/json
2035 | - name: accountType
2036 | in: query
2037 | schema:
2038 | type: string
2039 | example: contract
2040 | - name: category
2041 | in: query
2042 | schema:
2043 | type: string
2044 | example: linear
2045 | responses:
2046 | '200':
2047 | description: Successful response
2048 | content:
2049 | application/json: {}
2050 | /v5/account/contract-transaction-log:
2051 | get:
2052 | tags:
2053 | - Account
2054 | summary: transaction-log classic
2055 | parameters:
2056 | - name: X-BAPI-SIGN-TYPE
2057 | in: header
2058 | schema:
2059 | type: integer
2060 | example: '2'
2061 | - name: X-BAPI-SIGN
2062 | in: header
2063 | schema:
2064 | type: string
2065 | example: '{{signature}}'
2066 | - name: X-BAPI-API-KEY
2067 | in: header
2068 | schema:
2069 | type: string
2070 | example: '{{bybit-api-key}}'
2071 | - name: X-BAPI-TIMESTAMP
2072 | in: header
2073 | schema:
2074 | type: string
2075 | example: '{{timestamp}}'
2076 | - name: X-BAPI-RECV-WINDOW
2077 | in: header
2078 | schema:
2079 | type: string
2080 | example: '{{recvWindow}}'
2081 | - name: Content-Type
2082 | in: header
2083 | schema:
2084 | type: string
2085 | example: application/json
2086 | - name: type
2087 | in: query
2088 | schema:
2089 | type: string
2090 | example: TRADE
2091 | responses:
2092 | '200':
2093 | description: Successful response
2094 | content:
2095 | application/json: {}
2096 | /v5/account/borrow-history:
2097 | get:
2098 | tags:
2099 | - Account
2100 | summary: borrow-history
2101 | parameters:
2102 | - name: X-BAPI-SIGN-TYPE
2103 | in: header
2104 | schema:
2105 | type: integer
2106 | example: '2'
2107 | - name: X-BAPI-SIGN
2108 | in: header
2109 | schema:
2110 | type: string
2111 | example: '{{signature}}'
2112 | - name: X-BAPI-API-KEY
2113 | in: header
2114 | schema:
2115 | type: string
2116 | example: '{{bybit-api-key}}'
2117 | - name: X-BAPI-TIMESTAMP
2118 | in: header
2119 | schema:
2120 | type: string
2121 | example: '{{timestamp}}'
2122 | - name: X-BAPI-RECV-WINDOW
2123 | in: header
2124 | schema:
2125 | type: string
2126 | example: '{{recvWindow}}'
2127 | - name: Content-Type
2128 | in: header
2129 | schema:
2130 | type: string
2131 | example: application/json
2132 | - name: category
2133 | in: query
2134 | schema:
2135 | type: string
2136 | example: spot
2137 | responses:
2138 | '200':
2139 | description: Successful response
2140 | content:
2141 | application/json: {}
2142 | /v5/account/upgrade-to-uta:
2143 | post:
2144 | tags:
2145 | - Account
2146 | summary: upgrade-to-uta
2147 | requestBody:
2148 | content:
2149 | '*/*':
2150 | schema:
2151 | type: string
2152 | example: '"{}"'
2153 | parameters:
2154 | - name: X-BAPI-SIGN-TYPE
2155 | in: header
2156 | schema:
2157 | type: integer
2158 | example: '2'
2159 | - name: X-BAPI-SIGN
2160 | in: header
2161 | schema:
2162 | type: string
2163 | example: '{{signature}}'
2164 | - name: X-BAPI-API-KEY
2165 | in: header
2166 | schema:
2167 | type: string
2168 | example: '{{bybit-api-key}}'
2169 | - name: X-BAPI-TIMESTAMP
2170 | in: header
2171 | schema:
2172 | type: string
2173 | example: '{{timestamp}}'
2174 | - name: X-BAPI-RECV-WINDOW
2175 | in: header
2176 | schema:
2177 | type: string
2178 | example: '{{recvWindow}}'
2179 | - name: Content-Type
2180 | in: header
2181 | schema:
2182 | type: string
2183 | example: application/json
2184 | responses:
2185 | '200':
2186 | description: Successful response
2187 | content:
2188 | application/json: {}
2189 | /v5/account/set-margin-mode:
2190 | post:
2191 | tags:
2192 | - Account
2193 | summary: set-margin-mode
2194 | requestBody:
2195 | content:
2196 | '*/*':
2197 | schema:
2198 | type: string
2199 | example: '"{\n \"setMarginMode\": \"REGULAR_MARGIN\"\n}"'
2200 | parameters:
2201 | - name: X-BAPI-SIGN-TYPE
2202 | in: header
2203 | schema:
2204 | type: integer
2205 | example: '2'
2206 | - name: X-BAPI-SIGN
2207 | in: header
2208 | schema:
2209 | type: string
2210 | example: '{{signature}}'
2211 | - name: X-BAPI-API-KEY
2212 | in: header
2213 | schema:
2214 | type: string
2215 | example: '{{bybit-api-key}}'
2216 | - name: X-BAPI-TIMESTAMP
2217 | in: header
2218 | schema:
2219 | type: string
2220 | example: '{{timestamp}}'
2221 | - name: X-BAPI-RECV-WINDOW
2222 | in: header
2223 | schema:
2224 | type: string
2225 | example: '{{recvWindow}}'
2226 | - name: Content-Type
2227 | in: header
2228 | schema:
2229 | type: string
2230 | example: application/json
2231 | responses:
2232 | '200':
2233 | description: Successful response
2234 | content:
2235 | application/json: {}
2236 | /v5/account/mmp-modify:
2237 | post:
2238 | tags:
2239 | - Account
2240 | summary: set mmp
2241 | requestBody:
2242 | content:
2243 | '*/*':
2244 | schema:
2245 | type: string
2246 | example: >-
2247 | "{\n \"baseCoin\": \"BTC\",\n \"window\":\"5000\",\n
2248 | \"frozenPeriod\":\"100000\",\n \"qtyLimit\":\"0.01\",\n
2249 | \"deltaLimit\":\"0.01\"\n}"
2250 | parameters:
2251 | - name: X-BAPI-SIGN-TYPE
2252 | in: header
2253 | schema:
2254 | type: integer
2255 | example: '2'
2256 | - name: X-BAPI-SIGN
2257 | in: header
2258 | schema:
2259 | type: string
2260 | example: '{{signature}}'
2261 | - name: X-BAPI-API-KEY
2262 | in: header
2263 | schema:
2264 | type: string
2265 | example: '{{bybit-api-key}}'
2266 | - name: X-BAPI-TIMESTAMP
2267 | in: header
2268 | schema:
2269 | type: string
2270 | example: '{{timestamp}}'
2271 | - name: X-BAPI-RECV-WINDOW
2272 | in: header
2273 | schema:
2274 | type: string
2275 | example: '{{recvWindow}}'
2276 | - name: Content-Type
2277 | in: header
2278 | schema:
2279 | type: string
2280 | example: application/json
2281 | responses:
2282 | '200':
2283 | description: Successful response
2284 | content:
2285 | application/json: {}
2286 | /v5/account/mmp-reset:
2287 | post:
2288 | tags:
2289 | - Account
2290 | summary: reset mmp
2291 | requestBody:
2292 | content:
2293 | '*/*':
2294 | schema:
2295 | type: string
2296 | example: '"{\n \"baseCoin\": \"BTC\"\n}"'
2297 | parameters:
2298 | - name: X-BAPI-SIGN-TYPE
2299 | in: header
2300 | schema:
2301 | type: integer
2302 | example: '2'
2303 | - name: X-BAPI-SIGN
2304 | in: header
2305 | schema:
2306 | type: string
2307 | example: '{{signature}}'
2308 | - name: X-BAPI-API-KEY
2309 | in: header
2310 | schema:
2311 | type: string
2312 | example: '{{bybit-api-key}}'
2313 | - name: X-BAPI-TIMESTAMP
2314 | in: header
2315 | schema:
2316 | type: string
2317 | example: '{{timestamp}}'
2318 | - name: X-BAPI-RECV-WINDOW
2319 | in: header
2320 | schema:
2321 | type: string
2322 | example: '{{recvWindow}}'
2323 | - name: Content-Type
2324 | in: header
2325 | schema:
2326 | type: string
2327 | example: application/json
2328 | responses:
2329 | '200':
2330 | description: Successful response
2331 | content:
2332 | application/json: {}
2333 | /v5/order/disconnected-cancel-all:
2334 | post:
2335 | tags:
2336 | - Account
2337 | summary: disconnected-cancel-all
2338 | requestBody:
2339 | content:
2340 | '*/*':
2341 | schema:
2342 | type: string
2343 | example: '"{\n \"category\": \"option\",\n \"timeWindow\": 5\n}"'
2344 | parameters:
2345 | - name: X-BAPI-SIGN-TYPE
2346 | in: header
2347 | schema:
2348 | type: integer
2349 | example: '2'
2350 | - name: X-BAPI-SIGN
2351 | in: header
2352 | schema:
2353 | type: string
2354 | example: '{{signature}}'
2355 | - name: X-BAPI-API-KEY
2356 | in: header
2357 | schema:
2358 | type: string
2359 | example: '{{bybit-api-key}}'
2360 | - name: X-BAPI-TIMESTAMP
2361 | in: header
2362 | schema:
2363 | type: string
2364 | example: '{{timestamp}}'
2365 | - name: X-BAPI-RECV-WINDOW
2366 | in: header
2367 | schema:
2368 | type: string
2369 | example: '{{recvWindow}}'
2370 | - name: Content-Type
2371 | in: header
2372 | schema:
2373 | type: string
2374 | example: application/json
2375 | responses:
2376 | '200':
2377 | description: Successful response
2378 | content:
2379 | application/json: {}
2380 | /v5/account/query-dcp-info:
2381 | get:
2382 | tags:
2383 | - Account
2384 | summary: Get DCP Info
2385 | parameters:
2386 | - name: X-BAPI-SIGN-TYPE
2387 | in: header
2388 | schema:
2389 | type: integer
2390 | example: '2'
2391 | - name: X-BAPI-SIGN
2392 | in: header
2393 | schema:
2394 | type: string
2395 | example: '{{signature}}'
2396 | - name: X-BAPI-API-KEY
2397 | in: header
2398 | schema:
2399 | type: string
2400 | example: '{{bybit-api-key}}'
2401 | - name: X-BAPI-TIMESTAMP
2402 | in: header
2403 | schema:
2404 | type: string
2405 | example: '{{timestamp}}'
2406 | - name: X-BAPI-RECV-WINDOW
2407 | in: header
2408 | schema:
2409 | type: string
2410 | example: '{{recvWindow}}'
2411 | - name: Content-Type
2412 | in: header
2413 | schema:
2414 | type: string
2415 | example: application/json
2416 | responses:
2417 | '200':
2418 | description: Successful response
2419 | content:
2420 | application/json: {}
2421 | /v5/account/smp-group:
2422 | get:
2423 | tags:
2424 | - Account
2425 | summary: Get SMP Group ID
2426 | parameters:
2427 | - name: X-BAPI-SIGN-TYPE
2428 | in: header
2429 | schema:
2430 | type: integer
2431 | example: '2'
2432 | - name: X-BAPI-SIGN
2433 | in: header
2434 | schema:
2435 | type: string
2436 | example: '{{signature}}'
2437 | - name: X-BAPI-API-KEY
2438 | in: header
2439 | schema:
2440 | type: string
2441 | example: '{{bybit-api-key}}'
2442 | - name: X-BAPI-TIMESTAMP
2443 | in: header
2444 | schema:
2445 | type: string
2446 | example: '{{timestamp}}'
2447 | - name: X-BAPI-RECV-WINDOW
2448 | in: header
2449 | schema:
2450 | type: string
2451 | example: '{{recvWindow}}'
2452 | - name: Content-Type
2453 | in: header
2454 | schema:
2455 | type: string
2456 | example: application/json
2457 | responses:
2458 | '200':
2459 | description: Successful response
2460 | content:
2461 | application/json: {}
2462 | /v5/account/mmp-state:
2463 | get:
2464 | tags:
2465 | - Account
2466 | summary: Get MMP State
2467 | parameters:
2468 | - name: X-BAPI-SIGN-TYPE
2469 | in: header
2470 | schema:
2471 | type: integer
2472 | example: '2'
2473 | - name: X-BAPI-SIGN
2474 | in: header
2475 | schema:
2476 | type: string
2477 | example: '{{signature}}'
2478 | - name: X-BAPI-API-KEY
2479 | in: header
2480 | schema:
2481 | type: string
2482 | example: '{{bybit-api-key}}'
2483 | - name: X-BAPI-TIMESTAMP
2484 | in: header
2485 | schema:
2486 | type: string
2487 | example: '{{timestamp}}'
2488 | - name: X-BAPI-RECV-WINDOW
2489 | in: header
2490 | schema:
2491 | type: string
2492 | example: '{{recvWindow}}'
2493 | - name: Content-Type
2494 | in: header
2495 | schema:
2496 | type: string
2497 | example: application/json
2498 | responses:
2499 | '200':
2500 | description: Successful response
2501 | content:
2502 | application/json: {}
2503 | /v5/pre-upgrade/order/history:
2504 | get:
2505 | tags:
2506 | - Pre-Uprgade
2507 | summary: Get Pre-upgrade Order History
2508 | parameters:
2509 | - name: X-BAPI-SIGN-TYPE
2510 | in: header
2511 | schema:
2512 | type: integer
2513 | example: '2'
2514 | - name: X-BAPI-SIGN
2515 | in: header
2516 | schema:
2517 | type: string
2518 | example: '{{signature}}'
2519 | - name: X-BAPI-API-KEY
2520 | in: header
2521 | schema:
2522 | type: string
2523 | example: '{{bybit-api-key}}'
2524 | - name: X-BAPI-TIMESTAMP
2525 | in: header
2526 | schema:
2527 | type: string
2528 | example: '{{timestamp}}'
2529 | - name: X-BAPI-RECV-WINDOW
2530 | in: header
2531 | schema:
2532 | type: string
2533 | example: '{{recvWindow}}'
2534 | - name: Content-Type
2535 | in: header
2536 | schema:
2537 | type: string
2538 | example: application/json
2539 | - name: category
2540 | in: query
2541 | schema:
2542 | type: string
2543 | example: spot
2544 | - name: orderStatus
2545 | in: query
2546 | schema:
2547 | type: string
2548 | example: Created
2549 | responses:
2550 | '200':
2551 | description: Successful response
2552 | content:
2553 | application/json: {}
2554 | /v5/pre-upgrade/execution/list:
2555 | get:
2556 | tags:
2557 | - Pre-Uprgade
2558 | summary: Get Pre-upgrade Trade History
2559 | parameters:
2560 | - name: X-BAPI-SIGN-TYPE
2561 | in: header
2562 | schema:
2563 | type: integer
2564 | example: '2'
2565 | - name: X-BAPI-SIGN
2566 | in: header
2567 | schema:
2568 | type: string
2569 | example: '{{signature}}'
2570 | - name: X-BAPI-API-KEY
2571 | in: header
2572 | schema:
2573 | type: string
2574 | example: '{{bybit-api-key}}'
2575 | - name: X-BAPI-TIMESTAMP
2576 | in: header
2577 | schema:
2578 | type: string
2579 | example: '{{timestamp}}'
2580 | - name: X-BAPI-RECV-WINDOW
2581 | in: header
2582 | schema:
2583 | type: string
2584 | example: '{{recvWindow}}'
2585 | - name: Content-Type
2586 | in: header
2587 | schema:
2588 | type: string
2589 | example: application/json
2590 | - name: category
2591 | in: query
2592 | schema:
2593 | type: string
2594 | example: linear
2595 | - name: limit
2596 | in: query
2597 | schema:
2598 | type: integer
2599 | example: '1'
2600 | - name: execType
2601 | in: query
2602 | schema:
2603 | type: string
2604 | example: Funding
2605 | - name: symbol
2606 | in: query
2607 | schema:
2608 | type: string
2609 | example: BTCUSDT
2610 | responses:
2611 | '200':
2612 | description: Successful response
2613 | content:
2614 | application/json: {}
2615 | /v5/pre-upgrade/account/transaction-log:
2616 | get:
2617 | tags:
2618 | - Pre-Uprgade
2619 | summary: Get Pre-upgrade Transaction Log
2620 | parameters:
2621 | - name: X-BAPI-SIGN-TYPE
2622 | in: header
2623 | schema:
2624 | type: integer
2625 | example: '2'
2626 | - name: X-BAPI-SIGN
2627 | in: header
2628 | schema:
2629 | type: string
2630 | example: '{{signature}}'
2631 | - name: X-BAPI-API-KEY
2632 | in: header
2633 | schema:
2634 | type: string
2635 | example: '{{bybit-api-key}}'
2636 | - name: X-BAPI-TIMESTAMP
2637 | in: header
2638 | schema:
2639 | type: string
2640 | example: '{{timestamp}}'
2641 | - name: X-BAPI-RECV-WINDOW
2642 | in: header
2643 | schema:
2644 | type: string
2645 | example: '{{recvWindow}}'
2646 | - name: Content-Type
2647 | in: header
2648 | schema:
2649 | type: string
2650 | example: application/json
2651 | - name: category
2652 | in: query
2653 | schema:
2654 | type: string
2655 | example: option
2656 | responses:
2657 | '200':
2658 | description: Successful response
2659 | content:
2660 | application/json: {}
2661 | /v5/pre-upgrade/position/closed-pnl:
2662 | get:
2663 | tags:
2664 | - Pre-Uprgade
2665 | summary: Get Pre-upgrade close pnl
2666 | parameters:
2667 | - name: X-BAPI-SIGN-TYPE
2668 | in: header
2669 | schema:
2670 | type: integer
2671 | example: '2'
2672 | - name: X-BAPI-SIGN
2673 | in: header
2674 | schema:
2675 | type: string
2676 | example: '{{signature}}'
2677 | - name: X-BAPI-API-KEY
2678 | in: header
2679 | schema:
2680 | type: string
2681 | example: '{{bybit-api-key}}'
2682 | - name: X-BAPI-TIMESTAMP
2683 | in: header
2684 | schema:
2685 | type: string
2686 | example: '{{timestamp}}'
2687 | - name: X-BAPI-RECV-WINDOW
2688 | in: header
2689 | schema:
2690 | type: string
2691 | example: '{{recvWindow}}'
2692 | - name: Content-Type
2693 | in: header
2694 | schema:
2695 | type: string
2696 | example: application/json
2697 | - name: category
2698 | in: query
2699 | schema:
2700 | type: string
2701 | example: linear
2702 | - name: symbol
2703 | in: query
2704 | schema:
2705 | type: string
2706 | example: BTCUSDT
2707 | responses:
2708 | '200':
2709 | description: Successful response
2710 | content:
2711 | application/json: {}
2712 | /v5/pre-upgrade/asset/delivery-record:
2713 | get:
2714 | tags:
2715 | - Pre-Uprgade
2716 | summary: Get Pre-upgrade Option Delivery Record
2717 | parameters:
2718 | - name: X-BAPI-SIGN-TYPE
2719 | in: header
2720 | schema:
2721 | type: integer
2722 | example: '2'
2723 | - name: X-BAPI-SIGN
2724 | in: header
2725 | schema:
2726 | type: string
2727 | example: '{{signature}}'
2728 | - name: X-BAPI-API-KEY
2729 | in: header
2730 | schema:
2731 | type: string
2732 | example: '{{bybit-api-key}}'
2733 | - name: X-BAPI-TIMESTAMP
2734 | in: header
2735 | schema:
2736 | type: string
2737 | example: '{{timestamp}}'
2738 | - name: X-BAPI-RECV-WINDOW
2739 | in: header
2740 | schema:
2741 | type: string
2742 | example: '{{recvWindow}}'
2743 | - name: Content-Type
2744 | in: header
2745 | schema:
2746 | type: string
2747 | example: application/json
2748 | - name: category
2749 | in: query
2750 | schema:
2751 | type: string
2752 | example: option
2753 | responses:
2754 | '200':
2755 | description: Successful response
2756 | content:
2757 | application/json: {}
2758 | /v5/pre-upgrade/asset/settlement-record:
2759 | get:
2760 | tags:
2761 | - Pre-Uprgade
2762 | summary: Get Pre-upgrade USDC Session Settlement
2763 | parameters:
2764 | - name: X-BAPI-SIGN-TYPE
2765 | in: header
2766 | schema:
2767 | type: integer
2768 | example: '2'
2769 | - name: X-BAPI-SIGN
2770 | in: header
2771 | schema:
2772 | type: string
2773 | example: '{{signature}}'
2774 | - name: X-BAPI-API-KEY
2775 | in: header
2776 | schema:
2777 | type: string
2778 | example: '{{bybit-api-key}}'
2779 | - name: X-BAPI-TIMESTAMP
2780 | in: header
2781 | schema:
2782 | type: string
2783 | example: '{{timestamp}}'
2784 | - name: X-BAPI-RECV-WINDOW
2785 | in: header
2786 | schema:
2787 | type: string
2788 | example: '{{recvWindow}}'
2789 | - name: Content-Type
2790 | in: header
2791 | schema:
2792 | type: string
2793 | example: application/json
2794 | - name: category
2795 | in: query
2796 | schema:
2797 | type: string
2798 | example: linear
2799 | - name: symbol
2800 | in: query
2801 | schema:
2802 | type: string
2803 | example: ETHPERP
2804 | - name: limit
2805 | in: query
2806 | schema:
2807 | type: integer
2808 | example: '1'
2809 | responses:
2810 | '200':
2811 | description: Successful response
2812 | content:
2813 | application/json: {}
2814 | /v5/asset/exchange/query-coin-list:
2815 | get:
2816 | tags:
2817 | - Asset > Convert
2818 | summary: get convert coin list
2819 | parameters:
2820 | - name: X-BAPI-SIGN-TYPE
2821 | in: header
2822 | schema:
2823 | type: integer
2824 | example: '2'
2825 | - name: X-BAPI-SIGN
2826 | in: header
2827 | schema:
2828 | type: string
2829 | example: '{{signature}}'
2830 | - name: X-BAPI-API-KEY
2831 | in: header
2832 | schema:
2833 | type: string
2834 | example: '{{bybit-api-key}}'
2835 | - name: X-BAPI-TIMESTAMP
2836 | in: header
2837 | schema:
2838 | type: string
2839 | example: '{{timestamp}}'
2840 | - name: X-BAPI-RECV-WINDOW
2841 | in: header
2842 | schema:
2843 | type: string
2844 | example: '{{recvWindow}}'
2845 | - name: Content-Type
2846 | in: header
2847 | schema:
2848 | type: string
2849 | example: application/json
2850 | - name: coin
2851 | in: query
2852 | schema:
2853 | type: string
2854 | example: BTC
2855 | - name: accountType
2856 | in: query
2857 | schema:
2858 | type: string
2859 | example: eb_convert_uta
2860 | responses:
2861 | '200':
2862 | description: Successful response
2863 | content:
2864 | application/json: {}
2865 | /v5/asset/exchange/convert-result-query:
2866 | get:
2867 | tags:
2868 | - Asset > Convert
2869 | summary: Get Convert Status
2870 | parameters:
2871 | - name: X-BAPI-SIGN-TYPE
2872 | in: header
2873 | schema:
2874 | type: integer
2875 | example: '2'
2876 | - name: X-BAPI-SIGN
2877 | in: header
2878 | schema:
2879 | type: string
2880 | example: '{{signature}}'
2881 | - name: X-BAPI-API-KEY
2882 | in: header
2883 | schema:
2884 | type: string
2885 | example: '{{bybit-api-key}}'
2886 | - name: X-BAPI-TIMESTAMP
2887 | in: header
2888 | schema:
2889 | type: string
2890 | example: '{{timestamp}}'
2891 | - name: X-BAPI-RECV-WINDOW
2892 | in: header
2893 | schema:
2894 | type: string
2895 | example: '{{recvWindow}}'
2896 | - name: Content-Type
2897 | in: header
2898 | schema:
2899 | type: string
2900 | example: application/json
2901 | - name: quoteTxId
2902 | in: query
2903 | schema:
2904 | type: integer
2905 | example: '10100223252423685843314909184'
2906 | responses:
2907 | '200':
2908 | description: Successful response
2909 | content:
2910 | application/json: {}
2911 | /v5/asset/exchange/query-convert-history:
2912 | get:
2913 | tags:
2914 | - Asset > Convert
2915 | summary: Get Convert history
2916 | parameters:
2917 | - name: X-BAPI-SIGN-TYPE
2918 | in: header
2919 | schema:
2920 | type: integer
2921 | example: '2'
2922 | - name: X-BAPI-SIGN
2923 | in: header
2924 | schema:
2925 | type: string
2926 | example: '{{signature}}'
2927 | - name: X-BAPI-API-KEY
2928 | in: header
2929 | schema:
2930 | type: string
2931 | example: '{{bybit-api-key}}'
2932 | - name: X-BAPI-TIMESTAMP
2933 | in: header
2934 | schema:
2935 | type: string
2936 | example: '{{timestamp}}'
2937 | - name: X-BAPI-RECV-WINDOW
2938 | in: header
2939 | schema:
2940 | type: string
2941 | example: '{{recvWindow}}'
2942 | - name: Content-Type
2943 | in: header
2944 | schema:
2945 | type: string
2946 | example: application/json
2947 | responses:
2948 | '200':
2949 | description: Successful response
2950 | content:
2951 | application/json: {}
2952 | /v5/asset/exchange/quote-apply:
2953 | post:
2954 | tags:
2955 | - Asset > Convert
2956 | summary: Request a Quote
2957 | requestBody:
2958 | content:
2959 | application/json:
2960 | schema:
2961 | type: object
2962 | example:
2963 | fromCoin: BTC
2964 | toCoin: ETH
2965 | accountType: eb_convert_uta
2966 | requestCoin: BTC
2967 | requestAmount: '1'
2968 | parameters:
2969 | - name: X-BAPI-SIGN-TYPE
2970 | in: header
2971 | schema:
2972 | type: integer
2973 | example: '2'
2974 | - name: X-BAPI-SIGN
2975 | in: header
2976 | schema:
2977 | type: string
2978 | example: '{{signature}}'
2979 | - name: X-BAPI-API-KEY
2980 | in: header
2981 | schema:
2982 | type: string
2983 | example: '{{bybit-api-key}}'
2984 | - name: X-BAPI-TIMESTAMP
2985 | in: header
2986 | schema:
2987 | type: string
2988 | example: '{{timestamp}}'
2989 | - name: X-BAPI-RECV-WINDOW
2990 | in: header
2991 | schema:
2992 | type: string
2993 | example: '{{recvWindow}}'
2994 | - name: Content-Type
2995 | in: header
2996 | schema:
2997 | type: string
2998 | example: application/json
2999 | responses:
3000 | '200':
3001 | description: Successful response
3002 | content:
3003 | application/json: {}
3004 | /v5/asset/exchange/convert-execute:
3005 | post:
3006 | tags:
3007 | - Asset > Convert
3008 | summary: Confirm Quote
3009 | requestBody:
3010 | content:
3011 | application/json:
3012 | schema:
3013 | type: object
3014 | example:
3015 | quoteTxId: '10102225215434451987621355520'
3016 | parameters:
3017 | - name: X-BAPI-SIGN-TYPE
3018 | in: header
3019 | schema:
3020 | type: integer
3021 | example: '2'
3022 | - name: X-BAPI-SIGN
3023 | in: header
3024 | schema:
3025 | type: string
3026 | example: '{{signature}}'
3027 | - name: X-BAPI-API-KEY
3028 | in: header
3029 | schema:
3030 | type: string
3031 | example: '{{bybit-api-key}}'
3032 | - name: X-BAPI-TIMESTAMP
3033 | in: header
3034 | schema:
3035 | type: string
3036 | example: '{{timestamp}}'
3037 | - name: X-BAPI-RECV-WINDOW
3038 | in: header
3039 | schema:
3040 | type: string
3041 | example: '{{recvWindow}}'
3042 | - name: Content-Type
3043 | in: header
3044 | schema:
3045 | type: string
3046 | example: application/json
3047 | responses:
3048 | '200':
3049 | description: Successful response
3050 | content:
3051 | application/json: {}
3052 | /v5/asset/transfer/query-account-coin-balance:
3053 | get:
3054 | tags:
3055 | - Asset > Balance
3056 | summary: transfer/query-account-coin-balance
3057 | parameters:
3058 | - name: X-BAPI-SIGN-TYPE
3059 | in: header
3060 | schema:
3061 | type: integer
3062 | example: '2'
3063 | - name: X-BAPI-SIGN
3064 | in: header
3065 | schema:
3066 | type: string
3067 | example: '{{signature}}'
3068 | - name: X-BAPI-API-KEY
3069 | in: header
3070 | schema:
3071 | type: string
3072 | example: '{{bybit-api-key}}'
3073 | - name: X-BAPI-TIMESTAMP
3074 | in: header
3075 | schema:
3076 | type: string
3077 | example: '{{timestamp}}'
3078 | - name: X-BAPI-RECV-WINDOW
3079 | in: header
3080 | schema:
3081 | type: string
3082 | example: '{{recvWindow}}'
3083 | - name: Content-Type
3084 | in: header
3085 | schema:
3086 | type: string
3087 | example: application/json
3088 | - name: accountType
3089 | in: query
3090 | schema:
3091 | type: string
3092 | example: SPOT
3093 | - name: coin
3094 | in: query
3095 | schema:
3096 | type: string
3097 | example: USDT
3098 | responses:
3099 | '200':
3100 | description: Successful response
3101 | content:
3102 | application/json: {}
3103 | /v5/asset/transfer/query-account-coins-balance:
3104 | get:
3105 | tags:
3106 | - Asset > Balance
3107 | summary: transfer/query-account-coins-balance
3108 | parameters:
3109 | - name: X-BAPI-SIGN-TYPE
3110 | in: header
3111 | schema:
3112 | type: integer
3113 | example: '2'
3114 | - name: X-BAPI-SIGN
3115 | in: header
3116 | schema:
3117 | type: string
3118 | example: '{{signature}}'
3119 | - name: X-BAPI-API-KEY
3120 | in: header
3121 | schema:
3122 | type: string
3123 | example: '{{bybit-api-key}}'
3124 | - name: X-BAPI-TIMESTAMP
3125 | in: header
3126 | schema:
3127 | type: string
3128 | example: '{{timestamp}}'
3129 | - name: X-BAPI-RECV-WINDOW
3130 | in: header
3131 | schema:
3132 | type: string
3133 | example: '{{recvWindow}}'
3134 | - name: Content-Type
3135 | in: header
3136 | schema:
3137 | type: string
3138 | example: application/json
3139 | - name: accountType
3140 | in: query
3141 | schema:
3142 | type: string
3143 | example: SPOT
3144 | responses:
3145 | '200':
3146 | description: Successful response
3147 | content:
3148 | application/json: {}
3149 | /v5/asset/withdraw/withdrawable-amount:
3150 | get:
3151 | tags:
3152 | - Asset > Balance
3153 | summary: Get Withdrawable Amount
3154 | parameters:
3155 | - name: X-BAPI-SIGN-TYPE
3156 | in: header
3157 | schema:
3158 | type: integer
3159 | example: '2'
3160 | - name: X-BAPI-SIGN
3161 | in: header
3162 | schema:
3163 | type: string
3164 | example: '{{signature}}'
3165 | - name: X-BAPI-API-KEY
3166 | in: header
3167 | schema:
3168 | type: string
3169 | example: '{{bybit-api-key}}'
3170 | - name: X-BAPI-TIMESTAMP
3171 | in: header
3172 | schema:
3173 | type: string
3174 | example: '{{timestamp}}'
3175 | - name: X-BAPI-RECV-WINDOW
3176 | in: header
3177 | schema:
3178 | type: string
3179 | example: '{{recvWindow}}'
3180 | - name: Content-Type
3181 | in: header
3182 | schema:
3183 | type: string
3184 | example: application/json
3185 | - name: coin
3186 | in: query
3187 | schema:
3188 | type: string
3189 | example: USDT
3190 | responses:
3191 | '200':
3192 | description: Successful response
3193 | content:
3194 | application/json: {}
3195 | /v5/asset/transfer/query-asset-info:
3196 | get:
3197 | tags:
3198 | - Asset > Balance
3199 | summary: transfer/query-asset-info Copy
3200 | parameters:
3201 | - name: X-BAPI-SIGN-TYPE
3202 | in: header
3203 | schema:
3204 | type: integer
3205 | example: '2'
3206 | - name: X-BAPI-SIGN
3207 | in: header
3208 | schema:
3209 | type: string
3210 | example: '{{signature}}'
3211 | - name: X-BAPI-API-KEY
3212 | in: header
3213 | schema:
3214 | type: string
3215 | example: '{{bybit-api-key}}'
3216 | - name: X-BAPI-TIMESTAMP
3217 | in: header
3218 | schema:
3219 | type: string
3220 | example: '{{timestamp}}'
3221 | - name: X-BAPI-RECV-WINDOW
3222 | in: header
3223 | schema:
3224 | type: string
3225 | example: '{{recvWindow}}'
3226 | - name: Content-Type
3227 | in: header
3228 | schema:
3229 | type: string
3230 | example: application/json
3231 | - name: accountType
3232 | in: query
3233 | schema:
3234 | type: string
3235 | example: SPOT
3236 | responses:
3237 | '200':
3238 | description: Successful response
3239 | content:
3240 | application/json: {}
3241 | /v5/asset/transfer/query-sub-member-list:
3242 | get:
3243 | tags:
3244 | - Asset
3245 | summary: Get Sub UID
3246 | parameters:
3247 | - name: X-BAPI-SIGN-TYPE
3248 | in: header
3249 | schema:
3250 | type: integer
3251 | example: '2'
3252 | - name: X-BAPI-SIGN
3253 | in: header
3254 | schema:
3255 | type: string
3256 | example: '{{signature}}'
3257 | - name: X-BAPI-API-KEY
3258 | in: header
3259 | schema:
3260 | type: string
3261 | example: '{{bybit-api-key}}'
3262 | - name: X-BAPI-TIMESTAMP
3263 | in: header
3264 | schema:
3265 | type: string
3266 | example: '{{timestamp}}'
3267 | - name: X-BAPI-RECV-WINDOW
3268 | in: header
3269 | schema:
3270 | type: string
3271 | example: '{{recvWindow}}'
3272 | - name: Content-Type
3273 | in: header
3274 | schema:
3275 | type: string
3276 | example: application/json
3277 | responses:
3278 | '200':
3279 | description: Successful response
3280 | content:
3281 | application/json: {}
3282 | /v5/asset/transfer/query-inter-transfer-list:
3283 | get:
3284 | tags:
3285 | - Asset > Transfer
3286 | summary: transfer/query-inter-transfer-list
3287 | parameters:
3288 | - name: X-BAPI-SIGN-TYPE
3289 | in: header
3290 | schema:
3291 | type: integer
3292 | example: '2'
3293 | - name: X-BAPI-SIGN
3294 | in: header
3295 | schema:
3296 | type: string
3297 | example: '{{signature}}'
3298 | - name: X-BAPI-API-KEY
3299 | in: header
3300 | schema:
3301 | type: string
3302 | example: '{{bybit-api-key}}'
3303 | - name: X-BAPI-TIMESTAMP
3304 | in: header
3305 | schema:
3306 | type: string
3307 | example: '{{timestamp}}'
3308 | - name: X-BAPI-RECV-WINDOW
3309 | in: header
3310 | schema:
3311 | type: string
3312 | example: '{{recvWindow}}'
3313 | - name: Content-Type
3314 | in: header
3315 | schema:
3316 | type: string
3317 | example: application/json
3318 | responses:
3319 | '200':
3320 | description: Successful response
3321 | content:
3322 | application/json: {}
3323 | /v5/asset/transfer/query-universal-transfer-list:
3324 | get:
3325 | tags:
3326 | - Asset > Transfer
3327 | summary: transfer/query-universal-transfer-list
3328 | parameters:
3329 | - name: X-BAPI-SIGN-TYPE
3330 | in: header
3331 | schema:
3332 | type: integer
3333 | example: '2'
3334 | - name: X-BAPI-SIGN
3335 | in: header
3336 | schema:
3337 | type: string
3338 | example: '{{signature}}'
3339 | - name: X-BAPI-API-KEY
3340 | in: header
3341 | schema:
3342 | type: string
3343 | example: '{{bybit-api-key}}'
3344 | - name: X-BAPI-TIMESTAMP
3345 | in: header
3346 | schema:
3347 | type: string
3348 | example: '{{timestamp}}'
3349 | - name: X-BAPI-RECV-WINDOW
3350 | in: header
3351 | schema:
3352 | type: string
3353 | example: '{{recvWindow}}'
3354 | - name: Content-Type
3355 | in: header
3356 | schema:
3357 | type: string
3358 | example: application/json
3359 | responses:
3360 | '200':
3361 | description: Successful response
3362 | content:
3363 | application/json: {}
3364 | /v5/asset/transfer/save-transfer-sub-member:
3365 | post:
3366 | tags:
3367 | - Asset > Transfer
3368 | summary: transfer/save-transfer-sub-member
3369 | requestBody:
3370 | content:
3371 | application/json:
3372 | schema:
3373 | type: object
3374 | example:
3375 | subMemberIds: '4255068'
3376 | parameters:
3377 | - name: X-BAPI-SIGN-TYPE
3378 | in: header
3379 | schema:
3380 | type: integer
3381 | example: '2'
3382 | - name: X-BAPI-SIGN
3383 | in: header
3384 | schema:
3385 | type: string
3386 | example: '{{signature}}'
3387 | - name: X-BAPI-API-KEY
3388 | in: header
3389 | schema:
3390 | type: string
3391 | example: '{{bybit-api-key}}'
3392 | - name: X-BAPI-TIMESTAMP
3393 | in: header
3394 | schema:
3395 | type: string
3396 | example: '{{timestamp}}'
3397 | - name: X-BAPI-RECV-WINDOW
3398 | in: header
3399 | schema:
3400 | type: string
3401 | example: '{{recvWindow}}'
3402 | - name: Content-Type
3403 | in: header
3404 | schema:
3405 | type: string
3406 | example: application/json
3407 | responses:
3408 | '200':
3409 | description: Successful response
3410 | content:
3411 | application/json: {}
3412 | /v5/asset/transfer/query-transfer-coin-list:
3413 | get:
3414 | tags:
3415 | - Asset > Transfer
3416 | summary: transfer/query-transfer-coin-list
3417 | parameters:
3418 | - name: Content-Type
3419 | in: header
3420 | schema:
3421 | type: string
3422 | example: application/json
3423 | - name: X-BAPI-SIGN-TYPE
3424 | in: header
3425 | schema:
3426 | type: integer
3427 | example: '2'
3428 | - name: X-BAPI-SIGN
3429 | in: header
3430 | schema:
3431 | type: string
3432 | example: '{{signature}}'
3433 | - name: X-BAPI-API-KEY
3434 | in: header
3435 | schema:
3436 | type: string
3437 | example: '{{bybit-api-key}}'
3438 | - name: X-BAPI-TIMESTAMP
3439 | in: header
3440 | schema:
3441 | type: string
3442 | example: '{{timestamp}}'
3443 | - name: X-BAPI-RECV-WINDOW
3444 | in: header
3445 | schema:
3446 | type: string
3447 | example: '{{recvWindow}}'
3448 | - name: fromAccountType
3449 | in: query
3450 | schema:
3451 | type: string
3452 | example: SPOT
3453 | - name: toAccountType
3454 | in: query
3455 | schema:
3456 | type: string
3457 | example: CONTRACT
3458 | responses:
3459 | '200':
3460 | description: Successful response
3461 | content:
3462 | application/json: {}
3463 | /v5/asset/transfer/inter-transfer:
3464 | post:
3465 | tags:
3466 | - Asset > Transfer
3467 | summary: transfer/inter-transfer
3468 | requestBody:
3469 | content:
3470 | application/json:
3471 | schema:
3472 | type: object
3473 | example:
3474 | fromAccountType: UNIFIED
3475 | toAccountType: SPOT
3476 | amount: '1'
3477 | coin: USDT
3478 | transferId: 11ff9b44-2d5d-4293-913d-4597c9ad2188
3479 | parameters:
3480 | - name: X-BAPI-SIGN-TYPE
3481 | in: header
3482 | schema:
3483 | type: integer
3484 | example: '2'
3485 | - name: X-BAPI-SIGN
3486 | in: header
3487 | schema:
3488 | type: string
3489 | example: '{{signature}}'
3490 | - name: X-BAPI-API-KEY
3491 | in: header
3492 | schema:
3493 | type: string
3494 | example: '{{bybit-api-key}}'
3495 | - name: X-BAPI-TIMESTAMP
3496 | in: header
3497 | schema:
3498 | type: string
3499 | example: '{{timestamp}}'
3500 | - name: X-BAPI-RECV-WINDOW
3501 | in: header
3502 | schema:
3503 | type: string
3504 | example: '{{recvWindow}}'
3505 | - name: Content-Type
3506 | in: header
3507 | schema:
3508 | type: string
3509 | example: application/json
3510 | responses:
3511 | '200':
3512 | description: Successful response
3513 | content:
3514 | application/json: {}
3515 | /v5/asset/transfer/universal-transfer:
3516 | post:
3517 | tags:
3518 | - Asset > Transfer
3519 | summary: transfer/universal-transfer
3520 | requestBody:
3521 | content:
3522 | application/json:
3523 | schema:
3524 | type: object
3525 | example:
3526 | fromAccountType: UNIFIED
3527 | toAccountType: USDC
3528 | amount: '5000'
3529 | coin: USDC
3530 | transfer_id: 72b41935-3174-c52d-85d1-7329df0cb636
3531 | from_member_id: '290118'
3532 | to_member_id: '1135134'
3533 | parameters:
3534 | - name: X-BAPI-SIGN-TYPE
3535 | in: header
3536 | schema:
3537 | type: integer
3538 | example: '2'
3539 | - name: X-BAPI-SIGN
3540 | in: header
3541 | schema:
3542 | type: string
3543 | example: '{{signature}}'
3544 | - name: X-BAPI-API-KEY
3545 | in: header
3546 | schema:
3547 | type: string
3548 | example: '{{bybit-api-key}}'
3549 | - name: X-BAPI-TIMESTAMP
3550 | in: header
3551 | schema:
3552 | type: string
3553 | example: '{{timestamp}}'
3554 | - name: X-BAPI-RECV-WINDOW
3555 | in: header
3556 | schema:
3557 | type: string
3558 | example: '{{recvWindow}}'
3559 | - name: Content-Type
3560 | in: header
3561 | schema:
3562 | type: string
3563 | example: application/json
3564 | responses:
3565 | '200':
3566 | description: Successful response
3567 | content:
3568 | application/json: {}
3569 | /v5/asset/deposit/query-address:
3570 | get:
3571 | tags:
3572 | - Asset > Deposit
3573 | summary: deposit/query-address
3574 | parameters:
3575 | - name: X-BAPI-SIGN-TYPE
3576 | in: header
3577 | schema:
3578 | type: integer
3579 | example: '2'
3580 | - name: X-BAPI-SIGN
3581 | in: header
3582 | schema:
3583 | type: string
3584 | example: '{{signature}}'
3585 | - name: X-BAPI-API-KEY
3586 | in: header
3587 | schema:
3588 | type: string
3589 | example: '{{bybit-api-key}}'
3590 | - name: X-BAPI-TIMESTAMP
3591 | in: header
3592 | schema:
3593 | type: string
3594 | example: '{{timestamp}}'
3595 | - name: X-BAPI-RECV-WINDOW
3596 | in: header
3597 | schema:
3598 | type: string
3599 | example: '{{recvWindow}}'
3600 | - name: Content-Type
3601 | in: header
3602 | schema:
3603 | type: string
3604 | example: application/json
3605 | - name: coin
3606 | in: query
3607 | schema:
3608 | type: string
3609 | example: BTC
3610 | responses:
3611 | '200':
3612 | description: Successful response
3613 | content:
3614 | application/json: {}
3615 | /v5/asset/deposit/query-allowed-list:
3616 | get:
3617 | tags:
3618 | - Asset > Deposit
3619 | summary: deposit/query-allowed-list
3620 | responses:
3621 | '200':
3622 | description: Successful response
3623 | content:
3624 | application/json: {}
3625 | /v5/asset/deposit/query-record:
3626 | get:
3627 | tags:
3628 | - Asset > Deposit
3629 | summary: deposit/query-record
3630 | parameters:
3631 | - name: X-BAPI-SIGN-TYPE
3632 | in: header
3633 | schema:
3634 | type: integer
3635 | example: '2'
3636 | - name: X-BAPI-SIGN
3637 | in: header
3638 | schema:
3639 | type: string
3640 | example: '{{signature}}'
3641 | - name: X-BAPI-API-KEY
3642 | in: header
3643 | schema:
3644 | type: string
3645 | example: '{{bybit-api-key}}'
3646 | - name: X-BAPI-TIMESTAMP
3647 | in: header
3648 | schema:
3649 | type: string
3650 | example: '{{timestamp}}'
3651 | - name: X-BAPI-RECV-WINDOW
3652 | in: header
3653 | schema:
3654 | type: string
3655 | example: '{{recvWindow}}'
3656 | - name: Content-Type
3657 | in: header
3658 | schema:
3659 | type: string
3660 | example: application/json
3661 | responses:
3662 | '200':
3663 | description: Successful response
3664 | content:
3665 | application/json: {}
3666 | /v5/asset/deposit/query-sub-member-address:
3667 | get:
3668 | tags:
3669 | - Asset > Deposit
3670 | summary: deposit/query-sub-member-address
3671 | parameters:
3672 | - name: coin
3673 | in: query
3674 | schema:
3675 | type: string
3676 | example: BTC
3677 | - name: chainType
3678 | in: query
3679 | schema:
3680 | type: string
3681 | example: BTC
3682 | - name: subMemberId
3683 | in: query
3684 | schema:
3685 | type: integer
3686 | example: '4255068'
3687 | responses:
3688 | '200':
3689 | description: Successful response
3690 | content:
3691 | application/json: {}
3692 | /v5/asset/deposit/query-sub-member-record:
3693 | get:
3694 | tags:
3695 | - Asset > Deposit
3696 | summary: deposit/query-sub-member-record
3697 | parameters:
3698 | - name: X-BAPI-SIGN-TYPE
3699 | in: header
3700 | schema:
3701 | type: integer
3702 | example: '2'
3703 | - name: X-BAPI-SIGN
3704 | in: header
3705 | schema:
3706 | type: string
3707 | example: '{{signature}}'
3708 | - name: X-BAPI-API-KEY
3709 | in: header
3710 | schema:
3711 | type: string
3712 | example: '{{bybit-api-key}}'
3713 | - name: X-BAPI-TIMESTAMP
3714 | in: header
3715 | schema:
3716 | type: string
3717 | example: '{{timestamp}}'
3718 | - name: X-BAPI-RECV-WINDOW
3719 | in: header
3720 | schema:
3721 | type: string
3722 | example: '{{recvWindow}}'
3723 | - name: Content-Type
3724 | in: header
3725 | schema:
3726 | type: string
3727 | example: application/json
3728 | - name: subMemberId
3729 | in: query
3730 | schema:
3731 | type: integer
3732 | example: '4255068'
3733 | responses:
3734 | '200':
3735 | description: Successful response
3736 | content:
3737 | application/json: {}
3738 | /v5/asset/withdraw/query-record:
3739 | get:
3740 | tags:
3741 | - Asset > Withdraw
3742 | summary: withdraw/query-record
3743 | parameters:
3744 | - name: X-BAPI-SIGN-TYPE
3745 | in: header
3746 | schema:
3747 | type: integer
3748 | example: '2'
3749 | - name: X-BAPI-SIGN
3750 | in: header
3751 | schema:
3752 | type: string
3753 | example: '{{signature}}'
3754 | - name: X-BAPI-API-KEY
3755 | in: header
3756 | schema:
3757 | type: string
3758 | example: '{{bybit-api-key}}'
3759 | - name: X-BAPI-TIMESTAMP
3760 | in: header
3761 | schema:
3762 | type: string
3763 | example: '{{timestamp}}'
3764 | - name: X-BAPI-RECV-WINDOW
3765 | in: header
3766 | schema:
3767 | type: string
3768 | example: '{{recvWindow}}'
3769 | - name: Content-Type
3770 | in: header
3771 | schema:
3772 | type: string
3773 | example: application/json
3774 | responses:
3775 | '200':
3776 | description: Successful response
3777 | content:
3778 | application/json: {}
3779 | /v5/asset/withdraw/create:
3780 | post:
3781 | tags:
3782 | - Asset > Withdraw
3783 | summary: withdraw/create
3784 | requestBody:
3785 | content:
3786 | application/json:
3787 | schema:
3788 | type: object
3789 | example:
3790 | chain: BTC
3791 | coin: BTC
3792 | address: n3Hy3vwUY1sqbXhvFbaCbtoM2ZnbSnqa1J
3793 | amount: '0.0213'
3794 | parameters:
3795 | - name: X-BAPI-SIGN-TYPE
3796 | in: header
3797 | schema:
3798 | type: integer
3799 | example: '2'
3800 | - name: X-BAPI-SIGN
3801 | in: header
3802 | schema:
3803 | type: string
3804 | example: '{{signature}}'
3805 | - name: X-BAPI-API-KEY
3806 | in: header
3807 | schema:
3808 | type: string
3809 | example: '{{bybit-api-key}}'
3810 | - name: X-BAPI-TIMESTAMP
3811 | in: header
3812 | schema:
3813 | type: string
3814 | example: '{{timestamp}}'
3815 | - name: X-BAPI-RECV-WINDOW
3816 | in: header
3817 | schema:
3818 | type: string
3819 | example: '{{recvWindow}}'
3820 | - name: Content-Type
3821 | in: header
3822 | schema:
3823 | type: string
3824 | example: application/json
3825 | responses:
3826 | '200':
3827 | description: Successful response
3828 | content:
3829 | application/json: {}
3830 | /v5/asset/withdraw/cancel:
3831 | post:
3832 | tags:
3833 | - Asset > Withdraw
3834 | summary: withdraw/cancel
3835 | requestBody:
3836 | content:
3837 | application/json:
3838 | schema:
3839 | type: object
3840 | example:
3841 | id: 36604
3842 | parameters:
3843 | - name: X-BAPI-SIGN-TYPE
3844 | in: header
3845 | schema:
3846 | type: integer
3847 | example: '2'
3848 | - name: X-BAPI-SIGN
3849 | in: header
3850 | schema:
3851 | type: string
3852 | example: '{{signature}}'
3853 | - name: X-BAPI-API-KEY
3854 | in: header
3855 | schema:
3856 | type: string
3857 | example: '{{bybit-api-key}}'
3858 | - name: X-BAPI-TIMESTAMP
3859 | in: header
3860 | schema:
3861 | type: string
3862 | example: '{{timestamp}}'
3863 | - name: X-BAPI-RECV-WINDOW
3864 | in: header
3865 | schema:
3866 | type: string
3867 | example: '{{recvWindow}}'
3868 | - name: Content-Type
3869 | in: header
3870 | schema:
3871 | type: string
3872 | example: application/json
3873 | responses:
3874 | '200':
3875 | description: Successful response
3876 | content:
3877 | application/json: {}
3878 | /v5/asset/settlement-record:
3879 | get:
3880 | tags:
3881 | - Asset
3882 | summary: settlement-record
3883 | parameters:
3884 | - name: X-BAPI-SIGN-TYPE
3885 | in: header
3886 | schema:
3887 | type: integer
3888 | example: '2'
3889 | - name: X-BAPI-SIGN
3890 | in: header
3891 | schema:
3892 | type: string
3893 | example: '{{signature}}'
3894 | - name: X-BAPI-API-KEY
3895 | in: header
3896 | schema:
3897 | type: string
3898 | example: '{{bybit-api-key}}'
3899 | - name: X-BAPI-TIMESTAMP
3900 | in: header
3901 | schema:
3902 | type: string
3903 | example: '{{timestamp}}'
3904 | - name: X-BAPI-RECV-WINDOW
3905 | in: header
3906 | schema:
3907 | type: string
3908 | example: '{{recvWindow}}'
3909 | - name: Content-Type
3910 | in: header
3911 | schema:
3912 | type: string
3913 | example: application/json
3914 | - name: category
3915 | in: query
3916 | schema:
3917 | type: string
3918 | example: linear
3919 | - name: symbol
3920 | in: query
3921 | schema:
3922 | type: string
3923 | example: BTCPERP
3924 | responses:
3925 | '200':
3926 | description: Successful response
3927 | content:
3928 | application/json: {}
3929 | /v5/asset/exchange/order-record:
3930 | get:
3931 | tags:
3932 | - Asset
3933 | summary: exchange/order-record
3934 | parameters:
3935 | - name: X-BAPI-SIGN-TYPE
3936 | in: header
3937 | schema:
3938 | type: integer
3939 | example: '2'
3940 | - name: X-BAPI-SIGN
3941 | in: header
3942 | schema:
3943 | type: string
3944 | example: '{{signature}}'
3945 | - name: X-BAPI-API-KEY
3946 | in: header
3947 | schema:
3948 | type: string
3949 | example: '{{bybit-api-key}}'
3950 | - name: X-BAPI-TIMESTAMP
3951 | in: header
3952 | schema:
3953 | type: string
3954 | example: '{{timestamp}}'
3955 | - name: X-BAPI-RECV-WINDOW
3956 | in: header
3957 | schema:
3958 | type: string
3959 | example: '{{recvWindow}}'
3960 | - name: Content-Type
3961 | in: header
3962 | schema:
3963 | type: string
3964 | example: application/json
3965 | - name: limit
3966 | in: query
3967 | schema:
3968 | type: integer
3969 | example: '10'
3970 | responses:
3971 | '200':
3972 | description: Successful response
3973 | content:
3974 | application/json: {}
3975 | /v5/asset/coin/query-info:
3976 | get:
3977 | tags:
3978 | - Asset
3979 | summary: coin/query-info
3980 | parameters:
3981 | - name: X-BAPI-SIGN-TYPE
3982 | in: header
3983 | schema:
3984 | type: integer
3985 | example: '2'
3986 | - name: X-BAPI-SIGN
3987 | in: header
3988 | schema:
3989 | type: string
3990 | example: '{{signature}}'
3991 | - name: X-BAPI-API-KEY
3992 | in: header
3993 | schema:
3994 | type: string
3995 | example: '{{bybit-api-key}}'
3996 | - name: X-BAPI-TIMESTAMP
3997 | in: header
3998 | schema:
3999 | type: string
4000 | example: '{{timestamp}}'
4001 | - name: X-BAPI-RECV-WINDOW
4002 | in: header
4003 | schema:
4004 | type: string
4005 | example: '{{recvWindow}}'
4006 | - name: Content-Type
4007 | in: header
4008 | schema:
4009 | type: string
4010 | example: application/json
4011 | - name: coin
4012 | in: query
4013 | schema:
4014 | type: string
4015 | example: USDT
4016 | responses:
4017 | '200':
4018 | description: Successful response
4019 | content:
4020 | application/json: {}
4021 | /v5/asset/delivery-record:
4022 | get:
4023 | tags:
4024 | - Asset
4025 | summary: delivery-record
4026 | parameters:
4027 | - name: X-BAPI-SIGN-TYPE
4028 | in: header
4029 | schema:
4030 | type: integer
4031 | example: '2'
4032 | - name: X-BAPI-SIGN
4033 | in: header
4034 | schema:
4035 | type: string
4036 | example: '{{signature}}'
4037 | - name: X-BAPI-API-KEY
4038 | in: header
4039 | schema:
4040 | type: string
4041 | example: '{{bybit-api-key}}'
4042 | - name: X-BAPI-TIMESTAMP
4043 | in: header
4044 | schema:
4045 | type: string
4046 | example: '{{timestamp}}'
4047 | - name: X-BAPI-RECV-WINDOW
4048 | in: header
4049 | schema:
4050 | type: string
4051 | example: '{{recvWindow}}'
4052 | - name: Content-Type
4053 | in: header
4054 | schema:
4055 | type: string
4056 | example: application/json
4057 | - name: category
4058 | in: query
4059 | schema:
4060 | type: string
4061 | example: linear
4062 | responses:
4063 | '200':
4064 | description: Successful response
4065 | content:
4066 | application/json: {}
4067 | /v5/user/create-sub-member:
4068 | post:
4069 | tags:
4070 | - User
4071 | summary: Create Sub UID
4072 | requestBody:
4073 | content:
4074 | application/json:
4075 | schema:
4076 | type: object
4077 | example:
4078 | username: 06062024Test
4079 | memberType: 1
4080 | switch: 1
4081 | isUta: true
4082 | note: testnet sub UM acct
4083 | parameters:
4084 | - name: X-BAPI-SIGN
4085 | in: header
4086 | schema:
4087 | type: string
4088 | example: '{{signature}}'
4089 | - name: X-BAPI-API-KEY
4090 | in: header
4091 | schema:
4092 | type: string
4093 | example: '{{bybit-api-key}}'
4094 | - name: X-BAPI-TIMESTAMP
4095 | in: header
4096 | schema:
4097 | type: string
4098 | example: '{{timestamp}}'
4099 | - name: X-BAPI-RECV-WINDOW
4100 | in: header
4101 | schema:
4102 | type: string
4103 | example: '{{recvWindow}}'
4104 | - name: Content-Type
4105 | in: header
4106 | schema:
4107 | type: string
4108 | example: application/json
4109 | responses:
4110 | '200':
4111 | description: Successful response
4112 | content:
4113 | application/json: {}
4114 | /v5/user/create-sub-api:
4115 | post:
4116 | tags:
4117 | - User
4118 | summary: Create SubUid apikey
4119 | requestBody:
4120 | content:
4121 | application/json:
4122 | schema:
4123 | type: object
4124 | example:
4125 | subuid: 1187021
4126 | note: 10thtest2
4127 | readOnly: 1
4128 | ips:
4129 | - '*'
4130 | permissions:
4131 | ContractTrade:
4132 | - Order
4133 | - Position
4134 | Spot:
4135 | - SpotTrade
4136 | Wallet:
4137 | - AccountTransfer
4138 | Options:
4139 | - OptionsTrade
4140 | Derivatives:
4141 | - DerivativesTrade
4142 | CopyTrading:
4143 | - CopyTrading
4144 | BlockTrade:
4145 | - BlockTrade
4146 | Exchange:
4147 | - ExchangeHistory
4148 | NFT:
4149 | - NFTQueryProductList
4150 | parameters:
4151 | - name: X-BAPI-SIGN
4152 | in: header
4153 | schema:
4154 | type: string
4155 | example: '{{signature}}'
4156 | - name: X-BAPI-API-KEY
4157 | in: header
4158 | schema:
4159 | type: string
4160 | example: '{{bybit-api-key}}'
4161 | - name: X-BAPI-TIMESTAMP
4162 | in: header
4163 | schema:
4164 | type: string
4165 | example: '{{timestamp}}'
4166 | - name: X-BAPI-RECV-WINDOW
4167 | in: header
4168 | schema:
4169 | type: string
4170 | example: '{{recvWindow}}'
4171 | - name: Content-Type
4172 | in: header
4173 | schema:
4174 | type: string
4175 | example: application/json
4176 | responses:
4177 | '200':
4178 | description: Successful response
4179 | content:
4180 | application/json: {}
4181 | /v5/user/query-sub-members:
4182 | get:
4183 | tags:
4184 | - User
4185 | summary: get Sub members list
4186 | parameters:
4187 | - name: X-BAPI-SIGN
4188 | in: header
4189 | schema:
4190 | type: string
4191 | example: '{{signature}}'
4192 | - name: X-BAPI-API-KEY
4193 | in: header
4194 | schema:
4195 | type: string
4196 | example: '{{bybit-api-key}}'
4197 | - name: X-BAPI-TIMESTAMP
4198 | in: header
4199 | schema:
4200 | type: string
4201 | example: '{{timestamp}}'
4202 | - name: X-BAPI-RECV-WINDOW
4203 | in: header
4204 | schema:
4205 | type: string
4206 | example: '{{recvWindow}}'
4207 | - name: Content-Type
4208 | in: header
4209 | schema:
4210 | type: string
4211 | example: application/json
4212 | responses:
4213 | '200':
4214 | description: Successful response
4215 | content:
4216 | application/json: {}
4217 | /v5/user/submembers:
4218 | get:
4219 | tags:
4220 | - User
4221 | summary: Get Sub UID List (Unlimited)
4222 | parameters:
4223 | - name: X-BAPI-SIGN
4224 | in: header
4225 | schema:
4226 | type: string
4227 | example: '{{signature}}'
4228 | - name: X-BAPI-API-KEY
4229 | in: header
4230 | schema:
4231 | type: string
4232 | example: '{{bybit-api-key}}'
4233 | - name: X-BAPI-TIMESTAMP
4234 | in: header
4235 | schema:
4236 | type: string
4237 | example: '{{timestamp}}'
4238 | - name: X-BAPI-RECV-WINDOW
4239 | in: header
4240 | schema:
4241 | type: string
4242 | example: '{{recvWindow}}'
4243 | - name: Content-Type
4244 | in: header
4245 | schema:
4246 | type: string
4247 | example: application/json
4248 | responses:
4249 | '200':
4250 | description: Successful response
4251 | content:
4252 | application/json: {}
4253 | /v5/user/query-api:
4254 | get:
4255 | tags:
4256 | - User
4257 | summary: query uid's apikey info
4258 | parameters:
4259 | - name: X-BAPI-SIGN
4260 | in: header
4261 | schema:
4262 | type: string
4263 | example: '{{signature}}'
4264 | - name: X-BAPI-API-KEY
4265 | in: header
4266 | schema:
4267 | type: string
4268 | example: '{{bybit-api-key}}'
4269 | - name: X-BAPI-TIMESTAMP
4270 | in: header
4271 | schema:
4272 | type: string
4273 | example: '{{timestamp}}'
4274 | - name: X-BAPI-RECV-WINDOW
4275 | in: header
4276 | schema:
4277 | type: string
4278 | example: '{{recvWindow}}'
4279 | - name: Content-Type
4280 | in: header
4281 | schema:
4282 | type: string
4283 | example: application/json
4284 | responses:
4285 | '200':
4286 | description: Successful response
4287 | content:
4288 | application/json: {}
4289 | /v5/user/sub-apikeys:
4290 | get:
4291 | tags:
4292 | - User
4293 | summary: Get Sub Account All API Keys
4294 | parameters:
4295 | - name: X-BAPI-SIGN
4296 | in: header
4297 | schema:
4298 | type: string
4299 | example: '{{signature}}'
4300 | - name: X-BAPI-API-KEY
4301 | in: header
4302 | schema:
4303 | type: string
4304 | example: '{{bybit-api-key}}'
4305 | - name: X-BAPI-TIMESTAMP
4306 | in: header
4307 | schema:
4308 | type: string
4309 | example: '{{timestamp}}'
4310 | - name: X-BAPI-RECV-WINDOW
4311 | in: header
4312 | schema:
4313 | type: string
4314 | example: '{{recvWindow}}'
4315 | - name: Content-Type
4316 | in: header
4317 | schema:
4318 | type: string
4319 | example: application/json
4320 | - name: subMemberId
4321 | in: query
4322 | schema:
4323 | type: integer
4324 | description: Sub UID
4325 | example: '100312051'
4326 | responses:
4327 | '200':
4328 | description: Successful response
4329 | content:
4330 | application/json: {}
4331 | /v5/user/get-member-type:
4332 | get:
4333 | tags:
4334 | - User
4335 | summary: Get UID Wallet Type
4336 | parameters:
4337 | - name: X-BAPI-SIGN
4338 | in: header
4339 | schema:
4340 | type: string
4341 | example: '{{signature}}'
4342 | - name: X-BAPI-API-KEY
4343 | in: header
4344 | schema:
4345 | type: string
4346 | example: '{{bybit-api-key}}'
4347 | - name: X-BAPI-TIMESTAMP
4348 | in: header
4349 | schema:
4350 | type: string
4351 | example: '{{timestamp}}'
4352 | - name: X-BAPI-RECV-WINDOW
4353 | in: header
4354 | schema:
4355 | type: string
4356 | example: '{{recvWindow}}'
4357 | - name: Content-Type
4358 | in: header
4359 | schema:
4360 | type: string
4361 | example: application/json
4362 | responses:
4363 | '200':
4364 | description: Successful response
4365 | content:
4366 | application/json: {}
4367 | /v5/user/aff-customer-info:
4368 | get:
4369 | tags:
4370 | - User
4371 | summary: Get Affiliate User Info
4372 | parameters:
4373 | - name: X-BAPI-SIGN
4374 | in: header
4375 | schema:
4376 | type: string
4377 | example: '{{signature}}'
4378 | - name: X-BAPI-API-KEY
4379 | in: header
4380 | schema:
4381 | type: string
4382 | example: '{{bybit-api-key}}'
4383 | - name: X-BAPI-TIMESTAMP
4384 | in: header
4385 | schema:
4386 | type: string
4387 | example: '{{timestamp}}'
4388 | - name: X-BAPI-RECV-WINDOW
4389 | in: header
4390 | schema:
4391 | type: string
4392 | example: '{{recvWindow}}'
4393 | - name: Content-Type
4394 | in: header
4395 | schema:
4396 | type: string
4397 | example: application/json
4398 | responses:
4399 | '200':
4400 | description: Successful response
4401 | content:
4402 | application/json: {}
4403 | /v5/user/frozen-sub-member:
4404 | post:
4405 | tags:
4406 | - User
4407 | summary: Froze Sub UID
4408 | requestBody:
4409 | content:
4410 | application/json:
4411 | schema:
4412 | type: object
4413 | example:
4414 | subuid: 1187021
4415 | frozen: 0
4416 | parameters:
4417 | - name: X-BAPI-SIGN
4418 | in: header
4419 | schema:
4420 | type: string
4421 | example: '{{signature}}'
4422 | - name: X-BAPI-API-KEY
4423 | in: header
4424 | schema:
4425 | type: string
4426 | example: '{{bybit-api-key}}'
4427 | - name: X-BAPI-TIMESTAMP
4428 | in: header
4429 | schema:
4430 | type: string
4431 | example: '{{timestamp}}'
4432 | - name: X-BAPI-RECV-WINDOW
4433 | in: header
4434 | schema:
4435 | type: string
4436 | example: '{{recvWindow}}'
4437 | - name: Content-Type
4438 | in: header
4439 | schema:
4440 | type: string
4441 | example: application/json
4442 | responses:
4443 | '200':
4444 | description: Successful response
4445 | content:
4446 | application/json: {}
4447 | /v5/user/del-submember:
4448 | post:
4449 | tags:
4450 | - User
4451 | summary: delete Sub UID
4452 | requestBody:
4453 | content:
4454 | application/json:
4455 | schema:
4456 | type: object
4457 | example:
4458 | subMemberId: '101472685'
4459 | parameters:
4460 | - name: X-BAPI-SIGN
4461 | in: header
4462 | schema:
4463 | type: string
4464 | example: '{{signature}}'
4465 | - name: X-BAPI-API-KEY
4466 | in: header
4467 | schema:
4468 | type: string
4469 | example: '{{bybit-api-key}}'
4470 | - name: X-BAPI-TIMESTAMP
4471 | in: header
4472 | schema:
4473 | type: string
4474 | example: '{{timestamp}}'
4475 | - name: X-BAPI-RECV-WINDOW
4476 | in: header
4477 | schema:
4478 | type: string
4479 | example: '{{recvWindow}}'
4480 | - name: Content-Type
4481 | in: header
4482 | schema:
4483 | type: string
4484 | example: application/json
4485 | responses:
4486 | '200':
4487 | description: Successful response
4488 | content:
4489 | application/json: {}
4490 | /v5/user/update-api:
4491 | post:
4492 | tags:
4493 | - User
4494 | summary: Modify Master uid's api key permission
4495 | requestBody:
4496 | content:
4497 | application/json:
4498 | schema:
4499 | type: object
4500 | example:
4501 | readOnly: 0
4502 | ips:
4503 | - 138.113.117.38
4504 | permissions:
4505 | ContractTrade:
4506 | - Order
4507 | - Position
4508 | Spot:
4509 | - SpotTrade
4510 | Wallet:
4511 | - AccountTransfer
4512 | - SubMemberTransfer
4513 | Options:
4514 | - OptionsTrade
4515 | Derivatives:
4516 | - DerivativesTrade
4517 | CopyTrading:
4518 | - CopyTrading
4519 | BlockTrade:
4520 | - BlockTrade
4521 | Exchange:
4522 | - ExchangeHistory
4523 | NFT:
4524 | - NFTQueryProductList
4525 | parameters:
4526 | - name: X-BAPI-SIGN
4527 | in: header
4528 | schema:
4529 | type: string
4530 | example: '{{signature}}'
4531 | - name: X-BAPI-API-KEY
4532 | in: header
4533 | schema:
4534 | type: string
4535 | example: '{{bybit-api-key}}'
4536 | - name: X-BAPI-TIMESTAMP
4537 | in: header
4538 | schema:
4539 | type: string
4540 | example: '{{timestamp}}'
4541 | - name: X-BAPI-RECV-WINDOW
4542 | in: header
4543 | schema:
4544 | type: string
4545 | example: '{{recvWindow}}'
4546 | - name: Content-Type
4547 | in: header
4548 | schema:
4549 | type: string
4550 | example: application/json
4551 | responses:
4552 | '200':
4553 | description: Successful response
4554 | content:
4555 | application/json: {}
4556 | /v5/user/delete-api:
4557 | post:
4558 | tags:
4559 | - User
4560 | summary: delete master uid apikey
4561 | requestBody:
4562 | content:
4563 | application/json:
4564 | schema:
4565 | type: object
4566 | example: {}
4567 | parameters:
4568 | - name: X-BAPI-SIGN
4569 | in: header
4570 | schema:
4571 | type: string
4572 | example: '{{signature}}'
4573 | - name: X-BAPI-API-KEY
4574 | in: header
4575 | schema:
4576 | type: string
4577 | example: '{{bybit-api-key}}'
4578 | - name: X-BAPI-TIMESTAMP
4579 | in: header
4580 | schema:
4581 | type: string
4582 | example: '{{timestamp}}'
4583 | - name: X-BAPI-RECV-WINDOW
4584 | in: header
4585 | schema:
4586 | type: string
4587 | example: '{{recvWindow}}'
4588 | - name: Content-Type
4589 | in: header
4590 | schema:
4591 | type: string
4592 | example: application/json
4593 | responses:
4594 | '200':
4595 | description: Successful response
4596 | content:
4597 | application/json: {}
4598 | /v5/user/update-sub-api:
4599 | post:
4600 | tags:
4601 | - User
4602 | summary: Modify sub uid's api key permission
4603 | requestBody:
4604 | content:
4605 | application/json:
4606 | schema:
4607 | type: object
4608 | example:
4609 | readOnly: 0
4610 | ips:
4611 | - '*'
4612 | permissions:
4613 | ContractTrade:
4614 | - Order
4615 | - Position
4616 | Spot:
4617 | - SpotTrade
4618 | Wallet:
4619 | - AccountTransfer
4620 | - SubMemberTransfer
4621 | Options:
4622 | - OptionsTrade
4623 | Derivatives:
4624 | - DerivativesTrade
4625 | CopyTrading:
4626 | - CopyTrading
4627 | BlockTrade:
4628 | - BlockTrade
4629 | Exchange:
4630 | - ExchangeHistory
4631 | NFT:
4632 | - NFTQueryProductList
4633 | parameters:
4634 | - name: X-BAPI-SIGN
4635 | in: header
4636 | schema:
4637 | type: string
4638 | example: '{{signature}}'
4639 | - name: X-BAPI-API-KEY
4640 | in: header
4641 | schema:
4642 | type: string
4643 | example: '{{bybit-api-key}}'
4644 | - name: X-BAPI-TIMESTAMP
4645 | in: header
4646 | schema:
4647 | type: string
4648 | example: '{{timestamp}}'
4649 | - name: X-BAPI-RECV-WINDOW
4650 | in: header
4651 | schema:
4652 | type: string
4653 | example: '{{recvWindow}}'
4654 | - name: Content-Type
4655 | in: header
4656 | schema:
4657 | type: string
4658 | example: application/json
4659 | responses:
4660 | '200':
4661 | description: Successful response
4662 | content:
4663 | application/json: {}
4664 | /v5/user/delete-sub-api:
4665 | post:
4666 | tags:
4667 | - User
4668 | summary: delete sub uid apikey (use the api key pending to remove)
4669 | requestBody:
4670 | content:
4671 | application/json:
4672 | schema:
4673 | type: object
4674 | example: {}
4675 | parameters:
4676 | - name: X-BAPI-SIGN
4677 | in: header
4678 | schema:
4679 | type: string
4680 | example: '{{signature}}'
4681 | - name: X-BAPI-API-KEY
4682 | in: header
4683 | schema:
4684 | type: string
4685 | example: '{{bybit-api-key}}'
4686 | - name: X-BAPI-TIMESTAMP
4687 | in: header
4688 | schema:
4689 | type: string
4690 | example: '{{timestamp}}'
4691 | - name: X-BAPI-RECV-WINDOW
4692 | in: header
4693 | schema:
4694 | type: string
4695 | example: '{{recvWindow}}'
4696 | - name: Content-Type
4697 | in: header
4698 | schema:
4699 | type: string
4700 | example: application/json
4701 | responses:
4702 | '200':
4703 | description: Successful response
4704 | content:
4705 | application/json: {}
4706 | /v5/spot-lever-token/info:
4707 | get:
4708 | tags:
4709 | - Spot-lever-token
4710 | summary: spot-lever-token/info
4711 | parameters:
4712 | - name: ltCoin
4713 | in: query
4714 | schema:
4715 | type: string
4716 | example: BTC3L
4717 | responses:
4718 | '200':
4719 | description: Successful response
4720 | content:
4721 | application/json: {}
4722 | /v5/spot-lever-token/reference:
4723 | get:
4724 | tags:
4725 | - Spot-lever-token
4726 | summary: spot-lever-token/reference
4727 | parameters:
4728 | - name: ltCoin
4729 | in: query
4730 | schema:
4731 | type: string
4732 | example: BTC3L
4733 | responses:
4734 | '200':
4735 | description: Successful response
4736 | content:
4737 | application/json: {}
4738 | /v5/spot-lever-token/purchase:
4739 | post:
4740 | tags:
4741 | - Spot-lever-token
4742 | summary: spot-lever-token/purchase
4743 | requestBody:
4744 | content:
4745 | application/json:
4746 | schema:
4747 | type: object
4748 | example:
4749 | ltCoin: BTC3L
4750 | amount: '100'
4751 | parameters:
4752 | - name: X-BAPI-SIGN-TYPE
4753 | in: header
4754 | schema:
4755 | type: integer
4756 | example: '2'
4757 | - name: X-BAPI-SIGN
4758 | in: header
4759 | schema:
4760 | type: string
4761 | example: '{{signature}}'
4762 | - name: X-BAPI-API-KEY
4763 | in: header
4764 | schema:
4765 | type: string
4766 | example: '{{bybit-api-key}}'
4767 | - name: X-BAPI-TIMESTAMP
4768 | in: header
4769 | schema:
4770 | type: string
4771 | example: '{{timestamp}}'
4772 | - name: X-BAPI-RECV-WINDOW
4773 | in: header
4774 | schema:
4775 | type: string
4776 | example: '{{recvWindow}}'
4777 | - name: Content-Type
4778 | in: header
4779 | schema:
4780 | type: string
4781 | example: application/json
4782 | responses:
4783 | '200':
4784 | description: Successful response
4785 | content:
4786 | application/json: {}
4787 | /v5/spot-lever-token/redeem:
4788 | post:
4789 | tags:
4790 | - Spot-lever-token
4791 | summary: spot-lever-token/redeem
4792 | requestBody:
4793 | content:
4794 | application/json:
4795 | schema:
4796 | type: object
4797 | example:
4798 | ltCoin: BTC3L
4799 | quantity: '0.1'
4800 | parameters:
4801 | - name: X-BAPI-SIGN-TYPE
4802 | in: header
4803 | schema:
4804 | type: integer
4805 | example: '2'
4806 | - name: X-BAPI-SIGN
4807 | in: header
4808 | schema:
4809 | type: string
4810 | example: '{{signature}}'
4811 | - name: X-BAPI-API-KEY
4812 | in: header
4813 | schema:
4814 | type: string
4815 | example: '{{bybit-api-key}}'
4816 | - name: X-BAPI-TIMESTAMP
4817 | in: header
4818 | schema:
4819 | type: string
4820 | example: '{{timestamp}}'
4821 | - name: X-BAPI-RECV-WINDOW
4822 | in: header
4823 | schema:
4824 | type: string
4825 | example: '{{recvWindow}}'
4826 | - name: Content-Type
4827 | in: header
4828 | schema:
4829 | type: string
4830 | example: application/json
4831 | responses:
4832 | '200':
4833 | description: Successful response
4834 | content:
4835 | application/json: {}
4836 | /v5/spot-lever-token/order-record:
4837 | get:
4838 | tags:
4839 | - Spot-lever-token
4840 | summary: spot-lever-token/order-record
4841 | parameters:
4842 | - name: X-BAPI-API-KEY
4843 | in: header
4844 | schema:
4845 | type: string
4846 | example: '{{bybit-api-key}}'
4847 | - name: X-BAPI-TIMESTAMP
4848 | in: header
4849 | schema:
4850 | type: string
4851 | example: '{{timestamp}}'
4852 | - name: X-BAPI-RECV-WINDOW
4853 | in: header
4854 | schema:
4855 | type: string
4856 | example: '{{recvWindow}}'
4857 | - name: Content-Type
4858 | in: header
4859 | schema:
4860 | type: string
4861 | example: application/json
4862 | - name: X-BAPI-SIGN
4863 | in: header
4864 | schema:
4865 | type: string
4866 | example: '{{signature}}'
4867 | - name: X-BAPI-SIGN-TYPE
4868 | in: header
4869 | schema:
4870 | type: integer
4871 | example: '2'
4872 | responses:
4873 | '200':
4874 | description: Successful response
4875 | content:
4876 | application/json: {}
4877 | /v5/spot-margin-trade/data:
4878 | get:
4879 | tags:
4880 | - Spot-Margin-Trade
4881 | summary: Get VIP Margin Data
4882 | parameters:
4883 | - name: Content-Type
4884 | in: header
4885 | schema:
4886 | type: string
4887 | example: application/json
4888 | - name: vipLevel
4889 | in: query
4890 | schema:
4891 | type: string
4892 | example: PRO-5
4893 | - name: currency
4894 | in: query
4895 | schema:
4896 | type: string
4897 | example: BNB
4898 | responses:
4899 | '200':
4900 | description: Successful response
4901 | content:
4902 | application/json: {}
4903 | /v5/spot-margin-trade/interest-rate-history:
4904 | get:
4905 | tags:
4906 | - Spot-Margin-Trade
4907 | summary: Get Historical Interest Rate
4908 | parameters:
4909 | - name: X-BAPI-SIGN-TYPE
4910 | in: header
4911 | schema:
4912 | type: integer
4913 | example: '2'
4914 | - name: X-BAPI-SIGN
4915 | in: header
4916 | schema:
4917 | type: string
4918 | example: '{{signature}}'
4919 | - name: X-BAPI-API-KEY
4920 | in: header
4921 | schema:
4922 | type: string
4923 | example: '{{bybit-api-key}}'
4924 | - name: X-BAPI-TIMESTAMP
4925 | in: header
4926 | schema:
4927 | type: string
4928 | example: '{{timestamp}}'
4929 | - name: X-BAPI-RECV-WINDOW
4930 | in: header
4931 | schema:
4932 | type: string
4933 | example: '{{recvWindow}}'
4934 | - name: Content-Type
4935 | in: header
4936 | schema:
4937 | type: string
4938 | example: application/json
4939 | - name: currency
4940 | in: query
4941 | schema:
4942 | type: string
4943 | example: USDC
4944 | - name: vipLevel
4945 | in: query
4946 | schema:
4947 | type: string
4948 | example: No%20VIP
4949 | - name: startTime
4950 | in: query
4951 | schema:
4952 | type: integer
4953 | example: '1721458800000'
4954 | - name: endTime
4955 | in: query
4956 | schema:
4957 | type: integer
4958 | example: '1721469600000'
4959 | responses:
4960 | '200':
4961 | description: Successful response
4962 | content:
4963 | application/json: {}
4964 | /v5/spot-margin-trade/state:
4965 | get:
4966 | tags:
4967 | - Spot-Margin-Trade
4968 | summary: Get Status And Leverage
4969 | parameters:
4970 | - name: X-BAPI-SIGN-TYPE
4971 | in: header
4972 | schema:
4973 | type: integer
4974 | example: '2'
4975 | - name: X-BAPI-SIGN
4976 | in: header
4977 | schema:
4978 | type: string
4979 | example: '{{signature}}'
4980 | - name: X-BAPI-API-KEY
4981 | in: header
4982 | schema:
4983 | type: string
4984 | example: '{{bybit-api-key}}'
4985 | - name: X-BAPI-TIMESTAMP
4986 | in: header
4987 | schema:
4988 | type: string
4989 | example: '{{timestamp}}'
4990 | - name: X-BAPI-RECV-WINDOW
4991 | in: header
4992 | schema:
4993 | type: string
4994 | example: '{{recvWindow}}'
4995 | - name: Content-Type
4996 | in: header
4997 | schema:
4998 | type: string
4999 | example: application/json
5000 | responses:
5001 | '200':
5002 | description: Successful response
5003 | content:
5004 | application/json: {}
5005 | /v5/spot-margin-trade/switch-mode:
5006 | post:
5007 | tags:
5008 | - Spot-Margin-Trade
5009 | summary: spot-margin-trade/switch-mode
5010 | requestBody:
5011 | content:
5012 | application/json:
5013 | schema:
5014 | type: object
5015 | example:
5016 | spotMarginMode: '1'
5017 | parameters:
5018 | - name: X-BAPI-SIGN-TYPE
5019 | in: header
5020 | schema:
5021 | type: integer
5022 | example: '2'
5023 | - name: X-BAPI-SIGN
5024 | in: header
5025 | schema:
5026 | type: string
5027 | example: '{{signature}}'
5028 | - name: X-BAPI-API-KEY
5029 | in: header
5030 | schema:
5031 | type: string
5032 | example: '{{bybit-api-key}}'
5033 | - name: X-BAPI-TIMESTAMP
5034 | in: header
5035 | schema:
5036 | type: string
5037 | example: '{{timestamp}}'
5038 | - name: X-BAPI-RECV-WINDOW
5039 | in: header
5040 | schema:
5041 | type: string
5042 | example: '{{recvWindow}}'
5043 | - name: Content-Type
5044 | in: header
5045 | schema:
5046 | type: string
5047 | example: application/json
5048 | responses:
5049 | '200':
5050 | description: Successful response
5051 | content:
5052 | application/json: {}
5053 | /v5/spot-margin-trade/set-leverage:
5054 | post:
5055 | tags:
5056 | - Spot-Margin-Trade
5057 | summary: spot-margin-trade/set-leverage
5058 | requestBody:
5059 | content:
5060 | application/json:
5061 | schema:
5062 | type: object
5063 | example:
5064 | leverage: 3
5065 | parameters:
5066 | - name: X-BAPI-SIGN-TYPE
5067 | in: header
5068 | schema:
5069 | type: integer
5070 | example: '2'
5071 | - name: X-BAPI-SIGN
5072 | in: header
5073 | schema:
5074 | type: string
5075 | example: '{{signature}}'
5076 | - name: X-BAPI-API-KEY
5077 | in: header
5078 | schema:
5079 | type: string
5080 | example: '{{bybit-api-key}}'
5081 | - name: X-BAPI-TIMESTAMP
5082 | in: header
5083 | schema:
5084 | type: string
5085 | example: '{{timestamp}}'
5086 | - name: X-BAPI-RECV-WINDOW
5087 | in: header
5088 | schema:
5089 | type: string
5090 | example: '{{recvWindow}}'
5091 | - name: Content-Type
5092 | in: header
5093 | schema:
5094 | type: string
5095 | example: application/json
5096 | responses:
5097 | '200':
5098 | description: Successful response
5099 | content:
5100 | application/json: {}
5101 | /v5/ins-loan/ltv:
5102 | get:
5103 | tags:
5104 | - Institutional Loan
5105 | summary: Get Repay Orders
5106 | parameters:
5107 | - name: X-BAPI-SIGN-TYPE
5108 | in: header
5109 | schema:
5110 | type: integer
5111 | example: '2'
5112 | - name: X-BAPI-SIGN
5113 | in: header
5114 | schema:
5115 | type: string
5116 | example: '{{signature}}'
5117 | - name: X-BAPI-API-KEY
5118 | in: header
5119 | schema:
5120 | type: string
5121 | example: '{{bybit-api-key}}'
5122 | - name: X-BAPI-TIMESTAMP
5123 | in: header
5124 | schema:
5125 | type: string
5126 | example: '{{timestamp}}'
5127 | - name: X-BAPI-RECV-WINDOW
5128 | in: header
5129 | schema:
5130 | type: string
5131 | example: '{{recvWindow}}'
5132 | - name: Content-Type
5133 | in: header
5134 | schema:
5135 | type: string
5136 | example: application/json
5137 | responses:
5138 | '200':
5139 | description: Successful response
5140 | content:
5141 | application/json: {}
5142 | /v5/ins-loan/association-uid:
5143 | post:
5144 | tags:
5145 | - Institutional Loan
5146 | summary: Bind Or Unbind UID
5147 | requestBody:
5148 | content:
5149 | '*/*':
5150 | schema:
5151 | type: string
5152 | example: '"{\r\n \"uid\": \"592324\",\r\n \"operate\": \"0\"\r\n}"'
5153 | parameters:
5154 | - name: X-BAPI-SIGN-TYPE
5155 | in: header
5156 | schema:
5157 | type: integer
5158 | example: '2'
5159 | - name: X-BAPI-SIGN
5160 | in: header
5161 | schema:
5162 | type: string
5163 | example: '{{signature}}'
5164 | - name: X-BAPI-API-KEY
5165 | in: header
5166 | schema:
5167 | type: string
5168 | example: '{{bybit-api-key}}'
5169 | - name: X-BAPI-TIMESTAMP
5170 | in: header
5171 | schema:
5172 | type: string
5173 | example: '{{timestamp}}'
5174 | - name: X-BAPI-RECV-WINDOW
5175 | in: header
5176 | schema:
5177 | type: string
5178 | example: '{{recvWindow}}'
5179 | - name: Content-Type
5180 | in: header
5181 | schema:
5182 | type: string
5183 | example: application/json
5184 | responses:
5185 | '200':
5186 | description: Successful response
5187 | content:
5188 | application/json: {}
5189 | /v5/crypto-loan/ongoing-orders:
5190 | get:
5191 | tags:
5192 | - Crypto Loan
5193 | summary: Get Unpaid Loan Orders
5194 | parameters:
5195 | - name: X-BAPI-SIGN-TYPE
5196 | in: header
5197 | schema:
5198 | type: integer
5199 | example: '2'
5200 | - name: X-BAPI-SIGN
5201 | in: header
5202 | schema:
5203 | type: string
5204 | example: '{{signature}}'
5205 | - name: X-BAPI-API-KEY
5206 | in: header
5207 | schema:
5208 | type: string
5209 | example: '{{bybit-api-key}}'
5210 | - name: X-BAPI-TIMESTAMP
5211 | in: header
5212 | schema:
5213 | type: string
5214 | example: '{{timestamp}}'
5215 | - name: X-BAPI-RECV-WINDOW
5216 | in: header
5217 | schema:
5218 | type: string
5219 | example: '{{recvWindow}}'
5220 | - name: Content-Type
5221 | in: header
5222 | schema:
5223 | type: string
5224 | example: application/json
5225 | - name: repayId
5226 | in: query
5227 | schema:
5228 | type: integer
5229 | example: '1794532027145157120'
5230 | responses:
5231 | '200':
5232 | description: Successful response
5233 | content:
5234 | application/json: {}
5235 | /v5/crypto-loan/max-collateral-amount:
5236 | get:
5237 | tags:
5238 | - Crypto Loan
5239 | summary: Get Max. Allowed Reduction Collateral Amount
5240 | parameters:
5241 | - name: X-BAPI-SIGN-TYPE
5242 | in: header
5243 | schema:
5244 | type: integer
5245 | example: '2'
5246 | - name: X-BAPI-SIGN
5247 | in: header
5248 | schema:
5249 | type: string
5250 | example: '{{signature}}'
5251 | - name: X-BAPI-API-KEY
5252 | in: header
5253 | schema:
5254 | type: string
5255 | example: '{{bybit-api-key}}'
5256 | - name: X-BAPI-TIMESTAMP
5257 | in: header
5258 | schema:
5259 | type: string
5260 | example: '{{timestamp}}'
5261 | - name: X-BAPI-RECV-WINDOW
5262 | in: header
5263 | schema:
5264 | type: string
5265 | example: '{{recvWindow}}'
5266 | - name: Content-Type
5267 | in: header
5268 | schema:
5269 | type: string
5270 | example: application/json
5271 | - name: orderId
5272 | in: query
5273 | schema:
5274 | type: integer
5275 | example: '1794531321268959232'
5276 | responses:
5277 | '200':
5278 | description: Successful response
5279 | content:
5280 | application/json: {}
5281 | /v5/crypto-loan/borrow-history:
5282 | get:
5283 | tags:
5284 | - Crypto Loan
5285 | summary: Get Completed Loan Order History
5286 | parameters:
5287 | - name: X-BAPI-SIGN-TYPE
5288 | in: header
5289 | schema:
5290 | type: integer
5291 | example: '2'
5292 | - name: X-BAPI-SIGN
5293 | in: header
5294 | schema:
5295 | type: string
5296 | example: '{{signature}}'
5297 | - name: X-BAPI-API-KEY
5298 | in: header
5299 | schema:
5300 | type: string
5301 | example: '{{bybit-api-key}}'
5302 | - name: X-BAPI-TIMESTAMP
5303 | in: header
5304 | schema:
5305 | type: string
5306 | example: '{{timestamp}}'
5307 | - name: X-BAPI-RECV-WINDOW
5308 | in: header
5309 | schema:
5310 | type: string
5311 | example: '{{recvWindow}}'
5312 | - name: Content-Type
5313 | in: header
5314 | schema:
5315 | type: string
5316 | example: application/json
5317 | responses:
5318 | '200':
5319 | description: Successful response
5320 | content:
5321 | application/json: {}
5322 | /v5/crypto-loan/collateral-data:
5323 | get:
5324 | tags:
5325 | - Crypto Loan
5326 | summary: Get crypto Loan Borrowable Coins Copy
5327 | parameters:
5328 | - name: X-BAPI-SIGN-TYPE
5329 | in: header
5330 | schema:
5331 | type: integer
5332 | example: '2'
5333 | - name: X-BAPI-SIGN
5334 | in: header
5335 | schema:
5336 | type: string
5337 | example: '{{signature}}'
5338 | - name: X-BAPI-API-KEY
5339 | in: header
5340 | schema:
5341 | type: string
5342 | example: '{{bybit-api-key}}'
5343 | - name: X-BAPI-TIMESTAMP
5344 | in: header
5345 | schema:
5346 | type: string
5347 | example: '{{timestamp}}'
5348 | - name: X-BAPI-RECV-WINDOW
5349 | in: header
5350 | schema:
5351 | type: string
5352 | example: '{{recvWindow}}'
5353 | - name: Content-Type
5354 | in: header
5355 | schema:
5356 | type: string
5357 | example: application/json
5358 | responses:
5359 | '200':
5360 | description: Successful response
5361 | content:
5362 | application/json: {}
5363 | /v5/crypto-loan/adjustment-history:
5364 | get:
5365 | tags:
5366 | - Crypto Loan
5367 | summary: Get Loan LTV Adjustment History
5368 | parameters:
5369 | - name: X-BAPI-SIGN-TYPE
5370 | in: header
5371 | schema:
5372 | type: integer
5373 | example: '2'
5374 | - name: X-BAPI-SIGN
5375 | in: header
5376 | schema:
5377 | type: string
5378 | example: '{{signature}}'
5379 | - name: X-BAPI-API-KEY
5380 | in: header
5381 | schema:
5382 | type: string
5383 | example: '{{bybit-api-key}}'
5384 | - name: X-BAPI-TIMESTAMP
5385 | in: header
5386 | schema:
5387 | type: string
5388 | example: '{{timestamp}}'
5389 | - name: X-BAPI-RECV-WINDOW
5390 | in: header
5391 | schema:
5392 | type: string
5393 | example: '{{recvWindow}}'
5394 | - name: Content-Type
5395 | in: header
5396 | schema:
5397 | type: string
5398 | example: application/json
5399 | responses:
5400 | '200':
5401 | description: Successful response
5402 | content:
5403 | application/json: {}
5404 | /v5/crypto-loan/borrow:
5405 | post:
5406 | tags:
5407 | - Crypto Loan
5408 | summary: Borrow Crypto loan
5409 | requestBody:
5410 | content:
5411 | application/json:
5412 | schema:
5413 | type: object
5414 | example:
5415 | loanCurrency: USDT
5416 | loanAmount: '550'
5417 | collateralCurrency: BTC
5418 | parameters:
5419 | - name: X-BAPI-SIGN-TYPE
5420 | in: header
5421 | schema:
5422 | type: integer
5423 | example: '2'
5424 | - name: X-BAPI-SIGN
5425 | in: header
5426 | schema:
5427 | type: string
5428 | example: '{{signature}}'
5429 | - name: X-BAPI-API-KEY
5430 | in: header
5431 | schema:
5432 | type: string
5433 | example: '{{bybit-api-key}}'
5434 | - name: X-BAPI-TIMESTAMP
5435 | in: header
5436 | schema:
5437 | type: string
5438 | example: '{{timestamp}}'
5439 | - name: X-BAPI-RECV-WINDOW
5440 | in: header
5441 | schema:
5442 | type: string
5443 | example: '{{recvWindow}}'
5444 | - name: Content-Type
5445 | in: header
5446 | schema:
5447 | type: string
5448 | example: application/json
5449 | responses:
5450 | '200':
5451 | description: Successful response
5452 | content:
5453 | application/json: {}
5454 | /v5/crypto-loan/repay:
5455 | post:
5456 | tags:
5457 | - Crypto Loan
5458 | summary: Repay Crypto loan
5459 | requestBody:
5460 | content:
5461 | application/json:
5462 | schema:
5463 | type: object
5464 | example:
5465 | orderId: '1794531321268959232'
5466 | amount: '0.000771'
5467 | parameters:
5468 | - name: X-BAPI-SIGN-TYPE
5469 | in: header
5470 | schema:
5471 | type: integer
5472 | example: '2'
5473 | - name: X-BAPI-SIGN
5474 | in: header
5475 | schema:
5476 | type: string
5477 | example: '{{signature}}'
5478 | - name: X-BAPI-API-KEY
5479 | in: header
5480 | schema:
5481 | type: string
5482 | example: '{{bybit-api-key}}'
5483 | - name: X-BAPI-TIMESTAMP
5484 | in: header
5485 | schema:
5486 | type: string
5487 | example: '{{timestamp}}'
5488 | - name: X-BAPI-RECV-WINDOW
5489 | in: header
5490 | schema:
5491 | type: string
5492 | example: '{{recvWindow}}'
5493 | - name: Content-Type
5494 | in: header
5495 | schema:
5496 | type: string
5497 | example: application/json
5498 | responses:
5499 | '200':
5500 | description: Successful response
5501 | content:
5502 | application/json: {}
5503 | /v5/crypto-loan/adjust-ltv:
5504 | post:
5505 | tags:
5506 | - Crypto Loan
5507 | summary: Adjust Collateral Amount
5508 | requestBody:
5509 | content:
5510 | application/json:
5511 | schema:
5512 | type: object
5513 | example:
5514 | orderId: '1794531321268959232'
5515 | amount: '550'
5516 | direction: '0'
5517 | parameters:
5518 | - name: X-BAPI-SIGN-TYPE
5519 | in: header
5520 | schema:
5521 | type: integer
5522 | example: '2'
5523 | - name: X-BAPI-SIGN
5524 | in: header
5525 | schema:
5526 | type: string
5527 | example: '{{signature}}'
5528 | - name: X-BAPI-API-KEY
5529 | in: header
5530 | schema:
5531 | type: string
5532 | example: '{{bybit-api-key}}'
5533 | - name: X-BAPI-TIMESTAMP
5534 | in: header
5535 | schema:
5536 | type: string
5537 | example: '{{timestamp}}'
5538 | - name: X-BAPI-RECV-WINDOW
5539 | in: header
5540 | schema:
5541 | type: string
5542 | example: '{{recvWindow}}'
5543 | - name: Content-Type
5544 | in: header
5545 | schema:
5546 | type: string
5547 | example: application/json
5548 | responses:
5549 | '200':
5550 | description: Successful response
5551 | content:
5552 | application/json: {}
5553 | /v5/broker/award/distribution-record:
5554 | post:
5555 | tags:
5556 | - Broker > Reward
5557 | summary: Query Issued Voucher
5558 | requestBody:
5559 | content:
5560 | '*/*':
5561 | schema:
5562 | type: string
5563 | example: >-
5564 | "{\r\n \"accountId\": \"5714139\",\r\n \"awardId\":
5565 | \"189528\",\r\n \"specCode\": \"demo000\",\r\n
5566 | \"withUsedAmount\": false\r\n}"
5567 | parameters:
5568 | - name: X-BAPI-SIGN-TYPE
5569 | in: header
5570 | schema:
5571 | type: integer
5572 | example: '2'
5573 | - name: X-BAPI-SIGN
5574 | in: header
5575 | schema:
5576 | type: string
5577 | example: '{{signature}}'
5578 | - name: X-BAPI-API-KEY
5579 | in: header
5580 | schema:
5581 | type: string
5582 | example: '{{bybit-api-key}}'
5583 | - name: X-BAPI-TIMESTAMP
5584 | in: header
5585 | schema:
5586 | type: string
5587 | example: '{{timestamp}}'
5588 | - name: X-BAPI-RECV-WINDOW
5589 | in: header
5590 | schema:
5591 | type: string
5592 | example: '{{recvWindow}}'
5593 | - name: Content-Type
5594 | in: header
5595 | schema:
5596 | type: string
5597 | example: application/json
5598 | responses:
5599 | '200':
5600 | description: Successful response
5601 | content:
5602 | application/json: {}
5603 | /v5/broker/award/info:
5604 | post:
5605 | tags:
5606 | - Broker > Reward
5607 | summary: Query Voucher Spec
5608 | requestBody:
5609 | content:
5610 | '*/*':
5611 | schema:
5612 | type: string
5613 | example: '"{\r\n \"id\": \"80209\"\r\n}"'
5614 | parameters:
5615 | - name: X-BAPI-SIGN-TYPE
5616 | in: header
5617 | schema:
5618 | type: integer
5619 | example: '2'
5620 | - name: X-BAPI-SIGN
5621 | in: header
5622 | schema:
5623 | type: string
5624 | example: '{{signature}}'
5625 | - name: X-BAPI-API-KEY
5626 | in: header
5627 | schema:
5628 | type: string
5629 | example: '{{bybit-api-key}}'
5630 | - name: X-BAPI-TIMESTAMP
5631 | in: header
5632 | schema:
5633 | type: string
5634 | example: '{{timestamp}}'
5635 | - name: X-BAPI-RECV-WINDOW
5636 | in: header
5637 | schema:
5638 | type: string
5639 | example: '{{recvWindow}}'
5640 | - name: Content-Type
5641 | in: header
5642 | schema:
5643 | type: string
5644 | example: application/json
5645 | responses:
5646 | '200':
5647 | description: Successful response
5648 | content:
5649 | application/json: {}
5650 | /v5/broker/award/distribute-award:
5651 | post:
5652 | tags:
5653 | - Broker > Reward
5654 | summary: Query Issued Voucher Copy 2
5655 | requestBody:
5656 | content:
5657 | '*/*':
5658 | schema:
5659 | type: string
5660 | example: >-
5661 | "{\r\n \"accountId\": \"2846381\",\r\n \"awardId\":
5662 | \"123456\",\r\n \"specCode\": \"award-001\",\r\n
5663 | \"amount\": \"100\",\r\n \"brokerId\": \"v-28478\"\r\n}"
5664 | parameters:
5665 | - name: X-BAPI-SIGN-TYPE
5666 | in: header
5667 | schema:
5668 | type: integer
5669 | example: '2'
5670 | - name: X-BAPI-SIGN
5671 | in: header
5672 | schema:
5673 | type: string
5674 | example: '{{signature}}'
5675 | - name: X-BAPI-API-KEY
5676 | in: header
5677 | schema:
5678 | type: string
5679 | example: '{{bybit-api-key}}'
5680 | - name: X-BAPI-TIMESTAMP
5681 | in: header
5682 | schema:
5683 | type: string
5684 | example: '{{timestamp}}'
5685 | - name: X-BAPI-RECV-WINDOW
5686 | in: header
5687 | schema:
5688 | type: string
5689 | example: '{{recvWindow}}'
5690 | - name: Content-Type
5691 | in: header
5692 | schema:
5693 | type: string
5694 | example: application/json
5695 | responses:
5696 | '200':
5697 | description: Successful response
5698 | content:
5699 | application/json: {}
5700 | /v5/broker/account-info:
5701 | get:
5702 | tags:
5703 | - Broker
5704 | summary: Broker Account Info
5705 | parameters:
5706 | - name: X-BAPI-SIGN-TYPE
5707 | in: header
5708 | schema:
5709 | type: integer
5710 | example: '2'
5711 | - name: X-BAPI-SIGN
5712 | in: header
5713 | schema:
5714 | type: string
5715 | example: '{{signature}}'
5716 | - name: X-BAPI-API-KEY
5717 | in: header
5718 | schema:
5719 | type: string
5720 | example: '{{bybit-api-key}}'
5721 | - name: X-BAPI-TIMESTAMP
5722 | in: header
5723 | schema:
5724 | type: string
5725 | example: '{{timestamp}}'
5726 | - name: X-BAPI-RECV-WINDOW
5727 | in: header
5728 | schema:
5729 | type: string
5730 | example: '{{recvWindow}}'
5731 | - name: Content-Type
5732 | in: header
5733 | schema:
5734 | type: string
5735 | example: application/json
5736 | responses:
5737 | '200':
5738 | description: Successful response
5739 | content:
5740 | application/json: {}
5741 | /v5/broker/earning-record:
5742 | get:
5743 | tags:
5744 | - Broker
5745 | summary: Get Broker Earning
5746 | parameters:
5747 | - name: X-BAPI-SIGN-TYPE
5748 | in: header
5749 | schema:
5750 | type: integer
5751 | example: '2'
5752 | - name: X-BAPI-SIGN
5753 | in: header
5754 | schema:
5755 | type: string
5756 | example: '{{signature}}'
5757 | - name: X-BAPI-API-KEY
5758 | in: header
5759 | schema:
5760 | type: string
5761 | example: '{{bybit-api-key}}'
5762 | - name: X-BAPI-TIMESTAMP
5763 | in: header
5764 | schema:
5765 | type: string
5766 | example: '{{timestamp}}'
5767 | - name: X-BAPI-RECV-WINDOW
5768 | in: header
5769 | schema:
5770 | type: string
5771 | example: '{{recvWindow}}'
5772 | - name: Content-Type
5773 | in: header
5774 | schema:
5775 | type: string
5776 | example: application/json
5777 | responses:
5778 | '200':
5779 | description: Successful response
5780 | content:
5781 | application/json: {}
5782 | /v5/broker/asset/query-sub-member-deposit-record:
5783 | get:
5784 | tags:
5785 | - Broker
5786 | summary: broker deposit records
5787 | parameters:
5788 | - name: X-BAPI-SIGN-TYPE
5789 | in: header
5790 | schema:
5791 | type: integer
5792 | example: '2'
5793 | - name: X-BAPI-SIGN
5794 | in: header
5795 | schema:
5796 | type: string
5797 | example: '{{signature}}'
5798 | - name: X-BAPI-API-KEY
5799 | in: header
5800 | schema:
5801 | type: string
5802 | example: '{{bybit-api-key}}'
5803 | - name: X-BAPI-TIMESTAMP
5804 | in: header
5805 | schema:
5806 | type: string
5807 | example: '{{timestamp}}'
5808 | - name: X-BAPI-RECV-WINDOW
5809 | in: header
5810 | schema:
5811 | type: string
5812 | example: '{{recvWindow}}'
5813 | - name: Content-Type
5814 | in: header
5815 | schema:
5816 | type: string
5817 | example: application/json
5818 | responses:
5819 | '200':
5820 | description: Successful response
5821 | content:
5822 | application/json: {}
5823 | /v5/announcements/index:
5824 | get:
5825 | tags:
5826 | - default
5827 | summary: Get Announcement
5828 | parameters:
5829 | - name: Content-Type
5830 | in: header
5831 | schema:
5832 | type: string
5833 | example: application/json
5834 | - name: locale
5835 | in: query
5836 | schema:
5837 | type: string
5838 | example: en-US
5839 | - name: limit
5840 | in: query
5841 | schema:
5842 | type: integer
5843 | example: '2'
5844 | - name: page
5845 | in: query
5846 | schema:
5847 | type: integer
5848 | example: '2'
5849 | responses:
5850 | '200':
5851 | description: Successful response
5852 | content:
5853 | application/json: {}
5854 |
```