Skip to content

fix(client): margin endpoints #932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlosmiei merged 3 commits into from
Apr 22, 2025
Merged

fix(client): margin endpoints #932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
695391c
fix(client): margin endpoints
carlosmiei Apr 21, 2025
950402d
add sapi
carlosmiei Apr 22, 2025
c9b68de
revbert
carlosmiei Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 24 additions & 16 deletions src/node-binance-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,10 @@ export default class Binance {
return this.base;
}

getSapiUrl(){
return this.sapi;
}

getFapiUrl() {
if (this.Options.test) return this.fapiTest;
return this.fapi;
Expand Down Expand Up @@ -623,7 +627,7 @@ export default class Binance {
}

/**
* Create a signed spot/margin request
* Create a signed spot request
* @param {string} path - url path
* @param {object} data - The data to send
* @param {string} method - the http method
Expand All @@ -634,6 +638,10 @@ export default class Binance {
return await this.signedRequest/**/(this.getSpotUrl() + path, data, method, noDataInSignature);
}

async privateSapiRequest(path: string, data: Dict = {}, method: HttpMethod = 'GET', noDataInSignature = false) {
return await this.signedRequest/**/(this.getSapiUrl() + path, data, method, noDataInSignature);
}

/**
* Create a signed http request
* @param {string} url - The http endpoint
Expand Down Expand Up @@ -1029,7 +1037,7 @@ export default class Binance {
request.stopPrice = params.stopPrice;
if (request.type === 'LIMIT') throw Error('stopPrice: Must set "type" to one of the following: STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT');
}
return await this.privateSpotRequest(endpoint, this.extend(request, params), 'POST');
return await this.privateSapiRequest(endpoint, this.extend(request, params), 'POST');
}

// Futures internal functions
Expand Down Expand Up @@ -4820,7 +4828,7 @@ export default class Binance {
* @return {undefined}
*/
async mgCancel(symbol: string, orderid: number | string, isIsolated = 'FALSE'): Promise<CancelOrder> {
return await this.privateSpotRequest('v1/margin/order', { symbol: symbol, orderId: orderid, isIsolated }, 'DELETE');
return await this.privateSapiRequest('v1/margin/order', { symbol: symbol, orderId: orderid, isIsolated }, 'DELETE');
}

/**
Expand All @@ -4831,7 +4839,7 @@ export default class Binance {
*/
async mgAllOrders(symbol: string, params: Dict = {}): Promise<Order[]> {
const parameters = Object.assign({ symbol: symbol }, params);
return await this.privateSpotRequest('v1/margin/allOrders', parameters);
return await this.privateSapiRequest('v1/margin/allOrders', parameters);
}

/**
Expand All @@ -4843,7 +4851,7 @@ export default class Binance {
*/
async mgOrderStatus(symbol: string, orderid: number | string, flags = {}): Promise<Order> {
const parameters = Object.assign({ symbol: symbol, orderId: orderid }, flags);
return await this.privateSpotRequest('v1/margin/order', parameters);
return await this.privateSapiRequest('v1/margin/order', parameters);
}

/**
Expand All @@ -4853,7 +4861,7 @@ export default class Binance {
*/
async mgOpenOrders(symbol?: string, params: Dict = {}): Promise<Order[]> {
if (symbol) params.symbol = symbol;
return await this.privateSpotRequest('v1/margin/openOrders', params);
return await this.privateSapiRequest('v1/margin/openOrders', params);
}

/**
Expand All @@ -4874,7 +4882,7 @@ export default class Binance {
// }, 'DELETE');
// }
// }); // to do check this
return await this.privateSpotRequest('v1/margin/openOrders', this.extend({ symbol: symbol }, params), 'DELETE');
return await this.privateSapiRequest('v1/margin/openOrders', this.extend({ symbol: symbol }, params), 'DELETE');
}

/**
Expand All @@ -4886,7 +4894,7 @@ export default class Binance {
*/
async mgTransferMainToMargin(asset: string, amount: number, params: Dict = {}) {
params = this.extend({ asset: asset, amount: amount, type: 1 }, params);
return await this.privateSpotRequest('v1/margin/transfer', params, 'POST');
return await this.privateSapiRequest('v1/margin/transfer', params, 'POST');
}

/**
Expand All @@ -4897,7 +4905,7 @@ export default class Binance {
*/
async mgTransferMarginToMain(asset: string, amount: number, params: Dict = {}) {
const parameters = Object.assign({ asset: asset, amount: amount, type: 2 });
return await this.privateSpotRequest('v1/margin/transfer', this.extend(parameters, params), 'POST');
return await this.privateSapiRequest('v1/margin/transfer', this.extend(parameters, params), 'POST');
}
// /**
// * Universal Transfer requires API permissions enabled
Expand All @@ -4918,7 +4926,7 @@ export default class Binance {
*/
async mgTrades(symbol: string, params: Dict = {}): Promise<MyTrade[]> {
const parameters = Object.assign({ symbol: symbol }, params);
return await this.privateSpotRequest('v1/margin/myTrades', parameters);
return await this.privateSapiRequest('v1/margin/myTrades', parameters);
}

/**
Expand Down Expand Up @@ -4989,7 +4997,7 @@ export default class Binance {
isIsolated,
symbol
} : {};
return await this.privateSpotRequest('v1/margin/loan', this.extend({ ...parameters, ...isolatedObj }, params), 'POST');
return await this.privateSapiRequest('v1/margin/loan', this.extend({ ...parameters, ...isolatedObj }, params), 'POST');
}

/**
Expand All @@ -5000,7 +5008,7 @@ export default class Binance {
*/
async mgQueryLoan(asset: string, options) {
const parameters = Object.assign({ asset: asset }, options);
return await this.privateSpotRequest('v1/margin/loan', { ...parameters }, 'GET');
return await this.privateSapiRequest('v1/margin/loan', { ...parameters }, 'GET');
}

/**
Expand All @@ -5011,7 +5019,7 @@ export default class Binance {
*/
async mgQueryRepay(asset: string, params: Dict = {}) {
const parameters = Object.assign({ asset: asset }, params);
return await this.privateSpotRequest('v1/margin/repay', { ...parameters }, 'GET');
return await this.privateSapiRequest('v1/margin/repay', { ...parameters }, 'GET');
}

/**
Expand All @@ -5029,7 +5037,7 @@ export default class Binance {
isIsolated,
symbol
} : {};
return await this.privateSpotRequest('v1/margin/repay', this.extend({ ...parameters, ...isolatedObj }, params), 'POST');
return await this.privateSapiRequest('v1/margin/repay', this.extend({ ...parameters, ...isolatedObj }, params), 'POST');
}

/**
Expand All @@ -5040,7 +5048,7 @@ export default class Binance {
async mgAccount(isIsolated = false, params: Dict = {}) {
let endpoint = 'v1/margin';
endpoint += (isIsolated) ? '/isolated' : '' + '/account';
return await this.privateSpotRequest(endpoint, params);
return await this.privateSapiRequest(endpoint, params);
}
/**
* Get maximum borrow amount of an asset
Expand All @@ -5049,7 +5057,7 @@ export default class Binance {
*/
async maxBorrowable(asset: string, params: Dict = {}) {
params.asset = asset;
return await this.privateSpotRequest('v1/margin/maxBorrowable', params);
return await this.privateSapiRequest('v1/margin/maxBorrowable', params);
}

// // Futures WebSocket Functions:
Expand Down
21 changes: 21 additions & 0 deletions tests/binance-class-static.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,27 @@ describe( 'Static tests', async function () {
assert(obj.newClientOrderId.startsWith(SPOT_PREFIX))
})

it( 'spot open orders', async function ( ) {
await binance.openOrders( 'LTCUSDT')
assert.isTrue( interceptedUrl.startsWith('https://api.binance.com/api/v3/openOrders' ))
})

it( 'margin open orders', async function ( ) {
await binance.mgOpenOrders( 'LTCUSDT')
assert.isTrue( interceptedUrl.startsWith('https://api.binance.com/sapi/v1/margin/openOrders' ))
})

it( 'Margin MarketBuy order', async function ( ) {
await binance.mgMarketBuy( 'LTCUSDT', 0.5)
assert.equal( interceptedUrl, 'https://api.binance.com/sapi/v1/margin/order' )
const obj = urlToObject( interceptedBody )
assert.equal( obj.symbol, 'LTCUSDT' )
assert.equal( obj.side, 'BUY' )
assert.equal( obj.type, 'MARKET' )
assert.equal( obj.quantity, 0.5 )
assert(obj.newClientOrderId.startsWith(SPOT_PREFIX))
})

it( 'spot order with custom clientorderId', async function ( ) {
await binance.order( 'LIMIT', 'BUY', 'LTCUSDT', 0.5, 100, {'newClientOrderId': 'myid'})
assert.equal( interceptedUrl, 'https://api.binance.com/api/v3/order' )
Expand Down