Skip to content

feat(client): add demo trading #963

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
merged 6 commits into from
Sep 24, 2025
Merged

feat(client): add demo trading #963

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
45a5d04
feat(client): add demo trading
carlosmiei Sep 23, 2025
54fd980
add demo to constructor
carlosmiei Sep 23, 2025
8db9327
try fix tests
carlosmiei Sep 24, 2025
ad07008
read proxy from options
carlosmiei Sep 24, 2025
bc7b276
update test and rm hedged mode
carlosmiei Sep 24, 2025
b849b7a
update proxy
carlosmiei Sep 24, 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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ Actively maintained, typed, and safe SDK for the Binance REST APIs and Websocket

### Features
- Spot, Margin, Futures and Delivery API
- Testnet support
- Demo trading support
- Testnet support (deprecated)
- Proxy support (REST and WS)
- Customizable HTTP headers
- Customizable request parameters
Expand Down
70 changes: 54 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 @@ -30,24 +30,33 @@ export default class Binance {
domain = 'com';
base = `https://api.binance.${this.domain}/api/`;
baseTest = `https://testnet.binance.vision/api/`;
baseDemo = `https://demo-api.binance.com/api/`;
wapi = `https://api.binance.${this.domain}/wapi/`;
sapi = `https://api.binance.${this.domain}/sapi/`;
fapi = `https://fapi.binance.${this.domain}/fapi/`;
dapi = `https://dapi.binance.${this.domain}/dapi/`;
fapiTest = `https://testnet.binancefuture.com/fapi/`;
fapiDemo = `https://demo-fapi.binance.com/fapi/`;
dapiTest = `https://testnet.binancefuture.com/dapi/`;
dapiDemo = `https://demo-dapi.binance.com/dapi/`;
fstream = `wss://fstream.binance.${this.domain}/stream?streams=`;
fstreamSingle = `wss://fstream.binance.${this.domain}/ws/`;
fstreamSingleTest = `wss://stream.binancefuture.${this.domain}/ws/`;
fstreamSingleDemo = `wss://fstream.binancefuture.com/ws/`;
fstreamTest = `wss://stream.binancefuture.${this.domain}/stream?streams=`;
fstreamDemo = `wss://fstream.binancefuture.com/stream?streams=`;
dstream = `wss://dstream.binance.${this.domain}/stream?streams=`;
dstreamSingle = `wss://dstream.binance.${this.domain}/ws/`;
dstreamSingleTest = `wss://dstream.binancefuture.${this.domain}/ws/`;
dstreamSingleDemo = `wss://dstream.binancefuture.com/ws/`;
dstreamTest = `wss://dstream.binancefuture.${this.domain}/stream?streams=`;
dstreamDemo = `wss://dstream.binancefuture.com/stream?streams=`;
stream = `wss://stream.binance.${this.domain}:9443/ws/`;
streamTest = `wss://stream.testnet.binance.vision/ws/`;
streamDemo = `wss://demo-stream.binance.com/ws/`;
combineStream = `wss://stream.binance.${this.domain}:9443/stream?streams=`;
combineStreamTest = `wss://stream.testnet.binance.vision/stream?streams=`;
combineStreamDemo = `wss://demo-stream.binance.com/stream?streams=`;

verbose = false;

Expand All @@ -65,7 +74,8 @@ export default class Binance {
APISECRET: string = undefined;
PRIVATEKEY: string = undefined;
PRIVATEKEYPASSWORD: string = undefined;
test = false;
test = false; // sandbox mode
demo = false; // demo mode

timeOffset: number = 0;

Expand Down Expand Up @@ -150,6 +160,7 @@ export default class Binance {
keepAlive: true,
verbose: false,
test: false,
demo: false,
hedgeMode: false,
localAddress: false,
family: 4,
Expand Down Expand Up @@ -214,8 +225,10 @@ export default class Binance {
if (this.Options.PRIVATEKEY) this.PRIVATEKEY = this.Options.PRIVATEKEY;
if (this.Options.PRIVATEKEYPASSWORD) this.PRIVATEKEYPASSWORD = this.Options.PRIVATEKEYPASSWORD;
if (this.Options.test) this.test = true;
if (this.Options.demo) this.demo = true;
if (this.Options.headers) this.headers = this.Options.Headers;
if (this.Options.domain) this.domain = this.Options.domain;
if (this.Options.httpsProxy) this.httpsProxy = this.Options.httpsProxy;
}

async setOptions(opt = {}): Promise<Binance> {
Expand All @@ -233,6 +246,7 @@ export default class Binance {
extend = (...args: any[]) => Object.assign({}, ...args);

getSpotUrl() {
if (this.Options.demo) return this.baseDemo;
if (this.Options.test) return this.baseTest;
return this.base;
}
Comment on lines 248 to 252
Copy link

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The demo and test options can both be enabled simultaneously, but the current logic prioritizes demo over test. Consider adding validation to prevent both options from being enabled at the same time, or document the precedence behavior clearly.

Copilot uses AI. Check for mistakes.

Expand All @@ -242,30 +256,53 @@ export default class Binance {
}

getFapiUrl() {
if (this.Options.demo) return this.fapiDemo;
if (this.Options.test) return this.fapiTest;
return this.fapi;
}

getDapiUrl() {
if (this.Options.demo) return this.dapiDemo;
if (this.Options.test) return this.dapiTest;
return this.dapi;
}

getCombineStreamUrl() {
if (this.Options.demo) return this.combineStreamDemo;
if (this.Options.test) return this.combineStreamTest;
return this.combineStream;
}

getStreamUrl() {
if (this.Options.demo) return this.streamDemo;
if (this.Options.test) return this.streamTest;
return this.stream;
}

getFStreamUrl() {
getDStreamSingleUrl() {
if (this.Options.demo) return this.dstreamSingleDemo;
if (this.Options.test) return this.dstreamSingleTest;
return this.dstreamSingle;
}

getFStreamSingleUrl() {
if (this.Options.demo) return this.fstreamSingleDemo;
if (this.Options.test) return this.fstreamSingleTest;
return this.fstreamSingle;
}

getFStreamUrl() {
if (this.Options.demo) return this.fstreamDemo;
if (this.Options.test) return this.fstreamTest;
return this.fstream;
}

getDStreamUrl() {
if (this.Options.demo) return this.dstreamDemo;
if (this.Options.test) return this.dstreamTest;
return this.dstream;
}

uuid22(a?: any) {
return a ? (a ^ Math.random() * 16 >> a / 4).toString(16) : (([1e7] as any) + 1e3 + 4e3 + 8e5).replace(/[018]/g, this.uuid22);
}
Expand Down Expand Up @@ -1462,14 +1499,14 @@ export default class Binance {
host: this.parseProxy(socksproxy)[1],
port: this.parseProxy(socksproxy)[2]
});
ws = new WebSocket((this.getFStreamUrl()) + endpoint, { agent });
ws = new WebSocket((this.getFStreamSingleUrl()) + endpoint, { agent });
} else if (httpsproxy) {
const config = url.parse(httpsproxy);
const agent = new HttpsProxyAgent(config);
if (this.Options.verbose) this.Options.log(`futuresSubscribeSingle: using proxy server: ${agent}`);
ws = new WebSocket((this.getFStreamUrl()) + endpoint, { agent });
ws = new WebSocket((this.getFStreamSingleUrl()) + endpoint, { agent });
} else {
ws = new WebSocket((this.getFStreamUrl()) + endpoint);
ws = new WebSocket((this.getFStreamSingleUrl()) + endpoint);
}

if (this.Options.verbose) this.Options.log('futuresSubscribeSingle: Subscribed to ' + endpoint);
Expand Down Expand Up @@ -1517,14 +1554,14 @@ export default class Binance {
host: this.parseProxy(socksproxy)[1],
port: this.parseProxy(socksproxy)[2]
});
ws = new WebSocket((this.Options.test ? this.fstreamTest : this.fstream) + queryParams, { agent });
ws = new WebSocket(this.getFStreamUrl() + queryParams, { agent });
} else if (httpsproxy) {
if (this.Options.verbose) this.Options.log(`futuresSubscribe: using proxy server ${httpsproxy}`);
const config = url.parse(httpsproxy);
const agent = new HttpsProxyAgent(config);
ws = new WebSocket((this.Options.test ? this.fstreamTest : this.fstream) + queryParams, { agent });
ws = new WebSocket(this.getFStreamUrl() + queryParams, { agent });
} else {
ws = new WebSocket((this.Options.test ? this.fstreamTest : this.fstream) + queryParams);
ws = new WebSocket(this.getFStreamUrl() + queryParams);
}

ws.reconnect = this.Options.reconnect;
Expand Down Expand Up @@ -2175,14 +2212,14 @@ export default class Binance {
host: this.parseProxy(socksproxy)[1],
port: this.parseProxy(socksproxy)[2]
});
ws = new WebSocket((this.Options.test ? this.dstreamSingleTest : this.dstreamSingle) + endpoint, { agent });
ws = new WebSocket((this.getDStreamSingleUrl()) + endpoint, { agent });
} else if (httpsproxy) {
const config = url.parse(httpsproxy);
const agent = new HttpsProxyAgent(config);
if (this.Options.verbose) this.Options.log(`deliverySubscribeSingle: using proxy server: ${agent}`);
ws = new WebSocket((this.Options.test ? this.dstreamSingleTest : this.dstreamSingle) + endpoint, { agent });
ws = new WebSocket((this.getDStreamSingleUrl()) + endpoint, { agent });
} else {
ws = new WebSocket((this.Options.test ? this.dstreamSingleTest : this.dstreamSingle) + endpoint);
ws = new WebSocket((this.getDStreamSingleUrl()) + endpoint);
}

if (this.Options.verbose) this.Options.log('deliverySubscribeSingle: Subscribed to ' + endpoint);
Expand Down Expand Up @@ -2229,14 +2266,14 @@ export default class Binance {
host: this.parseProxy(socksproxy)[1],
port: this.parseProxy(socksproxy)[2]
});
ws = new WebSocket((this.Options.test ? this.dstreamTest : this.dstream) + queryParams, { agent });
ws = new WebSocket((this.getDStreamUrl()) + queryParams, { agent });
} else if (httpsproxy) {
if (this.Options.verbose) this.Options.log(`deliverySubscribe: using proxy server ${httpsproxy}`);
const config = url.parse(httpsproxy);
const agent = new HttpsProxyAgent(config);
ws = new WebSocket((this.Options.test ? this.dstreamTest : this.dstream) + queryParams, { agent });
ws = new WebSocket((this.getDStreamUrl()) + queryParams, { agent });
} else {
ws = new WebSocket((this.Options.test ? this.dstreamTest : this.dstream) + queryParams);
ws = new WebSocket((this.getDStreamUrl()) + queryParams);
}

ws.reconnect = this.Options.reconnect;
Expand Down Expand Up @@ -5663,7 +5700,8 @@ export default class Binance {
* @param {Function} subscribed_callback - subscription callback
*/
userFutureData(all_updates_callback?: Callback, margin_call_callback?: Callback, account_update_callback?: Callback, order_update_callback?: Callback, subscribed_callback?: Callback, account_config_update_callback?: Callback) {
const url = (this.Options.test) ? this.fapiTest : this.fapi;
// const url = (this.Options.test) ? this.fapiTest : this.fapi;
const url = this.getFapiUrl();
Comment on lines +5703 to +5704
Copy link

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the commented-out code. Dead code should be deleted rather than commented out.

Copilot uses AI. Check for mistakes.


const reconnect = () => {
if (this.Options.reconnect) this.userFutureData(all_updates_callback, margin_call_callback, account_update_callback, order_update_callback, subscribed_callback);
Expand Down Expand Up @@ -5708,7 +5746,7 @@ export default class Binance {
order_update_callback?: Callback,
subscribed_callback?: Callback
) {
const url = this.Options.test ? this.dapiTest : this.dapi;
const url = this.getDapiUrl();

const reconnect = async () => {
if (this.Options.reconnect)
Expand Down
1 change: 1 addition & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ export interface IConstructorArgs {
useServerTime: boolean;
reconnect: boolean;
test: boolean;
demo: boolean;
hedgeMode: boolean;
httpsProxy: string;
socksProxy: string;
Expand Down
12 changes: 7 additions & 5 deletions tests/binance-class-live.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,15 @@ let debug = function (x) {
const binance = new Binance().options({
APIKEY: 'X4BHNSimXOK6RKs2FcKqExquJtHjMxz5hWqF0BBeVnfa5bKFMk7X0wtkfEz0cPrJ',
APISECRET: 'x8gLihunpNq0d46F2q0TWJmeCDahX5LMXSlv3lSFNbMI3rujSOpTDKdhbcmPSf2i',
test: true
test: true,
httpsProxy: 'http://188.245.226.105:8911'
});

const futuresBinance = new Binance().options({
APIKEY: '227719da8d8499e8d3461587d19f259c0b39c2b462a77c9b748a6119abd74401',
APISECRET: 'b14b935f9cfacc5dec829008733c40da0588051f29a44625c34967b45c11d73c',
hedgeMode: true,
test: true
APIKEY: 'HjhMFvuF1veWQVdUbLIy7TiCYe9fj4W6sEukmddD8TM9kPVRHMK6nS2SdV5mwE5u',
APISECRET: 'Suu9pWcO9zbvVuc6cSQsVuiiw2DmmA8DgHrUfePF9s2RtaHa0zxK3eAF4MfIk7Pd',
demo: true,
httpsProxy: 'http://188.245.226.105:8911'
});

/*global describe*/
Expand Down Expand Up @@ -307,6 +308,7 @@ describe('Futures MarketBuy', function () {
assert(res['orderId'] !== undefined)
futuresOrderId = res['orderId'];
} catch (e) {
console.error(e);
const exceptionA = '{"code":-2010,"msg":"Account has insufficient balance for requested action."}';
const exceptionB = '{"code":-2019,"msg":"Margin is insufficient."}'
const eStr = e.toString();
Expand Down
7 changes: 4 additions & 3 deletions tests/binance-ws-futures.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ const TIMEOUT = 40000;


const futuresBinance = new Binance().options({
APIKEY: '227719da8d8499e8d3461587d19f259c0b39c2b462a77c9b748a6119abd74401',
APISECRET: 'b14b935f9cfacc5dec829008733c40da0588051f29a44625c34967b45c11d73c',
APIKEY: 'HjhMFvuF1veWQVdUbLIy7TiCYe9fj4W6sEukmddD8TM9kPVRHMK6nS2SdV5mwE5u',
APISECRET: 'Suu9pWcO9zbvVuc6cSQsVuiiw2DmmA8DgHrUfePF9s2RtaHa0zxK3eAF4MfIk7Pd',
hedgeMode: true,
test: true
demo: true,
httpsProxy: 'http://188.245.226.105:8911'
});


Expand Down
3 changes: 2 additions & 1 deletion tests/binance-ws-spot.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ const TIMEOUT = 40000;
const binance = new Binance().options({
APIKEY: 'X4BHNSimXOK6RKs2FcKqExquJtHjMxz5hWqF0BBeVnfa5bKFMk7X0wtkfEz0cPrJ',
APISECRET: 'x8gLihunpNq0d46F2q0TWJmeCDahX5LMXSlv3lSFNbMI3rujSOpTDKdhbcmPSf2i',
test: true
test: true,
httsProxy: 'http://188.245.226.105:8911'
});

const futuresBinance = new Binance().options({
Expand Down
Loading