Skip to content

Commit d6bc1a8

Browse files
tsungilintsungilin
tsungilin
authored and
tsungilin
committed
add example
1 parent de8d6f1 commit d6bc1a8

31 files changed

+459
-34
lines changed

‎.npmignore

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
# Exclude typescript source and config
3+
*.ts
4+
tsconfig.json
5+
6+
# Include javascript files and typescript declarations
7+
!*.js
8+
!*.d.ts
9+
10+
# Exclude jsii outdir
11+
dist
12+
13+
# Include .jsii
14+
!.jsii

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func main() {
5050
```
5151
```python
5252
# python
53-
from mexc-sdk import Spot
53+
from mexc_sdk import Spot
5454
spot = Spot(api_key='apiKey', apiSecret='apiSecret')
5555
```
5656
```java

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"scripts": {
88
"build": "jsii",
99
"build:watch": "jsii --watch",
10-
"package": "rm -rf ./dist && jsii-pacmak -vvv"
10+
"package": "mv ./test ../ && rm -rf ./dist && jsii-pacmak -vvv && mv ../test ./"
1111
},
1212
"repository": {
1313
"type": "git",

‎src/modules/base.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ import * as crypto from 'crypto';
33

44
export class Base {
55
public config: any = {};
6-
constructor(apiKey: any, apiSecret: any) {
6+
constructor(apiKey: string, apiSecret: string) {
77
this.config.apiKey = apiKey;
88
this.config.apiSecret = apiSecret;
99
this.config.baseURL = 'https://api.mexc.com/api/v3';
1010
}
1111

12-
public publicRequest (method: any, path: any, paramsObj: any = {}): any {
12+
public publicRequest (method: string, path: string, paramsObj: any = {}): any {
1313
paramsObj = removeEmptyValue(paramsObj)
1414
paramsObj = buildQueryString(paramsObj)
1515
if(paramsObj !== '') {
@@ -22,12 +22,12 @@ export class Base {
2222
url: path,
2323
headers: {
2424
'Content-Type': 'application/json',
25-
'X-MBX-APIKEY': this.config.apiKey
25+
'X-MEXC-APIKEY': this.config.apiKey
2626
}
2727
})
2828
}
2929

30-
public signRequest(method: any, path: any, paramsObj: any = {}): any {
30+
public signRequest(method: string, path: string, paramsObj: any = {}): any {
3131
const timestamp = Date.now()
3232
paramsObj = removeEmptyValue(paramsObj)
3333
const queryString = buildQueryString({ ...paramsObj, timestamp })
@@ -42,7 +42,7 @@ export class Base {
4242
url: `${path}?${queryString}&signature=${signature}`,
4343
headers: {
4444
'Content-Type': 'application/json',
45-
'X-MBX-APIKEY': this.config.apiKey
45+
'X-MEXC-APIKEY': this.config.apiKey
4646
}
4747
})
4848
}

‎src/modules/market.ts

+44-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { Base } from './base';
2+
import { fromatData } from '../util'
23

34
export class Market extends Base {
45
/**
@@ -7,7 +8,7 @@ export class Market extends Base {
78
* @param options
89
* ```
910
* [options.symbol] - symbol(optional) ex: BTCUSDT.
10-
* [options.symbols] - an array of symbols, add double quote for each symbol in list. ex: ["BTCUSDT","BNBBTC"].
11+
* [options.symbols] - for mutiple symbols, add comma for each symbol in string. ex: BTCUSDT,BNBBTC .
1112
*```
1213
* @returns
1314
*/
@@ -16,12 +17,14 @@ export class Market extends Base {
1617
options["symbol"] = options["symbol"].toUpperCase();
1718
}
1819
if (Object.keys(options).includes("symbols")) {
19-
options["symbols"] = options["symbols"].map((symbol: any) => symbol.toUpperCase());
20+
options["symbols"] = options["symbols"].split(',').map((symbol: any) => symbol.toUpperCase()).join(',');
2021
}
2122

2223
const res = this.publicRequest("GET", "/exchangeInfo", options);
24+
const rawData = JSON.parse(res.getBody());
25+
const formatDatas = fromatData(rawData);
2326

24-
return JSON.parse(res.getBody());
27+
return formatDatas;
2528
}
2629

2730
/**
@@ -43,7 +46,10 @@ export class Market extends Base {
4346
})
4447
);
4548

46-
return JSON.parse(res.getBody());
49+
const rawData = JSON.parse(res.getBody());
50+
const formatDatas = fromatData(rawData);
51+
52+
return formatDatas;
4753
}
4854

4955
/**
@@ -65,7 +71,10 @@ export class Market extends Base {
6571
})
6672
);
6773

68-
return JSON.parse(res.getBody());
74+
const rawData = JSON.parse(res.getBody());
75+
const formatDatas = fromatData(rawData);
76+
77+
return formatDatas;
6978
}
7079

7180
/**
@@ -87,12 +96,16 @@ export class Market extends Base {
8796
})
8897
);
8998

90-
return JSON.parse(res.getBody());
99+
const rawData = JSON.parse(res.getBody());
100+
const formatDatas = fromatData(rawData);
101+
102+
return formatDatas;
91103
}
92104

93105
/**
94106
* Compressed/Aggregate Trades List
95-
*
107+
*
108+
* Note: If sending startTime and endTime, the interval must be less than one hour
96109
* @param symbol
97110
* @param options
98111
* ```
@@ -112,7 +125,10 @@ export class Market extends Base {
112125
})
113126
);
114127

115-
return JSON.parse(res.getBody());
128+
const rawData = JSON.parse(res.getBody());
129+
const formatDatas = fromatData(rawData);
130+
131+
return formatDatas;
116132
}
117133

118134
/**
@@ -137,7 +153,10 @@ export class Market extends Base {
137153
interval: interval,
138154
})
139155
);
140-
return JSON.parse(res.getBody());
156+
const rawData = JSON.parse(res.getBody());
157+
const formatDatas = fromatData(rawData);
158+
159+
return formatDatas;
141160
}
142161

143162
/**
@@ -147,7 +166,10 @@ export class Market extends Base {
147166
*/
148167
avgPrice(symbol: string) {
149168
const res = this.publicRequest("GET", "/avgPrice", { symbol: symbol.toUpperCase() });
150-
return JSON.parse(res.getBody());
169+
const rawData = JSON.parse(res.getBody());
170+
const formatDatas = fromatData(rawData);
171+
172+
return formatDatas;
151173
}
152174

153175
/**
@@ -161,8 +183,10 @@ export class Market extends Base {
161183
}
162184

163185
const res = this.publicRequest("GET", "/ticker/24hr", { symbol });
186+
const rawData = JSON.parse(res.getBody());
187+
const formatDatas = fromatData(rawData);
164188

165-
return JSON.parse(res.getBody());
189+
return formatDatas;
166190
}
167191

168192
/**
@@ -174,8 +198,12 @@ export class Market extends Base {
174198
if (symbol) {
175199
symbol = symbol.toUpperCase();
176200
}
201+
202+
const res = this.publicRequest("GET", "/ticker/price", { symbol });
203+
const rawData = JSON.parse(res.getBody());
204+
const formatDatas = fromatData(rawData);
177205

178-
return this.publicRequest("GET", "/api/v3/ticker/price", { symbol });
206+
return formatDatas;
179207
}
180208

181209
/**
@@ -188,6 +216,9 @@ export class Market extends Base {
188216
}
189217

190218
const res = this.publicRequest("GET", "/ticker/bookTicker", { symbol });
191-
return JSON.parse(res.getBody());
219+
const rawData = JSON.parse(res.getBody());
220+
const formatDatas = fromatData(rawData);
221+
222+
return formatDatas;
192223
}
193224
}

‎src/modules/trade.ts

+31-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { UserData } from './userData';
2+
import { fromatData } from '../util'
23

34
export class Trade extends UserData {
45
/**
@@ -37,7 +38,10 @@ export class Trade extends UserData {
3738
side: side.toUpperCase(),
3839
type: orderType.toUpperCase()
3940
}))
40-
return JSON.parse(res.getBody('utf8'))
41+
const rawData = JSON.parse(res.getBody());
42+
const formatDatas = fromatData(rawData);
43+
44+
return formatDatas;
4145
}
4246

4347
/**
@@ -76,7 +80,10 @@ export class Trade extends UserData {
7680
side: side.toUpperCase(),
7781
type: orderType.toUpperCase()
7882
}))
79-
return JSON.parse(res.getBody('utf8'))
83+
const rawData = JSON.parse(res.getBody());
84+
const formatDatas = fromatData(rawData);
85+
86+
return formatDatas;
8087
}
8188

8289
/**
@@ -95,7 +102,10 @@ export class Trade extends UserData {
95102
const res = this.signRequest('DELETE', '/order', Object.assign(options, {
96103
symbol: symbol.toUpperCase()
97104
}))
98-
return JSON.parse(res.getBody())
105+
const rawData = JSON.parse(res.getBody());
106+
const formatDatas = fromatData(rawData);
107+
108+
return formatDatas;
99109
}
100110

101111
/**
@@ -108,7 +118,10 @@ export class Trade extends UserData {
108118
const res = this.signRequest('DELETE', '/openOrders', {
109119
symbol: symbol.toUpperCase()
110120
})
111-
return JSON.parse(res.getBody())
121+
const rawData = JSON.parse(res.getBody());
122+
const formatDatas = fromatData(rawData);
123+
124+
return formatDatas;
112125
}
113126

114127
/**
@@ -117,7 +130,7 @@ export class Trade extends UserData {
117130
* @param symbol
118131
* @param options
119132
* ```
120-
* [options.orderId]
133+
* [options.orderId] - At least one of orderId and origClientOrderId needs to be sent
121134
* [options.origClientOrderId]
122135
* ```
123136
* @returns
@@ -126,7 +139,10 @@ export class Trade extends UserData {
126139
const res = this.signRequest('GET', '/order', Object.assign(options, {
127140
symbol: symbol.toUpperCase()
128141
}))
129-
return JSON.parse(res.getBody())
142+
const rawData = JSON.parse(res.getBody());
143+
const formatDatas = fromatData(rawData);
144+
145+
return formatDatas;
130146
}
131147

132148
/**
@@ -137,7 +153,10 @@ export class Trade extends UserData {
137153
*/
138154
public openOrders(symbol: string) {
139155
const res = this.signRequest('GET', '/openOrders', { symbol: symbol.toUpperCase()})
140-
return JSON.parse(res.getBody())
156+
const rawData = JSON.parse(res.getBody());
157+
const formatDatas = fromatData(rawData);
158+
159+
return formatDatas;
141160
}
142161

143162
/**
@@ -146,7 +165,7 @@ export class Trade extends UserData {
146165
* @param symbol
147166
* @param options
148167
* ```
149-
* [options.orderId]
168+
* [options.orderId] - If startTime and endTime are set, orderId does not need to be set
150169
* [options.startTime]
151170
* [options.endTime]
152171
* [options.limit] - value between 1 and 1000, default is 500
@@ -157,6 +176,9 @@ export class Trade extends UserData {
157176
const res = this.signRequest('GET', '/allOrders', Object.assign(options, {
158177
symbol: symbol.toUpperCase()
159178
}))
160-
return JSON.parse(res.getBody())
179+
const rawData = JSON.parse(res.getBody());
180+
const formatDatas = fromatData(rawData);
181+
182+
return formatDatas;
161183
}
162184
}

‎src/modules/userData.ts

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { Common } from './common';
2+
import { fromatData } from '../util'
23

34
export class UserData extends Common {
45
/**
@@ -7,8 +8,11 @@ export class UserData extends Common {
78
* @returns
89
*/
910
public accountInfo() {
10-
const res = this.publicRequest('GET', '/account')
11-
return JSON.parse(res.getBody())
11+
const res = this.signRequest ('GET', '/account')
12+
const rawData = JSON.parse(res.getBody());
13+
const formatDatas = fromatData(rawData);
14+
15+
return formatDatas;
1216
}
1317

1418

@@ -27,9 +31,12 @@ export class UserData extends Common {
2731
* @returns
2832
*/
2933
public accountTradeList(symbol: string, options:any = { limit: 500 }) {
30-
const res = this.publicRequest('GET', '/myTrades', Object.assign(options, {
34+
const res = this.signRequest('GET', '/myTrades', Object.assign(options, {
3135
symbol: symbol.toUpperCase()
3236
}))
33-
return JSON.parse(res.getBody())
37+
const rawData = JSON.parse(res.getBody());
38+
const formatDatas = fromatData(rawData);
39+
40+
return formatDatas;
3441
}
3542
}

‎src/util/util.ts

+16-1
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,24 @@ const buildQueryString = (params: any) => {
3333
.join('&')
3434
}
3535

36+
const fromatData = (datas: any): any => {
37+
if(Array.isArray(datas)) {
38+
return datas.map((data: any) => {
39+
return fromatData(data)
40+
})
41+
} else if (typeof datas === "object" && datas !== null) {
42+
const newObj: any = {}
43+
Object.entries(datas).map(([key, value]: any[]) => newObj[key] = fromatData(value))
44+
return newObj;
45+
} else {
46+
return (datas === undefined || datas === null) ? "" : datas
47+
}
48+
}
49+
3650
export {
3751
createRequest,
3852
buildQueryString,
3953
removeEmptyValue,
40-
isEmptyValue
54+
isEmptyValue,
55+
fromatData
4156
}

0 commit comments

Comments
 (0)