{% endhint %}
#### Function Name:
```javascript
getInsuranceFund()
```
#### Usage:
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getInsuranceFund(exchange, options) {
try {
let result = await exchange.getInsuranceFund(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getInsuranceFund(myOkxAccount,
{
instType: "SWAP",
uly: "BTC-USD"
});
### Unit Convert
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function Name:
```javascript
unitConvert()
```
#### Usage:
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function unitConvert(exchange, options) {
try {
let result = await exchange.unitConvert(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await unitConvert(myOkxAccount,
{
instId: "BTC-USD-SWAP",
px: "35000",
sz: "0.888"
});
# Trading Data
Documentation on interacting with a variety of OKX's Trading Data API functions through the PENDAX JavaScript SDK.
The API endpoints of `Trading Data` do not require authentication.
## Trading Data
### Get Support Coin
{% hint style="info" %}
Please refer to the official OKX API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSupportCoin()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getSupportCoin(exchange) {
try {
let result = await exchange.getSupportCoin();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSupportCoin(myOkxAccount)
```
### Get Taker Volume
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getTakerVolume()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getTakerVolume(exchange) {
try {
let result = await exchange.getTakerVolume();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTakerVolume(myOkxAccount,
{
ccy: "BTC",
instType: "SPOT"
})
```
### Get Margin Lending Ratio
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getMarginLendingRatio()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getMarginLendingRatio(exchange) {
try {
let result = await exchange.getMarginLendingRatio();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getMarginLendingRatio(myOkxAccount,
{
ccy: "BTC"
})
```
### Get Long/Short Ratio
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getLongShortRatio()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getLongShortRatio(exchange) {
try {
let result = await exchange.getLongShortRatio();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getLongShortRatio(myOkxAccount,
{
ccy: "BTC"
})
```
### Get Contracts Open Interest and Volume
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getContractsOiAndVolume()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getContractsOiAndVolume(exchange) {
try {
let result = await exchange.getContractsOiAndVolume();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getContractsOiAndVolume(myOkxAccount,
{
ccy: "BTC"
})
```
### Get Options Open Interest and Volume
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getOptionsOiAndVolume()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getOptionsOiAndVolume(exchange) {
try {
let result = await exchange.getOptionsOiAndVolume();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOptionsOiAndVolume(myOkxAccount,
{
ccy: "BTC"
})
```
### Get Put/Call Ratio
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getPutCallRatio()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getPutCallRatio(exchange) {
try {
let result = await exchange.getPutCallRatio();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getPutCallRatio(myOkxAccount,
{
ccy: "BTC"
})
```
### Get Open Interest and Volume (expiry)
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getOiAndVolumeExpiry()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getOiAndVolumeExpiry(exchange) {
try {
let result = await exchange.getOiAndVolumeExpiry();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOiAndVolumeExpiry(myOkxAccount,
{
ccy: "BTC"
})
```
### Get Open Interest and Volume (strike)
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getOiAndVolumeStrike()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getOiAndVolumeStrike(exchange) {
try {
let result = await exchange.getOiAndVolumeStrikegetOiAndVolumeStrike();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOiAndVolumeStrike(myOkxAccount,
{
ccy: "BTC",
expTime: ""
})
```
### Get Taker Flow
{% hint style="info" %}
Please refer to the official OKX API Docs for required parameters.
{% endhint %}
#### Function name:
```javascript
getTakerFlow()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myOkxAccount = createExchange({
exchange: "okx",
authenticate: true,
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "okx",
marginType: "usdt"
});
async function getTakerFlow(exchange) {
try {
let result = await exchange.getTakerFlow();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTakerFlow(myOkxAccount,
{
ccy: "BTC"
})
```
# Bitget Functions
Documentation for interacting with Bitget functions and API endpoints through the PENDAX Javascript SDK.
## Create an Exchange Object
Before you can interact with PENDAX functions, you must first create an Exchange object. This exchange object will allow you to interact with PENDAX. You can create one or multiple, and reference them together or individually throughout your code.
#### Example Exchange Object Creation:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let bitget_exchange = createExchange({
exchange: "bitget",
key: "key",
secret: "secret",
passphrase: "passphrase",
authenticate: true,
label: "bitget",
});
```
#### Unauthenticated Exchange Objects
If you are just calling public API endpoints on the exchange and you don't need any authentication to protected endpoints, simply create your exchange object with authenticate set to false and omit the key, secret, passphrase.
{% hint style="info" %}
Authenticated Exchange objects can call private and public endpoints, however, unauthenticated exchange objects may only call public endpoints.
{% endhint %}
#### Example Unauthenticated Exchange Object:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: false,
label: "bitget",
});
```
{% hint style="warning" %}
These documents are under development and will be updated shortly with all finalized functions
{% endhint %}
## All Available Bitget Functions
Documentation for each category of functions is broken down into its own subpage in order to make navigating pages simpler and faster. Please use the side navigation to access these sub-pages or click on one of the links below.
{% hint style="info" %}
Bitget SPOT & FUTURES markets functions are split into two different sections of the documentation. Please ensure you are trying to interact with the right section when implementing functions.
{% endhint %}
### Bitget SPOT Market Functions
Documented PENDAX functions applicable to Bitget spot markets.
{% content-ref url="/pages/Yk8EAsXpKVS2SAN6sVZ1" %}
[Public (Spot)](/pendax/using-pendax-sdk/bitget-functions/public-spot)
{% endcontent-ref %}
{% content-ref url="/pages/CWqAFkRDIvaBmT2Cuu55" %}
[Market (Spot)](/pendax/using-pendax-sdk/bitget-functions/market-spot)
{% endcontent-ref %}
{% content-ref url="/pages/GjrzfD2Or1E8U43d0NuQ" %}
[Wallet (Spot)](/pendax/using-pendax-sdk/bitget-functions/wallet-spot)
{% endcontent-ref %}
{% content-ref url="/pages/2eQbfSibWVcuFzhepRkO" %}
[Account (Spot)](/pendax/using-pendax-sdk/bitget-functions/account-spot)
{% endcontent-ref %}
{% content-ref url="/pages/YxoxNBTTbq1NsA5H3ZRf" %}
[Trade (Spot)](/pendax/using-pendax-sdk/bitget-functions/trade-spot)
{% endcontent-ref %}
### Bitget FUTURES Market Functions
Documented PENDAX functions applicable to Bitget futures markets.
{% content-ref url="/pages/GvtXk76o1h8F3FMZKpoR" %}
[Account (Futures)](/pendax/using-pendax-sdk/bitget-functions/account-futures)
{% endcontent-ref %}
{% content-ref url="/pages/8ygoeGBeBFoQLsh9IHoo" %}
[Trade (Futures)](/pendax/using-pendax-sdk/bitget-functions/trade-futures)
{% endcontent-ref %}
{% content-ref url="/pages/XnGPcbXaXo2RjYYte5Kq" %}
[Market (Futures)](/pendax/using-pendax-sdk/bitget-functions/market-futures)
{% endcontent-ref %}
# Public (Spot)
Documentation on interacting with Bitget's Spot Market Public Data API functions through the PENDAX Javascript SDK.
### Get Server Time
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getServerTime()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getServerTime(exchange) {
try {
let result = await exchange.getServerTime();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getServerTime(myBitgetAccount)
```
### Get Coin List
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getCoinList()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getCoinList(exchange) {
try {
let result = await exchange.getCoinList();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getCoinList(myBitgetAccount)
```
### Get Symbols
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSymbols()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSymbols(exchange) {
try {
let result = await exchange.getSymbols();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSymbols(myBitgetAccount)
```
### Get Single Symbol
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSingleSymbol()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSingleSymbol(exchange) {
try {
let result = await exchange.getSingleSymbol();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSingleSymbol(myBitgetAccount,
{
symbol: "BTCUSDT_SPBL"
})
```
# Market (Spot)
Documentation on interacting with Bitget's Spot Market Data API functions through the PENDAX Javascript SDK.
### Get Single Ticker
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSingleTicker()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSingleTicker(exchange) {
try {
let result = await exchange.getSingleTicker();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSingleTicker(myBitgetAccount,
{
symbol: "BTCUSDT_SPBL"
})
```
### Get All Tickers
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getAllTickers()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getAllTickers(exchange) {
try {
let result = await exchange.getAllTickers();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getAllTickers(myBitgetAccount)
```
### Get Market Trades
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getMarketTrades()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getMarketTrades(exchange) {
try {
let result = await exchange.getMarketTrades();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getMarketTrades(myBitgetAccount,
{
symbol: "BTCUSDT_SPBL"
})
```
### Get Candle Data
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getCandleData()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getCandleData(exchange) {
try {
let result = await exchange.getCandleData();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getCandleData(myBitgetAccount,
{
symbol: "BTCUSDT_SPBL",
period: "1min",
})
```
### Get Depth
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getServerTime()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getDepth(exchange) {
try {
let result = await exchange.getDepth();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getDepth(myBitgetAccount , {
symbol: "BTCUSDT_SPBL",
type: "step0",
});
```
# Wallet (Spot)
Documentation on interacting with Bitget's Spot Market Wallet API functions through the PENDAX Javascript SDK.
All Spot Market Wallet API endpoints require authentication. Please create Bitget API keys to interact with these functions successfully. Accounts must be funded or collateralized for any trades to successfully post.
### Transfer
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
spotWalletTransfer()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function spotWalletTransfer(exchange) {
try {
let result = await exchange.spotWalletTransfer();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await spotWalletTransfer(myBitgetAccount,
{
fromType: "spot",
toType: "mix_usdt",
amount: "0.1",
coin: "USDT"
})
```
### Sub Transfer
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
subaccountTransfer()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function subaccountTransfer(exchange, options) {
try {
let result = await exchange.subaccountTransfer(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await subaccountTransfer(myBitgetAccount, {
fromType: "spot",
toType: "spot",
amount: "5",
coin: "USDT",
clientOid: "12345",
fromUserId: "1",
toUserId: "2"});
```
### Get Coin Address
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getCoinDepositAddress()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getCoinDepositAddress(exchange, options) {
try {
let result = await exchange.getCoinDepositAddress(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getCoinDepositAddress(myBitgetAccount,
{
coin: "USDT",
chain: "trc20"
});
```
### Withdraw
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
{% hint style="warning" %}
This function is under construction
{% endhint %}
#### Function name:
```javascript
spotWalletWithdraw()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function spotWalletWithdraw(exchange) {
try {
let result = await exchange.spotWalletWithdraw();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await spotWalletWithdraw(myBitgetAccount)
```
### Inner Withdraw
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
innerWithdraw()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function innerWithdraw(exchange) {
try {
let result = await exchange.innerWithdraw();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await innerWithdraw(myBitgetAccount, {
coin: "USDT",
toUid: "234567",
amount: "5"
});
```
### Get Withdraw List
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getWithdrawalList()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getWithdrawalList(exchange) {
try {
let result = await exchange.getWithdrawalList();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getWithdrawalList(myBitgetAccount, {
coin: "USDT",
startTime: "1659036670000",
endTime: "1659076670000",
pageNo: "1",
pageSize: "20"
});
```
### Get Deposit List
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getDepositList()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getDepositList(exchange, options) {
try {
let result = await exchange.getDepositList(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getDepositList(myBitgetAccount, {
coin: "USDT",
startTime: "1659036670000",
endTime: "1659076670000",
pageNo: "1",
pageSize: "20"
})
```
# Account (Spot)
Documentation on interacting with Bitget's Spot Market Account Data API functions through the PENDAX Javascript SDK.
All Spot Market Account & Account Data API endpoints require authentication. Please create Bitget API keys to interact with these functions successfully.
### Get ApiKey Info
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getApiKeyInfo()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getApiKeyInfo(exchange) {
try {
let result = await exchange.getApiKeyInfo();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getApiKeyInfo(myBitgetAccount)
```
### Get Account Assets
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
[https://bitgetlimited.github.io/apidoc/en/spot/#get-account-asset](https://bitgetlimited.github.io/apidoc/en/spot/#get-account-assets)
{% endhint %}
#### Function name:
```javascript
getAccountAssets()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getAccountAssets(exchange) {
try {
let result = await exchange.getAccountAssets();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getAccountAssets(myBitgetAccount)
```
### Get sub Account Spot Assets
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSubaccountSpotAssets()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSubaccountSpotAssets(exchange) {
try {
let result = await exchange.getSubaccountSpotAssets();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSubaccountSpotAssets(myBitgetAccount)
```
### Get Bills
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getBills()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getBills(exchange) {
try {
let result = await exchange.getBills();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getBills(myBitgetAccount)
```
### Get Transfer List
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTransferList()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTransferList(exchange) {
try {
let result = await exchange.getTransferList();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTransferList(myBitgetAccount)
```
# Trade (Spot)
Documentation on interacting with Bitget's Spot Market Trading & Order API functions through the PENDAX Javascript SDK.
All Spot Market Trading & Order API endpoints require authentication. Please create Bitget API keys to interact with these functions successfully. Accounts must be funded or collateralized for any trades to successfully post.
## Place Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
placeOrder(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function placeOrder(exchange, options) {
try {
let result = await exchange.placeOrder(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placeOrder(myBitgetAccount,
{
symbol: 'BTCUSDT_SPBL',
side: 'buy',
orderType: 'market',
force: 'normal',
quantity: '10'
});
```
### Batch Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
placeBatchOrder()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function placeBatchOrder(exchange) {
try {
let result = await exchange.placeBatchOrder();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placeBatchOrder(myBitgetAccount,
{
symbol: 'BTCUSDT_SPBL',
orderList: [{
symbol: 'BTCUSDT_SPBL',
side: 'buy',
orderType: 'market',
force: 'normal',
quantity: '10'
},
{
symbol: 'BTCUSDT_SPBL',
side: 'buy',
orderType: 'market',
force: 'normal',
quantity: '20'
}]
});
```
### Cancel Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
cancelOrder()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function cancelOrder(exchange) {
try {
let result = await exchange.getServerTime();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await cancelOrder(bitget_exchange,
{
symbol:'BTCUSDT_SPBL',
orderId:'1002321893754589184'
})
```
### Cancel Order in Batch (single instruments)
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
cancelBatchOrders()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function cancelBatchOrders(exchange) {
try {
let result = await exchange.cancelBatchOrders();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await cancelBatchOrders(bitget_exchange, {
symbol: 'BTCUSDT_SPBL',
orderIds: [
'111111111111111111',
'222222222222222222'
]
});
```
### Get Order Details
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOrderDetails()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOrderDetails(exchange) {
try {
let result = await exchange.getServerTime();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOrderDetails(myBitgetAccount
{
symbol:'BTCUSDT_SPBL',
orderId:'1002341348069003264'
}
);
```
### Get Order List
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOrderList()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOrderList(exchange) {
try {
let result = await exchange.getOrderList();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOrderList(bitget_exchange, {symbol: ""});
```
### Get Order History
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOrderHistory()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOrderHistory(exchange) {
try {
let result = await exchange.getOrderHistory();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOrderHistory(myBitgetAccount,
{
symbol: 'BTCUSDT_SPBL'
}
);
```
### Get Transaction Details
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTransactionDetails()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTransactionDetails(exchange) {
try {
let result = await exchange.getTransactionDetails();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTransactionDetails(myBitgetAccount,
{
"symbol: BTCUSDT_SPBL"
});
```
### Place Plan Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
placePlanOrder()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function placePlanOrder(exchange) {
try {
let result = await exchange.placePlanOrder();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placePlanOrder(myBitgetAccount,
{
symbol: "BTCUSDT_SPBL",
side: "buy",
triggerPrice: "20000",
size: "20",
triggerType: "market_price",
orderType: "market"
});
```
### Modify Plan Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
modifyPlanOrder()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function modifyPlanOrder(exchange) {
try {
let result = await exchange.modifyPlanOrder();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await modifyPlanOrder(myBitgetAccount
{
orderId: "123456",
triggerPrice: "19999",
orderType: "market"
});
```
### Cancel Plan Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
cancelPlanOrder()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function cancelPlanOrder(exchange) {
try {
let result = await exchange.cancelPlanOrder();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await cancelPlanOrder(myBitgetAccount,
{
orderId: "123456"
})
```
### Get Current Plan Orders
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getCurrentPlanOrders()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getCurrentPlanOrders(exchange) {
try {
let result = await exchange.getCurrentPlanOrders();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getCurrentPlanOrders(myBitgetAccount,
{symbol: "BTCUSDT_SPBL"});
```
### Get History Plan Orders
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getHistoryPlanOrders()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getHistoryPlanOrders(exchange) {
try {
let result = await exchange.getHistoryPlanOrders();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getHistoryPlanOrders(myBitgetAccount,
{
symbol: "BTCUSDT_SPBL",
pageSize: "20",
startTime: "1667889483000",
endTime: "1668134732000"
});
```
# Market (Futures)
Documentation on interacting with Bitget's Futures Market Data API functions through the PENDAX Javascript SDK.
## Get All Symbols
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getAllFuturesSymbols(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt",
testnet: "false"
});
async function getAllFuturesSymbols(exchange, options) {
try {
let result = await exchange.getAllFuturesSymbols(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getAllFuturesSymbols(myBitgetAccount, {productType: "umcbl"})
```
## Get Depth
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getDepthFutures(options)
```
#### Usage:
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getDepthFutures(exchange, options) {
try {
let result = await exchange.getDepthFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getDepthFutures(myBitgetAccount,
{ symbol: "BTCUSDT_UMCBL" });
## Get Single Symbol Tracker
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSingleTickerFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSingleTickerFutures(exchange) {
try {
let result = await exchange.getSingleTickerFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSingleTickerFutures(myBitgetAccount,
{ symbol: "BTCUSDT_UMCBL" });
```
## Get All Symbol Tracker
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getAllTickersFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getAllTickersFutures(exchange) {
try {
let result = await exchange.getAllTickersFutures();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getAllTickersFutures(myBitgetAccount
{
productType: umcbl
});
```
## Get Fills
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getFillsFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getFillsFutures(exchange) {
try {
let result = await exchange.getFillsFutures();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getFillsFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get Candle Data
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getCandlesFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getCandlesFutures(exchange, options) {
try {
let result = await exchange.getCandlesFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getCandlesFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
granularity: "300",
startTime: "1659406928000",
endTime: "1659410528000"
});
```
## Get Symbol Index Price
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSymbolIndexPriceFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSymbolIndexPriceFutures(exchange, options) {
try {
let result = await exchange.getSymbolIndexPriceFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSymbolIndexPriceFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get Symbol Next Funding Time
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getNextFundingTimeFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getNextFundingTimeFutures(exchange, options) {
try {
let result = await exchange.getNextFundingTimeFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getNextFundingTimeFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get History Funding Rate
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getHistoricFundingRateFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getHistoricFundingRateFutures(exchange, options) {
try {
let result = await exchange.getHistoricFundingRateFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getHistoricFundingRateFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get Current Funding Rate
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getCurrentFundingRateFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getCurrentFundingRateFutures(exchange, options) {
try {
let result = await exchange.getCurrentFundingRateFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getCurrentFundingRateFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get Open Interest
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOpenInterestFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOpenInterestFutures(exchange, options) {
try {
let result = await exchange.getOpenInterestFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOpenInterestFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get Symbol Mark Price
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getMarkPriceFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getMarkPriceFutures(exchange, options) {
try {
let result = await exchange.getMarkPriceFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getMarkPriceFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get Symbol Leverage
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSymbolLeverageFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSymbolLeverageFutures(exchange, options) {
try {
let result = await exchange.getSymbolLeverageFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSymbolLeverageFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
# Account (Futures)
Documentation on interacting with Bitget's Futures Market Account API functions through the PENDAX Javascript SDK.
## Get Single Account
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSingleAccountFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt",
testnet: "false"
});
async function getSingleAccountFutures(exchange, options) {
try {
let result = await exchange.getSingleAccountFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSingleAccountFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT"
});
```
## Get Account List
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getAccountListFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getAccountListFutures(exchange, options) {
try {
let result = await exchange.getAccountListFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getAccountListFutures(myBitgetAccount,
{
productType: "umcbl"
});
```
## Get Sub-Account Contract Assets
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSubaccountContractAssets(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSubaccountContractAssets(exchange, options) {
try {
let result = await exchange.getSubaccountContractAssets(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSubaccountContractAssets(myBitgetAccount,
{
productType: "umcbl"
});
```
## Get Open Count
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOpenCountFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOpenCountFutures(exchange, options) {
try {
let result = await exchange.getOpenCountFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOpenCountFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
openPrice: "23189.5",
leverage: "20",
openAmount:"5000"
});
```
## Change Leverage
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
setLeverage(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function setLeverage(exchange, options) {
try {
let result = await exchange.setLeverage(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await setLeverage(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
leverage: "2"
});
```
## Change Margin
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getApiKeyInfo(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function changeMargin(exchange, options) {
try {
let result = await exchange.changeMargin(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await changeMargin(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
amount: "-10"
});
```
## Change Margin Mode
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
setMarginMode(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function setMarginMode(exchange, options) {
try {
let result = await exchange.setMarginMode(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await setMarginMode(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
marginMode: "crossed"
});
```
## Change Hold Mode
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
changeHoldMode(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function changeHoldMode(exchange, options) {
try {
let result = await exchange.changeHoldMode(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await changeHoldMode(myBitgetAccount,
{
productType: "umcbl",
holdMode: "double_hold"
});
```
## Get Symbol Position
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSymbolPosition(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSymbolPosition(exchange, options) {
try {
let result = await exchange.getSymbolPosition(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSymbolPosition(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT"
});
```
## Get All Position
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getAllPositionsFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getAllPositionsFutures(exchange, options) {
try {
let result = await exchange.getAllPositionsFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getAllPositionsFutures(myBitgetAccount,
{
productType: "umcbl",
marginCoin: "USDT"
});
```
## Get Account Bill
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getAccountBill(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getAccountBill(exchange, options) {
try {
let result = await exchange.getAccountBill(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getAccountBill(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
startTime: "1659403328000",
endTime: "1659406928000",
pageSize: "20"
});
```
## Get Business Account Bill
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getBusinessAccountBill(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getBusinessAccountBill(exchange, options) {
try {
let result = await exchange.getBusinessAccountBill(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getBusinessAccountBill(myBitgetAccount,
{
productType: "umcbl",
startTime: "1659403328000",
endTime: "1659406928000",
pageSize: "20"
});
```
# Trade (Futures)
Documentation on interacting with Bitget's Futures Trading & Order API functions through the PENDAX Javascript SDK.
## Place Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
placeOrderFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt",
testnet: "false"
});
async function placeOrderFutures(exchange, options) {
try {
let result = await exchange.placeOrderFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placeOrderFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
size: "0.01",
side: "open_long",
orderType: "market"
});
```
## Batch Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
placeBatchOrderFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function placeBatchOrderFutures(exchange, options) {
try {
let result = await exchange.placeBatchOrderFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placeBatchOrderFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
orderDataList:[
{
size: "0.003",
side: "open_long",
orderType: "limit",
price: "10000"
},
{
size: "0.004",
side: "open_long",
orderType: "limit",
price: "10000"
}]
});
```
## Cancel Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
cancelOrderFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function cancelOrderFutures(exchange, options) {
try {
let result = await exchange.cancelOrderFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await cancelOrderFutures(myBitgetAccount
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
orderId: "1009818807293329409"
});
```
## Batch Cancel Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
cancelBatchOrdersFutures(options)
```
#### Usage:
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function cancelBatchOrdersFutures(exchange, options) {
try {
let result = await exchange.cancelBatchOrdersFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await cancelBatchOrdersFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
orderIds:["1011271303899529219", "1011271303903723526"]
});
## Cancel All Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
cancelAllOrdersFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function cancelAllOrdersFutures(exchange, options) {
try {
let result = await exchange.cancelAllOrdersFutures(optionsoptions);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await cancelAllOrdersFutures(myBitgetAccount,
{
productType: "umcbl",
marginCoin: "USDT"
});
```
## Get Open Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOpenOrdersFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOpenOrdersFutures(exchange, options) {
try {
let result = await exchange.getOpenOrdersFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOpenOrdersFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get All Open Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getAllOpenOrdersFutures()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getAllOpenOrdersFutures(exchange, options) {
try {
let result = await exchange.getAllOpenOrdersFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getAllOpenOrdersFutures(myBitgetAccount,
{
productType: "umcbl",
marginCoin: "USDT"
});
```
## Get History Orders
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOrdersHistoryFutures(options)
```
#### Usage:
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOrdersHistoryFutures(exchange, options) {
try {
let result = await exchange.getOrdersHistoryFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOrdersHistoryFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
startTime: "1659403328000",
endTime: "1659410528000",
pageSize: "20"
});
## Get ProductType History Orders
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOrdersHistoryByProductTypeFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOrdersHistoryByProductTypeFutures(exchange, options) {
try {
let result = await exchange.getOrdersHistoryByProductTypeFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOrdersHistoryByProductTypeFutures(myBitgetAccount,
{
productType: "umcbl",
startTime: "1659403328000",
endTime: "1659410528000",
pageSize: "20"
});
```
## Get Order Details
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOrderDetailsFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOrderDetailsFutures(exchange, options) {
try {
let result = await exchange.getOrderDetailsFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOrderDetailsFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
orderId: "12345"
});
```
## Get Order Fill Details
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getOrderFillDetailFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getOrderFillDetailFutures(exchange, options) {
try {
let result = await exchange.getOrderFillDetailFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getOrderFillDetailFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
startTime: "1659403328000",
orderId: "1010182528922435618"
});
```
## Get ProductType Order Fill Details
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getProductTypeOrderFillDetailFutures(options)
```
#### Usage:
{% hint style="warning" %}
API requires either endTime and startTime or lastEndId as parameters
{% endhint %}
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getProductTypeOrderFillDetailFutures(exchange, options) {
try {
let result = await exchange.getProductTypeOrderFillDetailFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getProductTypeOrderFillDetailFutures(myBitgetAccount,
{
productType: "umcbl",
startTime: "0",
endTime: "1676832767000"
});
```
## Place Plan Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
placePlanOrderFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function placePlanOrderFutures(exchange, options) {
try {
let result = await exchange.placePlanOrderFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placePlanOrderFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
size: "0.05",
side: "open_long",
orderType: "market",
triggerPrice: "22000",
triggerType: "market_price"
});
```
## Modify Plan Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
modifyPlanOrderFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function modifyPlanOrderFutures(exchange, options) {
try {
let result = await exchange.modifyPlanOrderFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await modifyPlanOrderFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
orderId: "12345",
side: "open_long",
orderType: "market",
triggerPrice: "21000",
triggerType: "market_price"
});
```
## Modify Plan Order TPSL
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
modifyPlanOrderTpslFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function modifyPlanOrderTpslFutures(exchange, options) {
try {
let result = await exchange.modifyPlanOrderTpslFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await modifyPlanOrderTpslFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
orderId: "12345"
});
```
## Place Stop Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
placeStopOrderFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function placeStopOrderFutures(exchange, options) {
try {
let result = await exchange.placeStopOrderFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placeStopOrderFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
size: "0.001",
planType: "profit_plan",
triggerPrice:"23555.5",
holdSide:"long"
});
```
## Place Trailing Stop Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
{% hint style="warning" %}
This function is under construction
{% endhint %}
#### Function name:
```javascript
placeTrailingStopOrderFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function placeTrailingStopOrderFutures(exchange, options) {
try {
let result = await exchange.placeTrailingStopOrderFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placeTrailingStopOrderFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
triggerPrice:"22000",
holdSide: "long",
rangeRate: "1"
});
```
## Place Position TPSL
{% hint style="warning" %}
This Function is currently under construction
{% endhint %}
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
placePositionTpslFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function placePositionTpslFutures(exchange, options) {
try {
let result = await exchange.placePositionTpslFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await placePositionTpslFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
planType: "pos_profit",
triggerPrice:"24720",
holdSide:"long"
});
```
## Modify Stop Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
modifyStopOrderFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function modifyStopOrderFutures(exchange, options) {
try {
let result = await exchange.modifyStopOrderFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await modifyStopOrderFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
orderId: "1010239532700766209",
planType: "pos_profit",
triggerPrice:"24620",
holdSide:"long"
});
```
## Cancel Plan Order TPSL
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
cancelPlanOrderTpslFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function cancelPlanOrderTpslFutures(exchange, options) {
try {
let result = await exchange.cancelPlanOrderTpslFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await cancelPlanOrderTpslFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
marginCoin: "USDT",
orderId: "1010239532700766209",
planType: "pos_profit"
});
```
## Cancel All Trigger Order TPSL
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
cancelAllTriggerOrdersTpslFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function cancelAllTriggerOrdersTpslFutures(exchange, options) {
try {
let result = await exchange.cancelAllTriggerOrdersTpslFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await cancelAllTriggerOrdersTpslFutures(myBitgetAccount,
{
productType: "umcbl",
planType: "pos_profit"
});
```
## Get Plan Order TPSL List
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getPlanOrderListTpslFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getPlanOrderListTpslFutures(exchange, options) {
try {
let result = await exchange.getPlanOrderListTpslFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getPlanOrderListTpslFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL"
});
```
## Get History Plan Orders TPSL
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getHistoryPlanOrdersTpslFutures(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getHistoryPlanOrdersTpslFutures(exchange, options) {
try {
let result = await exchange.getHistoryPlanOrdersTpslFutures(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getHistoryPlanOrdersTpslFutures(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
startTime: "1659403328000",
endTime: "1659410528000",
pageSize: "20"
});
```
# CopyTrade (Futures)
{% hint style="danger" %}
This section is under construction. Some functions may not work correctly.
{% endhint %}
## Get Trader Open Order
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTraderOpenOrderCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTraderOpenOrderCopyTrade(exchange, options) {
try {
let result = await exchange.getTraderOpenOrderCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTraderOpenOrderCopyTrade(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
productType: "umcbl",
pageSize: "20",
pageNo: "1"
});
```
## Get Follower Open Orders
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getFollowersOpenOrderCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getFollowersOpenOrderCopyTrade(exchange, options) {
try {
let result = await exchange.getFollowersOpenOrderCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getFollowersOpenOrderCopyTrade(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
productType: "umcbl",
pageSize: "20",
pageNo: "1"
});
```
## Get Follower History Orders
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getFollowerHistoryOrdersCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getFollowerHistoryOrdersCopyTrade(exchange, options) {
try {
let result = await exchange.getFollowerHistoryOrdersCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getFollowerHistoryOrdersCopyTrade(myBitgetAccount,
{
startTime: "1668073994000",
endTime: "1668073994206",
pageSize: "20",
pageNo: "1"
});
```
## Trader Close Position
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
traderClosePositionCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function traderClosePositionCopyTrade(exchange, options) {
try {
let result = await exchange.traderClosePositionCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await traderClosePositionCopyTrade(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
trackingNo: "6258224712558517"
});
```
## Trader Modify TPSL
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
traderModifyTsplCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function traderModifyTsplCopyTrade(exchange, options) {
try {
let result = await exchange.traderModifyTsplCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await traderModifyTsplCopyTrade(myBitgetAccount,
{
symbol: "BTCUSDT_UMCBL",
trackingNo: "6258224712558517",
stopProfitPrice:"24123.5",
stopLossPrice:"21487.5"
});
```
## Get Traders History Orders
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTradersHistoryOrdersCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTradersHistoryOrdersCopyTrade(exchange, options) {
try {
let result = await exchange.getTradersHistoryOrdersCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTradersHistoryOrdersCopyTrade(myBitgetAccount,
{
startTime: "1668073994000",
endTime: "1668073994206",
pageSize: "20",
pageNo: "1"
});
```
## Get Trader Profit Summary
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTraderProfitSummaryCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTraderProfitSummaryCopyTrade(exchange, options) {
try {
let result = await exchange.getTraderProfitSummaryCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTraderProfitSummaryCopyTrade(myBitgetAccount);
```
## Get Trader History Profit Summary (currency)
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTraderHistoryProfitSummaryCurrencyCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTraderHistoryProfitSummaryCurrencyCopyTrade(exchange, options) {
try {
let result = await exchange.getTraderHistoryProfitSummaryCurrencyCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTraderHistoryProfitSummaryCurrencyCopyTrade(myBitgetAccount);
```
## Get Trader History Profit Summary (currency/date)
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTraderHistoryProfitSummaryByCurrencyAndDateCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTraderHistoryProfitSummaryByCurrencyAndDateCopyTrade(exchange, options) {
try {
let result = await exchange.getTraderHistoryProfitSummaryByCurrencyAndDateCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTraderHistoryProfitSummaryByCurrencyAndDateCopyTrade(myBitgetAccount);
```
## Get Trader History Profit Detail
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTraderHistoryProfitDetailCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTraderHistoryProfitDetailCopyTrade(exchange, options) {
try {
let result = await exchange.getTraderHistoryProfitDetailCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTraderHistoryProfitDetailCopyTrade(myBitgetAccount,
{
marginCoin: "USDT",
date: "1627354109502",
pageSize: "20",
pageNo: "1"
});
```
## Get Trader Profits Details
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getTraderProfitDetailsCopyTrade(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getTraderProfitDetailsCopyTrade(exchange, options) {
try {
let result = await exchange.getTraderProfitDetailsCopyTrade(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getTraderProfitDetailsCopyTrade(myBitgetAccount,
{
pageSize: "20",
pageNo: "1"
});
```
## Get CopyTrade Symbols
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getCopyTradeSymbols(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getCopyTradeSymbols(exchange, options) {
try {
let result = await exchange.getCopyTradeSymbols(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getCopyTradeSymbols(myBitgetAccount);
```
## Trader Change CopyTrade Symbol
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
traderChangeCopyTradeSymbol(options)
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function traderChangeCopyTradeSymbol(exchange, options) {
try {
let result = await exchange.traderChangeCopyTradeSymbol(options);
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await traderChangeCopyTradeSymbol(myBitgetAccount);
```
# Sub Account Interface (Broker)
{% hint style="danger" %}
This section is under construction. Some functions may not work correctly.
{% endhint %}
## Get Broker Info
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getBrokerInfo()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getBrokerInfo(exchange) {
try {
let result = await exchange.getBrokerInfo();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getBrokerInfo(myBitgetAccount);
```
## Create Sub Account
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
createSubaccount()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function createSubaccount(exchange) {
try {
let result = await exchange.createSubaccount();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await createSubaccount(myBitgetAccount
```
## Get Sub List
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSubList()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSubList(exchange) {
try {
let result = await exchange.getSubList();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSubList(myBitgetAccount
```
## Modify Sub Account
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
modifySubaccount()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function modifySubaccount(exchange) {
try {
let result = await exchange.modifySubaccount();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await modifySubaccount(myBitgetAccount
```
## Modify Sub Email
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
modifySubaccountEmail()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function modifySubaccountEmail(exchange) {
try {
let result = await exchange.modifySubaccountEmail();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await modifySubaccountEmail(myBitgetAccount
```
## Get Sub Email
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.
{% endhint %}
#### Function name:
```javascript
getSubId()
```
#### Usage:
```javascript
import { createExchange } from "./exchanges/exchange.js";
let myBitgetAccount = createExchange({
exchange: "bitget",
authenticate: "true",
key: "myKeys",
secret: "mySecret",
passphrase: "myPassphrase",
label: "bitget",
marginType: "usdt"
});
async function getSubId(exchange) {
try {
let result = await exchange.getSubId();
console.log(result);
} catch (error) {
console.log(error.message);
}
}
const result = await getSubId(myBitgetAccount
```
## Get Sub Spot Assets
{% hint style="info" %}
Please refer to the official Bitget API Docs for the required parameters.