binance
Version:
Professional Node.js & JavaScript SDK for Binance REST APIs & WebSockets, with TypeScript & end-to-end tests.
726 lines (725 loc) • 13.9 kB
TypeScript
/**
* The beautifier map defines how specific properties are renamed into a more readable property name.
*
* At first, it's a simple key:value map. The key is the original property name (e.g. aggTrades or bookTickerEvent (for the top-level name of an event: ("bookTicker" + "Event"))).
*
* The values have different behaviours:
* - Value is an object, each child property is renamed to the value
* e.g. aggTrades: { a: "aggTradeId" } -> aggTrades: { aggTradeId: value }
* - Value is a string, this points to another key in the map.
* e.g. klineEvent: { k: "kline" } resolves to
* klineEvent: { kline: { BEAUTIFIER_EVENT_MAP["kline"] } }
* - Value is an array, each element in that array is transformed into an object.
*/
export declare const BEAUTIFIER_EVENT_MAP: {
aggTrades: {
a: string;
p: string;
q: string;
f: string;
l: string;
T: string;
m: string;
M: string;
};
bookTickerEvent: {
e: string;
E: string;
T: string;
u: string;
s: string;
b: string;
B: string;
a: string;
A: string;
};
klines: {
0: string;
1: string;
2: string;
3: string;
4: string;
5: string;
6: string;
7: string;
8: string;
9: string;
10: string;
11: string;
};
bids: {
0: string;
1: string;
2: string;
}[];
asks: {
0: string;
1: string;
2: string;
}[];
avgPriceEvent: {
e: string;
E: string;
s: string;
i: string;
w: string;
T: string;
};
depthUpdateEvent: {
e: string;
E: string;
s: string;
U: string;
u: string;
b: string;
a: string;
};
depthOptionsEvent: {
e: string;
E: string;
T: string;
s: string;
U: string;
u: string;
pu: string;
b: string;
a: string;
};
bidDepthDelta: {
0: string;
1: string;
2: string;
}[];
askDepthDelta: {
0: string;
1: string;
2: string;
}[];
klineEvent: {
e: string;
E: string;
s: string;
k: string;
};
klineOptionsEvent: {
e: string;
E: string;
s: string;
k: string;
};
continuous_klineEvent: {
e: string;
E: string;
ps: string;
ct: string;
k: string;
};
indexPrice_klineEvent: {
e: string;
E: string;
ps: string;
k: string;
};
markPrice_klineEvent: {
e: string;
E: string;
ps: string;
k: string;
};
kline: {
t: string;
T: string;
s: string;
i: string;
f: string;
L: string;
o: string;
c: string;
h: string;
l: string;
v: string;
n: string;
x: string;
q: string;
V: string;
Q: string;
B: string;
F: string;
};
aggTradeEvent: {
e: string;
E: string;
s: string;
a: string;
p: string;
q: string;
f: string;
l: string;
T: string;
m: string;
M: string;
};
outboundAccountInfoEvent: {
e: string;
E: string;
m: string;
t: string;
b: string;
s: string;
T: string;
W: string;
D: string;
B: string;
u: string;
};
outboundAccountPositionEvent: {
e: string;
E: string;
u: string;
B: string;
};
balanceUpdateEvent: {
e: string;
E: string;
a: string;
d: string;
T: string;
};
indexPriceUpdateEvent: {
e: string;
E: string;
i: string;
p: string;
};
indexOptionsEvent: {
e: string;
E: string;
s: string;
p: string;
};
listStatusEvent: {
e: string;
E: string;
s: string;
g: string;
c: string;
l: string;
L: string;
r: string;
C: string;
T: string;
O: string;
};
markPriceUpdateEvent: {
e: string;
E: string;
s: string;
p: string;
i: string;
P: string;
r: string;
T: string;
};
markPriceEvent: {
e: string;
E: string;
s: string;
p: string;
i: string;
P: string;
r: string;
T: string;
mp: string;
};
markPriceOptionsEvent: {
e: string;
E: string;
s: string;
p: string;
i: string;
P: string;
r: string;
T: string;
mp: string;
};
orders: {
s: string;
i: string;
c: string;
}[];
ACCOUNT_UPDATEEvent: {
e: string;
E: string;
T: string;
a: string;
};
MARGIN_CALLEvent: {
e: string;
E: string;
cw: string;
p: string;
};
ORDER_TRADE_UPDATEEvent: {
e: string;
E: string;
T: string;
o: string;
};
TRADE_LITEEvent: {
e: string;
E: string;
T: string;
o: string;
s: string;
q: string;
p: string;
m: string;
c: string;
S: string;
L: string;
l: string;
t: string;
i: string;
};
CONDITIONAL_ORDER_TRIGGER_REJECTEvent: {
e: string;
E: string;
T: string;
or: string;
s: string;
i: string;
r: string;
};
CONDITIONAL_ORDER_TRADE_UPDATEEvent: {
e: string;
E: string;
T: string;
fs: string;
so: string;
};
order: {
s: string;
c: string;
S: string;
o: string;
f: string;
q: string;
p: string;
ap: string;
si: string;
st: string;
sp: string;
x: string;
X: string;
i: string;
l: string;
z: string;
L: string;
N: string;
n: string;
T: string;
t: string;
b: string;
a: string;
m: string;
R: string;
wt: string;
ot: string;
ps: string;
cp: string;
AP: string;
cr: string;
rp: string;
V: string;
pm: string;
gtd: string;
os: string;
ut: string;
};
ACCOUNT_CONFIG_UPDATEEvent: {
e: string;
E: string;
T: string;
ac: string;
ai: string;
};
COIN_SWAP_ORDEREvent: {
e: string;
E: string;
T: string;
c: string;
};
coinSwapOrder: {
o: string;
a: string;
qa: string;
};
assetConfiguration: {
s: string;
l: string;
};
accountConfiguration: {
j: string;
};
positions: {
s: string;
ps: string;
pa: string;
mt: string;
iw: string;
mp: string;
up: string;
mm: string;
}[];
listenKeyExpiredEvent: {
e: string;
E: string;
};
updateData: {
m: string;
P: string;
B: string;
};
updatedBalances: {
a: string;
wb: string;
cw: string;
bc: string;
}[];
updatedPositions: {
s: string;
ma: string;
pa: string;
ep: string;
cr: string;
up: string;
mt: string;
iw: string;
ps: string;
}[];
balances: {
a: string;
f: string;
l: string;
}[];
executionReportEvent: {
e: string;
E: string;
s: string;
c: string;
S: string;
o: string;
f: string;
q: string;
p: string;
P: string;
F: string;
g: string;
C: string;
x: string;
X: string;
r: string;
i: string;
l: string;
z: string;
L: string;
n: string;
N: string;
T: string;
t: string;
I: string;
w: string;
m: string;
M: string;
O: string;
Z: string;
Y: string;
Q: string;
W: string;
V: string;
};
tradeEvent: {
e: string;
E: string;
s: string;
t: string;
p: string;
q: string;
b: string;
a: string;
T: string;
m: string;
M: string;
};
tradeOptionsEvent: {
e: string;
E: string;
s: string;
t: string;
p: string;
q: string;
b: string;
a: string;
T: string;
m: string;
M: string;
S: string;
X: string;
};
'24hrTickerEvent': {
e: string;
E: string;
s: string;
p: string;
P: string;
w: string;
x: string;
c: string;
Q: string;
b: string;
B: string;
a: string;
A: string;
o: string;
h: string;
l: string;
v: string;
q: string;
O: string;
C: string;
F: string;
L: string;
n: string;
};
tickerEvent: {
e: string;
E: string;
T: string;
s: string;
p: string;
P: string;
w: string;
x: string;
c: string;
Q: string;
b: string;
B: string;
a: string;
A: string;
bo: string;
ao: string;
bq: string;
aq: string;
o: string;
h: string;
l: string;
v: string;
q: string;
O: string;
C: string;
F: string;
L: string;
n: string;
};
tickerOptionsEvent: {
e: string;
E: string;
T: string;
s: string;
o: string;
h: string;
l: string;
c: string;
V: string;
A: string;
P: string;
p: string;
Q: string;
F: string;
L: string;
n: string;
bo: string;
ao: string;
bq: string;
aq: string;
b: string;
a: string;
d: string;
t: string;
g: string;
v: string;
vo: string;
mp: string;
hl: string;
ll: string;
eep: string;
};
openInterestOptionsEvent: {
e: string;
E: string;
s: string;
o: string;
h: string;
};
'24hrMiniTickerEvent': {
e: string;
E: string;
s: string;
ps: string;
c: string;
o: string;
h: string;
l: string;
v: string;
q: string;
};
miniTickerEvent: {
e: string;
E: string;
s: string;
ps: string;
c: string;
o: string;
h: string;
l: string;
v: string;
q: string;
};
'1hTickerEvent': {
e: string;
E: string;
s: string;
p: string;
P: string;
o: string;
h: string;
l: string;
c: string;
w: string;
v: string;
q: string;
O: string;
C: string;
F: string;
L: string;
n: string;
};
'4hTickerEvent': {
e: string;
E: string;
s: string;
p: string;
P: string;
o: string;
h: string;
l: string;
c: string;
w: string;
v: string;
q: string;
O: string;
C: string;
F: string;
L: string;
n: string;
};
'1dTickerEvent': {
e: string;
E: string;
s: string;
p: string;
P: string;
o: string;
h: string;
l: string;
c: string;
w: string;
v: string;
q: string;
O: string;
C: string;
F: string;
L: string;
n: string;
};
forceOrderEvent: {
e: string;
E: string;
o: string;
};
liquidationOrder: {
s: string;
S: string;
o: string;
f: string;
q: string;
p: string;
ap: string;
X: string;
l: string;
z: string;
T: string;
};
liabilityChangeEvent: {
e: string;
E: string;
a: string;
t: string;
T: string;
p: string;
i: string;
l: string;
};
contractInfoEvent: {
e: string;
E: string;
s: string;
ps: string;
ct: string;
dt: string;
ot: string;
cs: string;
bks: string;
};
notionalBrackets: {
bs: string;
bnf: string;
bnc: string;
mmr: string;
cf: string;
mi: string;
ma: string;
}[];
GRID_UPDATEEvent: {
e: string;
T: string;
E: string;
gu: string;
};
grid: {
si: string;
st: string;
ss: string;
s: string;
r: string;
up: string;
uq: string;
uf: string;
mp: string;
ut: string;
};
STRATEGY_UPDATEEvent: {
e: string;
T: string;
E: string;
su: string;
};
strategy: {
si: string;
st: string;
ss: string;
s: string;
ut: string;
c: string;
};
};