bybit-api
Version:
Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.
2,226 lines (2,079 loc) • 439 kB
Plain Text
This file is a merged representation of a subset of the codebase, containing files not matching ignore patterns, combined into a single document by Repomix.
The content has been processed where content has been compressed (code blocks are separated by ⋮---- delimiter).
================================================================
File Summary
================================================================
Purpose:
--------
This file contains a packed representation of a subset of the repository's contents that is considered the most important context.
It is designed to be easily consumable by AI systems for analysis, code review,
or other automated processes.
File Format:
------------
The content is organized as follows:
1. This summary section
2. Repository information
3. Directory structure
4. Repository files (if enabled)
5. Multiple file entries, each consisting of:
a. A separator line (================)
b. The file path (File: path/to/file)
c. Another separator line
d. The full contents of the file
e. A blank line
Usage Guidelines:
-----------------
- This file should be treated as read-only. Any changes should be made to the
original repository files, not this packed version.
- When processing this file, use the file path to distinguish
between different files in the repository.
- Be aware that this file may contain sensitive information. Handle it with
the same level of security as you would the original repository.
Notes:
------
- Some files may have been excluded based on .gitignore rules and Repomix's configuration
- Binary files are not included in this packed representation. Please refer to the Repository Structure section for a complete list of file paths, including binary files
- Files matching these patterns are excluded: .github/, docs/images/, docs/endpointFunctionList.md, test/, src/util/
- Files matching patterns in .gitignore are excluded
- Files matching default ignore patterns are excluded
- Content has been compressed - code blocks are separated by ⋮---- delimiter
- Files are sorted by Git change count (files with more changes are at the bottom)
================================================================
Directory Structure
================================================================
examples/
apidoc/
V5/
Account/
batch-set-collateral-coin.js
get-account-info.js
get-borrow-history.js
get-coin-greeks.js
get-collateral-info.js
get-dcp-info.js
get-fee-rate.js
get-mmp-state.js
get-smp-group-id.js
get-transaction-log-classic.js
get-transaction-log-UTA.js
get-transferable-amount-unified.js
get-wallet-balance.js
README.md
repay-liability.js
reset-mmp.js
set-collateral-coin.js
set-limit-price-behaviour.js
set-margin-mode.js
set-mmp.js
set-spot-hedging.js
upgrade-to-unified-account.js
Affiliate/
get-affiliate-user-info.js
get-affiliate-user-list.js
Asset/
cancel-withdrawal.js
confirm-convert-quote.js
create-internal-transfer.js
create-universal-transfer.js
enable-universal-transfer-for-sub-uid.js
get-all-coins-balance.js
get-allowed-deposit-coin-info.js
get-asset-info-spot.js
get-coin-exchange-records.js
get-coin-info.js
get-convert-coins.js
get-convert-history.js
get-convert-status.js
get-delivery-record.js
get-deposit-records.js
get-exchange-entity-list.js
get-internal-deposit-records.js
get-internal-transfer-records.js
get-master-deposit-address.js
get-single-coin-balance.js
get-sub-deposit-address.js
get-sub-deposit-records.js
get-sub-uid.js
get-transferable-coin.js
get-universal-transfer-records.js
get-usdc-session-settlement.js
get-withdrawable-amount.js
get-withdrawal-records.js
README.md
request-convert-quote.js
set-deposit-account.js
withdraw.js
Broker/
get-exchange-broker-account-info.js
get-exchange-broker-earning.js
get-subaccount-deposit-records.js
issue-voucher.js
query-issued-voucher.js
query-voucher-spec.js
Crypto-Loan-Legacy/
adjust-collateral-amount.js
borrow.js
get-account-borrow-collateral-limit.js
get-borrowable-coins.js
get-collateral-coins.js
get-completed-loan-order-history.js
get-loan-LTV-adjustment-history.js
get-max-allowed-reduction-collateral-amount.js
get-repayment-transaction-history.js
get-unpaid-loan-orders.js
repay.js
Crypto-Loan-New/
Fixed-Loan/
cancel-borrow-order.js
cancel-supply-order.js
create-borrow-order.js
create-supply-order.js
get-borrow-contract-info.js
get-borrow-order-info.js
get-borrow-order-quote.js
get-repayment-history.js
get-supply-contract-info.js
get-supply-order-info.js
get-supply-order-quote.js
repay.js
Flexible-Loan/
borrow.js
get-borrow-history.js
get-ongoing-flexible-loans.js
get-repayment-history.js
repay.js
adjust-collateral-amount.js
get-borrowable-coins.js
get-collateral-adjustment-history.js
get-collateral-coins.js
get-crypto-loan-position.js
get-max-collateral-amount.js
Earn/
get-product-info.js
get-stake-redeem-order-history.js
get-staked-position.js
stake-redeem.js
Institutional-Loan/
bind-or-unbind-uid.js
get-loan-orders.js
get-LTV.js
get-margin-coin-info.js
get-product-info.js
get-repayment-orders.js
Market/
get-Bybit-server-time.js
get-delivery-price.js
get-funding-rate-history.js
get-historical-volatility.js
get-instruments-info.js
get-insurance.js
get-kline-index-price.js
get-kline-mark-price.js
get-kline-premium-index-price.js
get-kline.js
get-long-short-ratio.js
get-open-interest.js
get-order-price-limit.js
get-orderbook.js
get-public-trading-history.js
get-risk-limit.js
get-tickers.js
README.md
P2P/
get-account-information.js
get-ad-detail.js
get-all-orders.js
get-chat-message.js
get-coin-balance.js
get-counterparty-user-info.js
get-market-online-ads-list.js
get-my-ads-list.js
get-order-detail.js
get-pending-orders.js
get-user-payment.js
mark-order-as-paid.js
post-new-ad.js
release-digital-asset.js
remove-my-ad.js
send-chat-message.js
update-relist-my-ad.js
upload-chat-file.js
Position/
add-or-reduce-margin.js
confirm-new-risk-limit.js
get-closed-options-positions.js
get-closed-pnl.js
get-execution.js
get-move-position-history.js
get-position-info.js
move-position.js
README.md
set-auto-add-margin.js
set-leverage.js
set-risk-limit.js
set-tpsl-mode.js
set-trading-stop.js
switch-cross-isolated-margin.js
switch-position-mode.js
Preupgrade/
get-preupgrade-closed-pnl.js
get-preupgrade-option-delivery-record.js
get-preupgrade-order-history.js
get-preupgrade-trade-history.js
get-preupgrade-transaction-log.js
get-preupgrade-USDC-session-settlement.js
Spot-Leverage-Token/
get-leverage-token-info.js
get-leveraged-token-market.js
get-purchase-redemption-records.js
purchase.js
README.md
redeem.js
Spot-Margin-Trade-(Normal)/
borrow.js
get-borrow-order-detail.js
get-borrowable-coin-info.js
get-interest-and-quota.js
get-loan-account-info.js
get-margin-coin-info.js
get-repayment-order-detail.js
README.md
repay.js
toggle-margin-trade-normal.js
Spot-Margin-Trade-(UTA)/
get-historical-interest-rate.js
get-status-and-leverage.js
get-vip-margin-data.js
README.md
set-leverage.js
toggle-margin-trade.js
Spread-Trading/
amend-spread-order.js
cancel-all-spread-orders.js
cancel-spread-order.js
create-spread-order.js
get-spread-instruments-info.js
get-spread-open-orders.js
get-spread-order-history.js
get-spread-orderbook.js
get-spread-tickers.js
get-spread-trade-history.js
Trade/
amend-order.js
batch-amend-order.js
batch-cancel-order.js
batch-place-order.js
cancel-all-orders.js
cancel-order.js
confirm-new-risk-limit.js
get-move-position-history.js
get-open-orders.js
get-order-history.js
get-spot-borrow-quota.js
move-position.js
place-order.js
pre-check-order.js
README.md
set-dcp.js
User/
create-sub-uid-api-key.js
create-sub-uid.js
delete-master-api-key.js
delete-sub-api-key.js
delete-sub-uid.js
freeze-sub-uid.js
get-api-key-info.js
get-sub-all-api-keys.js
get-sub-uid-list-unlimited.js
get-sub-uid-list.js
get-uid-wallet-type.js
modify-master-api-key.js
modify-sub-api-key.js
README.md
README.md
typescripttest.ts
deprecated/
README.md
demo-trading.ts
fasterHmacSign.ts
README.md
rest-v5-all.ts
rest-v5-custom-url.ts
rest-v5-next-cursor.ts
rest-v5-private.ts
rest-v5-proxies.ts
rest-v5-proxies2.ts
rest-v5-public.ts
ws-api-client.ts
ws-api-raw-events.ts
ws-api-raw-promises.ts
ws-private-v5.ts
ws-public-allLiquidations.ts
ws-public-v5.ts
src/
constants/
enum.ts
types/
request/
account-asset.ts
contract.ts
copy-trading.ts
index.ts
inverse.ts
linear.ts
unified-margin.ts
usdc-options.ts
usdc-perp.ts
usdc-shared.ts
v5-account.ts
v5-asset.ts
v5-broker.ts
v5-crypto-loan.ts
v5-earn.ts
v5-market.ts
v5-p2p-trading.ts
v5-position.ts
v5-pre-upgrade.ts
v5-rfq.ts
v5-spot-leverage-token.ts
v5-spreadtrading.ts
v5-trade.ts
v5-user.ts
response/
account-asset.ts
contract.ts
index.ts
shared.ts
spot.ts
unified-margin.ts
usdt-perp.ts
v5-account.ts
v5-asset.ts
v5-broker.ts
v5-crypto-loan.ts
v5-earn.ts
v5-market.ts
v5-p2p-trading.ts
v5-position.ts
v5-preupgrade.ts
v5-rfq.ts
v5-spot-leverage-token.ts
v5-spreadtrading.ts
v5-trade.ts
v5-user.ts
websockets/
index.ts
ws-api.ts
ws-confirmations.ts
ws-events.ts
ws-general.ts
index.ts
shared-v5.ts
shared.ts
index.ts
rest-client-v5.ts
spot-client-v3.ts
websocket-api-client.ts
websocket-client.ts
webpack/
webpack.config.js
.eslintrc.cjs
.gitignore
.jshintrc
.nvmrc
.prettierrc
index.js
jest.config.ts
jsconfig.json
LICENSE.md
package.json
README.md
tea.yaml
tsconfig.build.json
tsconfig.examples.json
tsconfig.json
tsconfig.linting.json
tsconfig.test.json
================================================================
Files
================================================================
================
File: examples/apidoc/V5/Account/batch-set-collateral-coin.js
================
const client = new RestClientV5({
⋮----
.batchSetCollateralCoin({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-account-info.js
================
const client = new RestClientV5({
⋮----
.getAccountInfo()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-borrow-history.js
================
const client = new RestClientV5({
⋮----
.getBorrowHistory({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-coin-greeks.js
================
const client = new RestClientV5({
⋮----
.getCoinGreeks('BTC')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-collateral-info.js
================
const client = new RestClientV5({
⋮----
.getCollateralInfo('BTC')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-dcp-info.js
================
const client = new RestClientV5({
⋮----
.getDCPInfo()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-fee-rate.js
================
const client = new RestClientV5({
⋮----
.getFeeRate({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-mmp-state.js
================
const client = new RestClientV5({
⋮----
.getMMPState('ETH')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-smp-group-id.js
================
const client = new RestClientV5({
⋮----
.getSMPGroup()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-transaction-log-classic.js
================
const client = new RestClientV5({
⋮----
.getClassicTransactionLogs({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-transaction-log-UTA.js
================
const client = new RestClientV5({
⋮----
.getTransactionLog({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-transferable-amount-unified.js
================
const client = new RestClientV5({
⋮----
.getTransferableAmount({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/get-wallet-balance.js
================
const client = new RestClientV5({
⋮----
.getWalletBalance({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/README.md
================
# V5 - REST - Account
https://bybit-exchange.github.io/docs/v5/account/wallet-balance
================
File: examples/apidoc/V5/Account/repay-liability.js
================
const client = new RestClientV5({
⋮----
.repayLiability({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/reset-mmp.js
================
const client = new RestClientV5({
⋮----
.resetMMP('ETH')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/set-collateral-coin.js
================
const client = new RestClientV5({
⋮----
.setCollateralCoin({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/set-margin-mode.js
================
const client = new RestClientV5({
⋮----
.setMarginMode('PORTFOLIO_MARGIN')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/set-mmp.js
================
const client = new RestClientV5({
⋮----
.setMMP({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/set-spot-hedging.js
================
const client = new RestClientV5({
⋮----
.setSpotHedging({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Account/upgrade-to-unified-account.js
================
const client = new RestClientV5({
⋮----
.upgradeToUnifiedAccount()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Affiliate/get-affiliate-user-info.js
================
// https://api.bybit.com/v5/broker/account-info
⋮----
const client = new RestClientV5({
⋮----
.getAffiliateUserInfo({ uid: '1234567890' })
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Affiliate/get-affiliate-user-list.js
================
// https://api.bybit.com/v5/broker/account-info
⋮----
const client = new RestClientV5({
⋮----
.getAffiliateUserList()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/cancel-withdrawal.js
================
const client = new RestClientV5({
⋮----
.cancelWithdrawal('10197')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/confirm-convert-quote.js
================
const client = new RestClientV5({
⋮----
.confirmConvertQuote({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/create-internal-transfer.js
================
const client = new RestClientV5({
⋮----
.createInternalTransfer(
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/create-universal-transfer.js
================
const client = new RestClientV5({
⋮----
.createUniversalTransfer({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/enable-universal-transfer-for-sub-uid.js
================
const client = new RestClientV5({
⋮----
.enableUniversalTransferForSubUIDs(['554117', '592324', '592334'])
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-all-coins-balance.js
================
const client = new RestClientV5({
⋮----
.getAllCoinsBalance({ accountType: 'FUND', coin: 'USDC' })
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-allowed-deposit-coin-info.js
================
const client = new RestClientV5({
⋮----
.getAllowedDepositCoinInfo({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-asset-info-spot.js
================
const client = new RestClientV5({
⋮----
.getAssetInfo({ accountType: 'FUND', coin: 'USDC' })
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-coin-exchange-records.js
================
const client = new RestClientV5({
⋮----
.getCoinExchangeRecords({ limit: 10 })
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-coin-info.js
================
const client = new RestClientV5({
⋮----
.getCoinInfo('ETH')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-convert-coins.js
================
const client = new RestClientV5({
⋮----
.getConvertCoins({ accountType: 'eb_convert_spot' })
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-convert-history.js
================
const client = new RestClientV5({
⋮----
.getConvertHistory()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-convert-status.js
================
const client = new RestClientV5({
⋮----
.getConvertStatus({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-delivery-record.js
================
const client = new RestClientV5({
⋮----
.getDeliveryRecord({ category: 'option', expDate: '29DEC22' })
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-deposit-records.js
================
const client = new RestClientV5({
⋮----
.getDepositRecords({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-exchange-entity-list.js
================
// https://api.bybit.com/v5/asset/withdraw/vasp/list
⋮----
const client = new RestClientV5({
⋮----
.getExchangeEntities()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-internal-deposit-records.js
================
const client = new RestClientV5({
⋮----
.getInternalDepositRecords({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-internal-transfer-records.js
================
const client = new RestClientV5({
⋮----
.getInternalTransferRecords({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-master-deposit-address.js
================
const client = new RestClientV5({
⋮----
.getMasterDepositAddress('USDT', 'ETH')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-single-coin-balance.js
================
const client = new RestClientV5({
⋮----
.getCoinBalance({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-sub-deposit-address.js
================
const client = new RestClientV5({
⋮----
.getSubDepositAddress('USDT', 'TRX', '592334')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-sub-deposit-records.js
================
const client = new RestClientV5({
⋮----
.getSubAccountDepositRecords({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-sub-uid.js
================
const client = new RestClientV5({
⋮----
.getSubUID()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-transferable-coin.js
================
const client = new RestClientV5({
⋮----
.getTransferableCoinList('UNIFIED', 'CONTRACT')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-universal-transfer-records.js
================
const client = new RestClientV5({
⋮----
.getUniversalTransferRecords({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-usdc-session-settlement.js
================
const client = new RestClientV5({
⋮----
.getSettlementRecords({ category: 'linear' })
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-withdrawable-amount.js
================
const client = new RestClientV5({
⋮----
.getWithdrawableAmount({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/get-withdrawal-records.js
================
const client = new RestClientV5({
⋮----
.getWithdrawalRecords({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/README.md
================
# V5 - REST - Asset
https://bybit-exchange.github.io/docs/v5/asset/exchange
================
File: examples/apidoc/V5/Asset/request-convert-quote.js
================
const client = new RestClientV5({
⋮----
.requestConvertQuote({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/set-deposit-account.js
================
const client = new RestClientV5({
⋮----
.setDepositAccount({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Asset/withdraw.js
================
const client = new RestClientV5({
⋮----
.submitWithdrawal({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Broker/get-exchange-broker-account-info.js
================
// https://api.bybit.com/v5/broker/account-info
⋮----
const client = new RestClientV5({
⋮----
.getExchangeBrokerAccountInfo()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Broker/get-exchange-broker-earning.js
================
// https://api.bybit.com/v5/broker/earnings-info
⋮----
const client = new RestClientV5({
⋮----
.getExchangeBrokerEarnings({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Broker/get-subaccount-deposit-records.js
================
// https://api.bybit.com/v5/broker/asset/query-sub-member-deposit-record
⋮----
const client = new RestClientV5({
⋮----
.getBrokerSubAccountDeposits({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Broker/issue-voucher.js
================
const client = new RestClientV5({
⋮----
.issueBrokerVoucher({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Broker/query-issued-voucher.js
================
const client = new RestClientV5({
⋮----
.getBrokerVoucherSpec({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Broker/query-voucher-spec.js
================
const client = new RestClientV5({
⋮----
.getBrokerIssuedVoucher({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Earn/get-product-info.js
================
const client = new RestClientV5({
⋮----
.getEarnProduct({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Earn/get-stake-redeem-order-history.js
================
const client = new RestClientV5({
⋮----
.getEarnOrderHistory({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Earn/get-staked-position.js
================
const client = new RestClientV5({
⋮----
.getEarnPosition({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Earn/stake-redeem.js
================
const client = new RestClientV5({
⋮----
.submitStakeRedeem({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Institutional-Loan/bind-or-unbind-uid.js
================
// https://api.bybit.com/v5/ins-loan/association-uid
⋮----
const client = new RestClientV5({
⋮----
.bindOrUnbindUID({
⋮----
operate: '0', // 0 for bind, 1 for unbind
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Institutional-Loan/get-loan-orders.js
================
// https://api.bybit.com/v5/ins-loan/loan-order
⋮----
const client = new RestClientV5({
⋮----
.getInstitutionalLendingLoanOrders({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Institutional-Loan/get-LTV.js
================
// https://api.bybit.com/v5/ins-loan/ltv-convert
⋮----
const client = new RestClientV5({
⋮----
.getInstitutionalLendingLTVWithLadderConversionRate()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Institutional-Loan/get-margin-coin-info.js
================
// https://api.bybit.com/v5/ins-loan/ensure-tokens-convert
⋮----
const client = new RestClientV5({
⋮----
.getInstitutionalLendingMarginCoinInfoWithConversionRate({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Institutional-Loan/get-product-info.js
================
// https://api.bybit.com/v5/ins-loan/product-infos
⋮----
const client = new RestClientV5({
⋮----
.getInstitutionalLendingProductInfo({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Institutional-Loan/get-repayment-orders.js
================
// https://api.bybit.com/v5/ins-loan/repaid-history
⋮----
const client = new RestClientV5({
⋮----
.getInstitutionalLendingRepayOrders({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-Bybit-server-time.js
================
const client = new RestClientV5({
⋮----
.getServerTime()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-delivery-price.js
================
const client = new RestClientV5({
⋮----
.getDeliveryPrice({ category: 'option', symbol: 'ETH-26DEC22-1400-C' })
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-funding-rate-history.js
================
const client = new RestClientV5({
⋮----
.getFundingRateHistory({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-historical-volatility.js
================
const client = new RestClientV5({
⋮----
.getHistoricalVolatility({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-instruments-info.js
================
const client = new RestClientV5({
⋮----
// linear
⋮----
.getInstrumentsInfo({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
⋮----
// option
⋮----
// spot
================
File: examples/apidoc/V5/Market/get-insurance.js
================
const client = new RestClientV5({
⋮----
.getInsurance({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-kline-index-price.js
================
const client = new RestClientV5({
⋮----
.getIndexPriceKline({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-kline-mark-price.js
================
const client = new RestClientV5({
⋮----
.getMarkPriceKline({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-kline-premium-index-price.js
================
const client = new RestClientV5({
⋮----
.getPremiumIndexPriceKline({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-kline.js
================
const client = new RestClientV5({
⋮----
.getKline({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-long-short-ratio.js
================
const client = new RestClientV5({
⋮----
.getLongShortRatio({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-open-interest.js
================
const client = new RestClientV5({
⋮----
.getOpenInterest({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-orderbook.js
================
const client = new RestClientV5({
⋮----
.getOrderbook({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-public-trading-history.js
================
const client = new RestClientV5({
⋮----
.getPublicTradingHistory({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-risk-limit.js
================
const client = new RestClientV5({
⋮----
.getRiskLimit({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Market/get-tickers.js
================
const client = new RestClientV5({
⋮----
// inverse
⋮----
.getTickers({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
⋮----
// option
⋮----
// spot
================
File: examples/apidoc/V5/Market/README.md
================
# V5 - REST - Market
https://bybit-exchange.github.io/docs/v5/market/kline
================
File: examples/apidoc/V5/P2P/get-account-information.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Call the function
⋮----
.getP2PUserInfo()
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/get-ad-detail.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
itemId: '1898988222063644672', // Replace with your ad ID
⋮----
// Call the function
⋮----
.getP2PAdDetail(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/get-all-orders.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
status: null, // Optional: filter by order status
beginTime: null, // Optional: filter by start time
endTime: null, // Optional: filter by end time
tokenId: null, // Optional: filter by token ID
side: null, // Optional: filter by side (0: Buy, 1: Sell)
page: 1, // Required: page number
size: 1, // Required: rows per page
⋮----
// Call the function
⋮----
.getP2POrders(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/get-chat-message.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
orderId: '1898976123321221120', // Replace with your order ID
size: '1', // Number of messages per page
currentPage: '1', // Optional: current page number
⋮----
// Call the function
⋮----
.getP2POrderMessages(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/get-coin-balance.js
================
// Create a client
const client = new RestClientV5({
⋮----
// Get account coins balance
⋮----
.getP2PAccountCoinsBalance({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/P2P/get-counterparty-user-info.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
originalUid: '290118', // Replace with the counterparty user ID
orderId: '1900004704665923584', // Replace with your order ID
⋮----
// Call the function
⋮----
.getP2PCounterpartyUserInfo(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/get-market-online-ads-list.js
================
// Create a client
const client = new RestClientV5({
⋮----
// Get market online ads list
⋮----
.getP2POnlineAds({
⋮----
side: '0', // 0: buy; 1: sell
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/P2P/get-my-ads-list.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters for getting personal P2P ads
⋮----
itemId: '123456789', // Optional: Specific advertisement ID
status: 1, // Optional: Advertisement status (1: active, 2: completed, 3: cancelled)
side: 1, // Optional: 0: buy; 1: sell
tokenId: 'USDT', // Optional: Token ID
page: 1, // Optional: Page number
size: 20, // Optional: Page size
currencyId: 'USD' // Optional: Currency ID
⋮----
// Get personal P2P ads
client.getP2PPersonalAds(params)
.then(response => {
console.log('Response:', response);
⋮----
.catch(error => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/get-order-detail.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
orderId: '1900004704665923584', // Replace with your order ID
⋮----
// Call the function
⋮----
.getP2POrderDetail(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/get-pending-orders.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
status: 10, // waiting for buy pay
beginTime: '1741831397000', // Optional: filter by start time
endTime: '1741831424861', // Optional: filter by end time
tokenId: 'USDT', // Optional: filter by token
side: [0, 1], // Optional: filter by side (0: Buy, 1: Sell)
⋮----
// Call the function
⋮----
.getP2PPendingOrders(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/get-user-payment.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Call the function
⋮----
.getP2PUserPayments()
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/mark-order-as-paid.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
orderId: '1899736339155943424', // Replace with your order ID
paymentType: '14', // Payment method used
paymentId: '7110', // Payment method ID used
⋮----
// Call the function
⋮----
.markP2POrderAsPaid(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/post-new-ad.js
================
// Create a client
const client = new RestClientV5({
⋮----
// Create new P2P advertisement
⋮----
.createP2PAd({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/P2P/release-digital-asset.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
orderId: '1899736339155943424', // Replace with your order ID
⋮----
// Call the function
⋮----
.releaseP2POrder(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/remove-my-ad.js
================
// Create a client
const client = new RestClientV5({
⋮----
// Cancel P2P advertisement
⋮----
.cancelP2PAd({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/P2P/send-chat-message.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Example parameters
⋮----
orderId: '1898976123321221120', // Replace with your order ID
// Optional parameters:
// msgUuid: 'your-message-uuid',
// fileName: 'example.pdf'
⋮----
// Call the function
⋮----
.sendP2POrderMessage(params)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/P2P/update-relist-my-ad.js
================
// Create a client
const client = new RestClientV5({
⋮----
// Update P2P advertisement
⋮----
.updateP2PAd({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/P2P/upload-chat-file.js
================
// Initialize the client with testnet mode
const client = new RestClientV5({
⋮----
// Create form data
const formData = new FormData();
formData.append('upload_file', fs.createReadStream('path/to/your/file.jpg')); // Replace with your file path
⋮----
// Call the function
⋮----
.uploadP2PChatFile(formData)
.then((response) => {
console.log('Response:', response);
⋮----
.catch((error) => {
console.error('Error:', error);
================
File: examples/apidoc/V5/Position/add-or-reduce-margin.js
================
const client = new RestClientV5({
⋮----
.addOrReduceMargin({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/confirm-new-risk-limit.js
================
const client = new RestClientV5({
⋮----
.confirmNewRiskLimit({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/get-closed-pnl.js
================
const client = new RestClientV5({
⋮----
.getClosedPnL({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/get-execution.js
================
const client = new RestClientV5({
⋮----
.addOrReduceMargin({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/get-move-position-history.js
================
const client = new RestClientV5({
⋮----
.getMovePositionHistory()
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/get-position-info.js
================
const client = new RestClientV5({
⋮----
.getPositionInfo({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/move-position.js
================
const client = new RestClientV5({
⋮----
.movePosition({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/README.md
================
# V5 - REST - Position
https://bybit-exchange.github.io/docs/v5/position
================
File: examples/apidoc/V5/Position/set-auto-add-margin.js
================
const client = new RestClientV5({
⋮----
.setAutoAddMargin({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/set-leverage.js
================
const client = new RestClientV5({
⋮----
.setLeverage({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/set-risk-limit.js
================
const client = new RestClientV5({
⋮----
.setRiskLimit({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/set-tpsl-mode.js
================
const client = new RestClientV5({
⋮----
.setTPSLMode({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/set-trading-stop.js
================
const client = new RestClientV5({
⋮----
.setTradingStop({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/switch-cross-isolated-margin.js
================
const client = new RestClientV5({
⋮----
.switchIsolatedMargin({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Position/switch-position-mode.js
================
const client = new RestClientV5({
⋮----
.switchPositionMode({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Preupgrade/get-preupgrade-closed-pnl.js
================
const client = new RestClientV5({
⋮----
.getPreUpgradeClosedPnl({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Preupgrade/get-preupgrade-option-delivery-record.js
================
const client = new RestClientV5({
⋮----
.getPreUpgradeOptionDeliveryRecord({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Preupgrade/get-preupgrade-order-history.js
================
const client = new RestClientV5({
⋮----
.getPreUpgradeOrderHistory({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Preupgrade/get-preupgrade-trade-history.js
================
const client = new RestClientV5({
⋮----
.getPreUpgradeTradeHistory({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Preupgrade/get-preupgrade-transaction-log.js
================
const client = new RestClientV5({
⋮----
.getPreUpgradeTransactionLog({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Preupgrade/get-preupgrade-USDC-session-settlement.js
================
const client = new RestClientV5({
⋮----
.getPreUpgradeUSDCSessionSettlement({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Spot-Leverage-Token/get-leverage-token-info.js
================
const client = new RestClientV5({
⋮----
.getLeveragedTokenInfo('BTC3L')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Spot-Leverage-Token/get-leveraged-token-market.js
================
const client = new RestClientV5({
⋮----
.getLeveragedTokenMarket('BTC3L')
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Spot-Leverage-Token/get-purchase-redemption-records.js
================
const client = new RestClientV5({
⋮----
.getSpotLeveragedTokenOrderHistory({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Spot-Leverage-Token/purchase.js
================
const client = new RestClientV5({
⋮----
.purchaseSpotLeveragedToken({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Spot-Leverage-Token/README.md
================
# V5 - REST - Spot Leverage Token
https://bybit-exchange.github.io/docs/v5/lt/leverage-token-info
================
File: examples/apidoc/V5/Spot-Leverage-Token/redeem.js
================
const client = new RestClientV5({
⋮----
.redeemSpotLeveragedToken({
⋮----
.then((response) => {
console.log(response);
⋮----
.catch((error) => {
console.error(error);
================
File: examples/apidoc/V5/Spot-Margin-Trade-(Normal)/borrow.js
================
c