This is page 5 of 6. Use http://codebase.md/sammcj/bybit-mcp?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
openapi: 3.0.0
info:
title: Open API V5 english standard
version: 1.0.0
servers:
- url: http://{{url}}
tags:
- name: Market
- name: Order
- name: Position
- name: Account
- name: Pre-Uprgade
- name: Asset
- name: Asset > Convert
- name: Asset > Balance
- name: Asset > Transfer
- name: Asset > Deposit
- name: Asset > Withdraw
- name: User
- name: Spot-lever-token
- name: Spot-Margin-Trade
- name: Institutional Loan
- name: Crypto Loan
- name: Broker
- name: Broker > Reward
paths:
/v5/market/time:
get:
tags:
- Market
summary: server-time
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/kline:
get:
tags:
- Market
summary: kline
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
- name: interval
in: query
schema:
type: integer
example: '5'
- name: limit
in: query
schema:
type: integer
example: '1'
- name: category
in: query
schema:
type: string
example: spot
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/mark-price-kline:
get:
tags:
- Market
summary: mark-price-kline
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signed}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{api_key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
- name: interval
in: query
schema:
type: integer
example: '15'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/index-price-kline:
get:
tags:
- Market
summary: index-price-kline
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signed}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{api_key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: inverse
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
- name: interval
in: query
schema:
type: integer
example: '1'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/premium-index-price-kline:
get:
tags:
- Market
summary: premium-index-price-kline
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signed}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{api_key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: inverse
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
- name: interval
in: query
schema:
type: integer
example: '5'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/orderbook:
get:
tags:
- Market
summary: orderbook
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signed}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{api_key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
description: linear inverse
example: option
- name: symbol
in: query
schema:
type: string
example: BTC-6JAN23-16000-C
- name: limit
in: query
schema:
type: integer
example: '2'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/instruments-info:
get:
tags:
- Market
summary: instruments-info
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signed}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{api_key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
description: BTCUSDH23
example: BTCUSDT
- name: limit
in: query
schema:
type: integer
example: '10'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/tickers:
get:
tags:
- Market
summary: tickers
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signed}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{api_key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
description: linear inverse
example: option
- name: baseCoin
in: query
schema:
type: string
example: BTC
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/funding/history:
get:
tags:
- Market
summary: funding/history
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signed}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{api_key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/risk-limit:
get:
tags:
- Market
summary: risk-limit
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signed}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{api_key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
description: BTCPERP
example: BTCUSDT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/open-interest:
get:
tags:
- Market
summary: open-interest
parameters:
- name: category
in: query
schema:
type: string
description: linear
example: linear
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
- name: intervalTime
in: query
schema:
type: string
example: 5min
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/insurance:
get:
tags:
- Market
summary: insurance
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/recent-trade:
get:
tags:
- Market
summary: recent-trade
parameters:
- name: category
in: query
schema:
type: string
description: linear
example: option
- name: symbol
in: query
schema:
type: string
example: ETH-30JUN23-2050-C
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/delivery-price:
get:
tags:
- Market
summary: delivery-price
parameters:
- name: category
in: query
schema:
type: string
example: option
- name: baseCoin
in: query
schema:
type: string
example: BTC
- name: limit
in: query
schema:
type: integer
example: '10'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/account-ratio:
get:
tags:
- Market
summary: Get Long Short Ratio
parameters:
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
- name: period
in: query
schema:
type: string
example: 1h
- name: limit
in: query
schema:
type: integer
example: '50'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/market/historical-volatility:
get:
tags:
- Market
summary: historical-volatility
parameters:
- name: category
in: query
schema:
type: string
example: option
- name: period
in: query
schema:
type: integer
example: '7'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/create:
post:
tags:
- Order
summary: create（Conditional Order）
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\":\"spot\",\n \"symbol\":
\"BTCUSDT\",\n \"side\": \"Buy\",\n \"positionIdx\":
0,\n \"orderType\": \"Limit\",\n \"qty\": \"0.001\",\n
\"price\": \"20000\",\n \"triggerDirection\": 1,\n
\"triggerPrice\": \"27265\",\n \"triggerBy\":
\"MarkPrice\",\n \"timeInForce\": \"GTC\",\n
\"orderLinkId\": \"1234566\",\n \"takeProfit\": \"\",\n
\"stopLoss\": \"\",\n \"reduce_only\": false,\n
\"closeOnTrigger\": false,\n
\"orderFilter\":\"tpslOrder\"\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/create-batch:
post:
tags:
- Order
summary: create-batch
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\":\"option\", \n \"request\": [ \n { \n
\"category\":\"option\", \n \"symbol\":\"BTC-10FEB23-24000-C\",
\n \"orderType\":\"Limit\", \n \"side\":\"Buy\", \n
\"qty\":\"0.1\", \n \"price\":\"5\", \n \"iv\":\"0.1\", \n
\"timeInForce\":\"GTC\", \n \"orderLinkId\":\"9b381bb1-401\",
\n \"mmp\":false, \n \"reduceOnly\":false \n },\n { \n
\"category\":\"option\", \n \"symbol\":\"BTC-10FEB23-24000-C\",
\n \"orderType\":\"Limit\", \n \"side\":\"Buy\", \n
\"qty\":\"0.1\", \n \"price\":\"5\", \n \"iv\":\"0.1\", \n
\"timeInForce\":\"GTC\", \n \"orderLinkId\":\"82ee86dd-001\",
\n \"mmp\":false, \n \"reduceOnly\":false \n } \n ]\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/amend-batch:
post:
tags:
- Order
summary: amend-batch
requestBody:
content:
'*/*':
schema:
type: string
example: >-
" {\n \"category\":\"option\", \n \"request\": [ \n { \n
\"category\":\"null\", \n \"symbol\":\"BTC-30DEC22-44000-C\",
\n \"qty\":\"0.1\", \n \"orderLinkId\":\"\", \n
\"orderId\":\"\", \n \"iv\":\"0.1\" \n },\n { \n
\"category\":\"null\", \n \"symbol\":\"\", \n \"qty\":\"0.1\",
\n \"orderLinkId\":\"82ee86dd-00\", \n
\"orderId\":\"60c257f9-57cc-47a3-95cb-811f55fa793c\", \n
\"iv\":\"0.1\" \n }\n ]\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/cancel-batch:
post:
tags:
- Order
summary: cancel-batch
requestBody:
content:
'*/*':
schema:
type: string
example: >-
" {\n \"category\":\"option\", \n \"request\": [ \n { \n
\"category\":\"null\", \n \"symbol\":\"BTC-30DEC22-44000-C\",
\n \"orderLinkId\":\"4197d261-d2\", \n
\"orderId\":\"0ccd205e-5145-4f27-9402-2f47674098fa\" \n },\n
{ \n \"category\":\"null\", \n
\"symbol\":\"BTC-30DEC22-44000-C\", \n
\"orderLinkId\":\"90d272e8-24\", \n
\"orderId\":\"17f51491-584f-41c4-ae22-c9cdf916b1db\" \n }\n ]\n
}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/amend:
post:
tags:
- Order
summary: amend
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\":\"linear\",\n
\"symbol\":\"BTCUSDT\",\n
\"orderId\":\"a51bdc00-40e8-494f-b38a-1120fdaeecc3\",\n
\"price\": \"28000\",\n \"qty\":\"0.001\"\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/cancel:
post:
tags:
- Order
summary: cancel
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\": \"linear\",\n \"symbol\": \"BTCUSDT\",\n
\"orderId\":\"9d3ef617-f214-4818-979e-20b44256dbec\"\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/cancel-all:
post:
tags:
- Order
summary: cancel-all Copy
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"category\": \"spot\",\n \"settleCoin\":\"USDT\"\n}"'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/realtime:
get:
tags:
- Order
summary: Get Open & Closed Orders
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: cdn-request-id
in: header
schema:
type: string
example: tttt
- name: orderId
in: query
schema:
type: integer
example: '1401404332739465472'
- name: category
in: query
schema:
type: string
example: spot
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/history:
get:
tags:
- Order
summary: Get Order History
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: spot
- name: orderId
in: query
schema:
type: integer
example: '1402058681081733376'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/spot-borrow-check:
get:
tags:
- Order
summary: Get Borrow Quota (Spot)
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: spot
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
- name: side
in: query
schema:
type: string
example: Sell
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/execution/list:
get:
tags:
- Order
summary: Get Trade History
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
example: XRPUSDT
- name: execType
in: query
schema:
type: string
example: Funding
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/list:
get:
tags:
- Position
summary: position/list
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: symbol
in: query
schema:
type: string
example: BTCPERP
- name: category
in: query
schema:
type: string
example: linear
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/switch-isolated:
post:
tags:
- Position
summary: switch-isolated
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\":\"linear\",\n
\"symbol\":\"BTC-31MAR23\",\n \"tradeMode\":\"0\",\n
\"buyLeverage\":\"5\",\n \"sellLeverage\":\"5\"\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/switch-mode:
post:
tags:
- Position
summary: switch-mode
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\":\"linear\",\n
\"symbol\":\"BTCUSDT\",\n \"mode\": 3\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/trading-stop:
post:
tags:
- Position
summary: trading-stop
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\":\"linear\",\n \"symbol\":
\"BTCUSDT\",\n \"takeProfit\": \"20000\",\n \"stopLoss\":
\"10000\",\n \"tpTriggerBy\": \"MarkPrice\",\n
\"slTriggerBy\": \"IndexPrice\",\n \"positionIdx\": 0\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/set-leverage:
post:
tags:
- Position
summary: set-leverage
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\": \"linear\",\n
\"symbol\":\"BTCPERP\",\n \"buyLeverage\":\"2\",\n
\"sellLeverage\":\"2\"\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/set-auto-add-margin:
post:
tags:
- Position
summary: set-auto-add-margin
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\": \"linear\",\n \"symbol\":
\"BTCPERP\",\n \"autoAddmargin\": 1,\n \"positionIdx\":
1\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/closed-pnl:
get:
tags:
- Position
summary: closed-pnl
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
description: LINKUSDT
example: BTCUSDT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/set-tpsl-mode:
post:
tags:
- Position
summary: set-tpsl-mode(Depreciated)
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"symbol\": \"BTCUSDT\",\n \"category\":
\"linear\",\n \"tpSlMode\": \"Full\"\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/set-risk-limit:
post:
tags:
- Position
summary: set-risk-limit(Depreciated)
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"category\": \"linear\",\n \"symbol\": \"BTCUSDT\",
\n \"riskId\": \"1\", \n \"positionIdx\": 0\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/move-positions:
post:
tags:
- Position
summary: move position Copy
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"fromUid\": \"1635703\",\n \"toUid\":
\"100503864\",\n \"list\": [\n {\n
\"category\": \"spot\",\n \"symbol\":
\"BTCUSDT\",\n \"price\": \"45000\",\n
\"side\": \"Sell\",\n \"qty\": \"0.01\"\n
}\n ]\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/position/move-history:
get:
tags:
- Position
summary: get move position history Copy
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/wallet-balance:
get:
tags:
- Account
summary: wallet-balance
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: accountType
in: query
schema:
type: string
example: UNIFIED
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/coin-greeks:
get:
tags:
- Account
summary: coin-greeks
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: baseCoin
in: query
schema:
type: string
example: BTC
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/collateral-info:
get:
tags:
- Account
summary: collateral-info
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: currency
in: query
schema:
type: string
example: AVAX
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/info:
get:
tags:
- Account
summary: account/info
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/fee-rate:
get:
tags:
- Account
summary: fee-rate
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/transaction-log:
get:
tags:
- Account
summary: transaction-log UTA
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: accountType
in: query
schema:
type: string
example: contract
- name: category
in: query
schema:
type: string
example: linear
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/contract-transaction-log:
get:
tags:
- Account
summary: transaction-log classic
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: type
in: query
schema:
type: string
example: TRADE
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/borrow-history:
get:
tags:
- Account
summary: borrow-history
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: spot
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/upgrade-to-uta:
post:
tags:
- Account
summary: upgrade-to-uta
requestBody:
content:
'*/*':
schema:
type: string
example: '"{}"'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/set-margin-mode:
post:
tags:
- Account
summary: set-margin-mode
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"setMarginMode\": \"REGULAR_MARGIN\"\n}"'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/mmp-modify:
post:
tags:
- Account
summary: set mmp
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\n \"baseCoin\": \"BTC\",\n \"window\":\"5000\",\n
\"frozenPeriod\":\"100000\",\n \"qtyLimit\":\"0.01\",\n
\"deltaLimit\":\"0.01\"\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/mmp-reset:
post:
tags:
- Account
summary: reset mmp
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"baseCoin\": \"BTC\"\n}"'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/order/disconnected-cancel-all:
post:
tags:
- Account
summary: disconnected-cancel-all
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"category\": \"option\",\n \"timeWindow\": 5\n}"'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/query-dcp-info:
get:
tags:
- Account
summary: Get DCP Info
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/smp-group:
get:
tags:
- Account
summary: Get SMP Group ID
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/account/mmp-state:
get:
tags:
- Account
summary: Get MMP State
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/pre-upgrade/order/history:
get:
tags:
- Pre-Uprgade
summary: Get Pre-upgrade Order History
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: spot
- name: orderStatus
in: query
schema:
type: string
example: Created
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/pre-upgrade/execution/list:
get:
tags:
- Pre-Uprgade
summary: Get Pre-upgrade Trade History
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: limit
in: query
schema:
type: integer
example: '1'
- name: execType
in: query
schema:
type: string
example: Funding
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/pre-upgrade/account/transaction-log:
get:
tags:
- Pre-Uprgade
summary: Get Pre-upgrade Transaction Log
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: option
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/pre-upgrade/position/closed-pnl:
get:
tags:
- Pre-Uprgade
summary: Get Pre-upgrade close pnl
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
example: BTCUSDT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/pre-upgrade/asset/delivery-record:
get:
tags:
- Pre-Uprgade
summary: Get Pre-upgrade Option Delivery Record
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: option
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/pre-upgrade/asset/settlement-record:
get:
tags:
- Pre-Uprgade
summary: Get Pre-upgrade USDC Session Settlement
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
example: ETHPERP
- name: limit
in: query
schema:
type: integer
example: '1'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/exchange/query-coin-list:
get:
tags:
- Asset > Convert
summary: get convert coin list
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: coin
in: query
schema:
type: string
example: BTC
- name: accountType
in: query
schema:
type: string
example: eb_convert_uta
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/exchange/convert-result-query:
get:
tags:
- Asset > Convert
summary: Get Convert Status
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: quoteTxId
in: query
schema:
type: integer
example: '10100223252423685843314909184'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/exchange/query-convert-history:
get:
tags:
- Asset > Convert
summary: Get Convert history
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/exchange/quote-apply:
post:
tags:
- Asset > Convert
summary: Request a Quote
requestBody:
content:
application/json:
schema:
type: object
example:
fromCoin: BTC
toCoin: ETH
accountType: eb_convert_uta
requestCoin: BTC
requestAmount: '1'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/exchange/convert-execute:
post:
tags:
- Asset > Convert
summary: Confirm Quote
requestBody:
content:
application/json:
schema:
type: object
example:
quoteTxId: '10102225215434451987621355520'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/query-account-coin-balance:
get:
tags:
- Asset > Balance
summary: transfer/query-account-coin-balance
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: accountType
in: query
schema:
type: string
example: SPOT
- name: coin
in: query
schema:
type: string
example: USDT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/query-account-coins-balance:
get:
tags:
- Asset > Balance
summary: transfer/query-account-coins-balance
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: accountType
in: query
schema:
type: string
example: SPOT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/withdraw/withdrawable-amount:
get:
tags:
- Asset > Balance
summary: Get Withdrawable Amount
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: coin
in: query
schema:
type: string
example: USDT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/query-asset-info:
get:
tags:
- Asset > Balance
summary: transfer/query-asset-info Copy
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: accountType
in: query
schema:
type: string
example: SPOT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/query-sub-member-list:
get:
tags:
- Asset
summary: Get Sub UID
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/query-inter-transfer-list:
get:
tags:
- Asset > Transfer
summary: transfer/query-inter-transfer-list
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/query-universal-transfer-list:
get:
tags:
- Asset > Transfer
summary: transfer/query-universal-transfer-list
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/save-transfer-sub-member:
post:
tags:
- Asset > Transfer
summary: transfer/save-transfer-sub-member
requestBody:
content:
application/json:
schema:
type: object
example:
subMemberIds: '4255068'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/query-transfer-coin-list:
get:
tags:
- Asset > Transfer
summary: transfer/query-transfer-coin-list
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: fromAccountType
in: query
schema:
type: string
example: SPOT
- name: toAccountType
in: query
schema:
type: string
example: CONTRACT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/inter-transfer:
post:
tags:
- Asset > Transfer
summary: transfer/inter-transfer
requestBody:
content:
application/json:
schema:
type: object
example:
fromAccountType: UNIFIED
toAccountType: SPOT
amount: '1'
coin: USDT
transferId: 11ff9b44-2d5d-4293-913d-4597c9ad2188
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/transfer/universal-transfer:
post:
tags:
- Asset > Transfer
summary: transfer/universal-transfer
requestBody:
content:
application/json:
schema:
type: object
example:
fromAccountType: UNIFIED
toAccountType: USDC
amount: '5000'
coin: USDC
transfer_id: 72b41935-3174-c52d-85d1-7329df0cb636
from_member_id: '290118'
to_member_id: '1135134'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/deposit/query-address:
get:
tags:
- Asset > Deposit
summary: deposit/query-address
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: coin
in: query
schema:
type: string
example: BTC
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/deposit/query-allowed-list:
get:
tags:
- Asset > Deposit
summary: deposit/query-allowed-list
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/deposit/query-record:
get:
tags:
- Asset > Deposit
summary: deposit/query-record
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/deposit/query-sub-member-address:
get:
tags:
- Asset > Deposit
summary: deposit/query-sub-member-address
parameters:
- name: coin
in: query
schema:
type: string
example: BTC
- name: chainType
in: query
schema:
type: string
example: BTC
- name: subMemberId
in: query
schema:
type: integer
example: '4255068'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/deposit/query-sub-member-record:
get:
tags:
- Asset > Deposit
summary: deposit/query-sub-member-record
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: subMemberId
in: query
schema:
type: integer
example: '4255068'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/withdraw/query-record:
get:
tags:
- Asset > Withdraw
summary: withdraw/query-record
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/withdraw/create:
post:
tags:
- Asset > Withdraw
summary: withdraw/create
requestBody:
content:
application/json:
schema:
type: object
example:
chain: BTC
coin: BTC
address: n3Hy3vwUY1sqbXhvFbaCbtoM2ZnbSnqa1J
amount: '0.0213'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/withdraw/cancel:
post:
tags:
- Asset > Withdraw
summary: withdraw/cancel
requestBody:
content:
application/json:
schema:
type: object
example:
id: 36604
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/settlement-record:
get:
tags:
- Asset
summary: settlement-record
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
- name: symbol
in: query
schema:
type: string
example: BTCPERP
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/exchange/order-record:
get:
tags:
- Asset
summary: exchange/order-record
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: limit
in: query
schema:
type: integer
example: '10'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/coin/query-info:
get:
tags:
- Asset
summary: coin/query-info
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: coin
in: query
schema:
type: string
example: USDT
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/asset/delivery-record:
get:
tags:
- Asset
summary: delivery-record
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: category
in: query
schema:
type: string
example: linear
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/create-sub-member:
post:
tags:
- User
summary: Create Sub UID
requestBody:
content:
application/json:
schema:
type: object
example:
username: 06062024Test
memberType: 1
switch: 1
isUta: true
note: testnet sub UM acct
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/create-sub-api:
post:
tags:
- User
summary: Create SubUid apikey
requestBody:
content:
application/json:
schema:
type: object
example:
subuid: 1187021
note: 10thtest2
readOnly: 1
ips:
- '*'
permissions:
ContractTrade:
- Order
- Position
Spot:
- SpotTrade
Wallet:
- AccountTransfer
Options:
- OptionsTrade
Derivatives:
- DerivativesTrade
CopyTrading:
- CopyTrading
BlockTrade:
- BlockTrade
Exchange:
- ExchangeHistory
NFT:
- NFTQueryProductList
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/query-sub-members:
get:
tags:
- User
summary: get Sub members list
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/submembers:
get:
tags:
- User
summary: Get Sub UID List (Unlimited)
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/query-api:
get:
tags:
- User
summary: query uid's apikey info
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/sub-apikeys:
get:
tags:
- User
summary: Get Sub Account All API Keys
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: subMemberId
in: query
schema:
type: integer
description: Sub UID
example: '100312051'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/get-member-type:
get:
tags:
- User
summary: Get UID Wallet Type
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/aff-customer-info:
get:
tags:
- User
summary: Get Affiliate User Info
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/frozen-sub-member:
post:
tags:
- User
summary: Froze Sub UID
requestBody:
content:
application/json:
schema:
type: object
example:
subuid: 1187021
frozen: 0
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/del-submember:
post:
tags:
- User
summary: delete Sub UID
requestBody:
content:
application/json:
schema:
type: object
example:
subMemberId: '101472685'
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/update-api:
post:
tags:
- User
summary: Modify Master uid's api key permission
requestBody:
content:
application/json:
schema:
type: object
example:
readOnly: 0
ips:
- 138.113.117.38
permissions:
ContractTrade:
- Order
- Position
Spot:
- SpotTrade
Wallet:
- AccountTransfer
- SubMemberTransfer
Options:
- OptionsTrade
Derivatives:
- DerivativesTrade
CopyTrading:
- CopyTrading
BlockTrade:
- BlockTrade
Exchange:
- ExchangeHistory
NFT:
- NFTQueryProductList
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/delete-api:
post:
tags:
- User
summary: delete master uid apikey
requestBody:
content:
application/json:
schema:
type: object
example: {}
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/update-sub-api:
post:
tags:
- User
summary: Modify sub uid's api key permission
requestBody:
content:
application/json:
schema:
type: object
example:
readOnly: 0
ips:
- '*'
permissions:
ContractTrade:
- Order
- Position
Spot:
- SpotTrade
Wallet:
- AccountTransfer
- SubMemberTransfer
Options:
- OptionsTrade
Derivatives:
- DerivativesTrade
CopyTrading:
- CopyTrading
BlockTrade:
- BlockTrade
Exchange:
- ExchangeHistory
NFT:
- NFTQueryProductList
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/user/delete-sub-api:
post:
tags:
- User
summary: delete sub uid apikey (use the api key pending to remove)
requestBody:
content:
application/json:
schema:
type: object
example: {}
parameters:
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-lever-token/info:
get:
tags:
- Spot-lever-token
summary: spot-lever-token/info
parameters:
- name: ltCoin
in: query
schema:
type: string
example: BTC3L
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-lever-token/reference:
get:
tags:
- Spot-lever-token
summary: spot-lever-token/reference
parameters:
- name: ltCoin
in: query
schema:
type: string
example: BTC3L
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-lever-token/purchase:
post:
tags:
- Spot-lever-token
summary: spot-lever-token/purchase
requestBody:
content:
application/json:
schema:
type: object
example:
ltCoin: BTC3L
amount: '100'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-lever-token/redeem:
post:
tags:
- Spot-lever-token
summary: spot-lever-token/redeem
requestBody:
content:
application/json:
schema:
type: object
example:
ltCoin: BTC3L
quantity: '0.1'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-lever-token/order-record:
get:
tags:
- Spot-lever-token
summary: spot-lever-token/order-record
parameters:
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-margin-trade/data:
get:
tags:
- Spot-Margin-Trade
summary: Get VIP Margin Data
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: vipLevel
in: query
schema:
type: string
example: PRO-5
- name: currency
in: query
schema:
type: string
example: BNB
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-margin-trade/interest-rate-history:
get:
tags:
- Spot-Margin-Trade
summary: Get Historical Interest Rate
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: currency
in: query
schema:
type: string
example: USDC
- name: vipLevel
in: query
schema:
type: string
example: No%20VIP
- name: startTime
in: query
schema:
type: integer
example: '1721458800000'
- name: endTime
in: query
schema:
type: integer
example: '1721469600000'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-margin-trade/state:
get:
tags:
- Spot-Margin-Trade
summary: Get Status And Leverage
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-margin-trade/switch-mode:
post:
tags:
- Spot-Margin-Trade
summary: spot-margin-trade/switch-mode
requestBody:
content:
application/json:
schema:
type: object
example:
spotMarginMode: '1'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/spot-margin-trade/set-leverage:
post:
tags:
- Spot-Margin-Trade
summary: spot-margin-trade/set-leverage
requestBody:
content:
application/json:
schema:
type: object
example:
leverage: 3
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/ins-loan/ltv:
get:
tags:
- Institutional Loan
summary: Get Repay Orders
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/ins-loan/association-uid:
post:
tags:
- Institutional Loan
summary: Bind Or Unbind UID
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\r\n \"uid\": \"592324\",\r\n \"operate\": \"0\"\r\n}"'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/crypto-loan/ongoing-orders:
get:
tags:
- Crypto Loan
summary: Get Unpaid Loan Orders
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: repayId
in: query
schema:
type: integer
example: '1794532027145157120'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/crypto-loan/max-collateral-amount:
get:
tags:
- Crypto Loan
summary: Get Max. Allowed Reduction Collateral Amount
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: orderId
in: query
schema:
type: integer
example: '1794531321268959232'
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/crypto-loan/borrow-history:
get:
tags:
- Crypto Loan
summary: Get Completed Loan Order History
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/crypto-loan/collateral-data:
get:
tags:
- Crypto Loan
summary: Get crypto Loan Borrowable Coins Copy
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/crypto-loan/adjustment-history:
get:
tags:
- Crypto Loan
summary: Get Loan LTV Adjustment History
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/crypto-loan/borrow:
post:
tags:
- Crypto Loan
summary: Borrow Crypto loan
requestBody:
content:
application/json:
schema:
type: object
example:
loanCurrency: USDT
loanAmount: '550'
collateralCurrency: BTC
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/crypto-loan/repay:
post:
tags:
- Crypto Loan
summary: Repay Crypto loan
requestBody:
content:
application/json:
schema:
type: object
example:
orderId: '1794531321268959232'
amount: '0.000771'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/crypto-loan/adjust-ltv:
post:
tags:
- Crypto Loan
summary: Adjust Collateral Amount
requestBody:
content:
application/json:
schema:
type: object
example:
orderId: '1794531321268959232'
amount: '550'
direction: '0'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/broker/award/distribution-record:
post:
tags:
- Broker > Reward
summary: Query Issued Voucher
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\r\n \"accountId\": \"5714139\",\r\n \"awardId\":
\"189528\",\r\n \"specCode\": \"demo000\",\r\n
\"withUsedAmount\": false\r\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/broker/award/info:
post:
tags:
- Broker > Reward
summary: Query Voucher Spec
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\r\n \"id\": \"80209\"\r\n}"'
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/broker/award/distribute-award:
post:
tags:
- Broker > Reward
summary: Query Issued Voucher Copy 2
requestBody:
content:
'*/*':
schema:
type: string
example: >-
"{\r\n \"accountId\": \"2846381\",\r\n \"awardId\":
\"123456\",\r\n \"specCode\": \"award-001\",\r\n
\"amount\": \"100\",\r\n \"brokerId\": \"v-28478\"\r\n}"
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/broker/account-info:
get:
tags:
- Broker
summary: Broker Account Info
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/broker/earning-record:
get:
tags:
- Broker
summary: Get Broker Earning
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/broker/asset/query-sub-member-deposit-record:
get:
tags:
- Broker
summary: broker deposit records
parameters:
- name: X-BAPI-SIGN-TYPE
in: header
schema:
type: integer
example: '2'
- name: X-BAPI-SIGN
in: header
schema:
type: string
example: '{{signature}}'
- name: X-BAPI-API-KEY
in: header
schema:
type: string
example: '{{bybit-api-key}}'
- name: X-BAPI-TIMESTAMP
in: header
schema:
type: string
example: '{{timestamp}}'
- name: X-BAPI-RECV-WINDOW
in: header
schema:
type: string
example: '{{recvWindow}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
/v5/announcements/index:
get:
tags:
- default
summary: Get Announcement
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: locale
in: query
schema:
type: string
example: en-US
- name: limit
in: query
schema:
type: integer
example: '2'
- name: page
in: query
schema:
type: integer
example: '2'
responses:
'200':
description: Successful response
content:
application/json: {}
```