coinbase-api 1.0.15-beta.0 → 1.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/cjs/CBAdvancedTradeClient.js +1 -1
- package/dist/cjs/CBAdvancedTradeClient.js.map +1 -1
- package/dist/cjs/CBAppClient.d.ts +8 -13
- package/dist/cjs/CBAppClient.js +41 -13
- package/dist/cjs/CBAppClient.js.map +1 -1
- package/dist/cjs/CBInternationalClient.d.ts +45 -0
- package/dist/cjs/CBInternationalClient.js +46 -3
- package/dist/cjs/CBInternationalClient.js.map +1 -1
- package/dist/cjs/CBPrimeClient.d.ts +128 -21
- package/dist/cjs/CBPrimeClient.js +160 -23
- package/dist/cjs/CBPrimeClient.js.map +1 -1
- package/dist/cjs/lib/BaseRestClient.js +42 -9
- package/dist/cjs/lib/BaseRestClient.js.map +1 -1
- package/dist/cjs/lib/BaseWSClient.js +2 -2
- package/dist/cjs/lib/BaseWSClient.js.map +1 -1
- package/dist/cjs/lib/jwtNode.js +0 -44
- package/dist/cjs/lib/jwtNode.js.map +1 -1
- package/dist/cjs/lib/requestUtils.d.ts +11 -1
- package/dist/cjs/lib/requestUtils.js +57 -9
- package/dist/cjs/lib/requestUtils.js.map +1 -1
- package/dist/cjs/lib/websocket/websocket-util.d.ts +6 -0
- package/dist/cjs/lib/websocket/websocket-util.js +19 -0
- package/dist/cjs/lib/websocket/websocket-util.js.map +1 -1
- package/dist/cjs/types/request/advanced-trade-client.d.ts +1 -0
- package/dist/cjs/types/request/advanced-trade-client.js.map +1 -1
- package/dist/cjs/types/request/coinbase-app-client.d.ts +19 -2
- package/dist/cjs/types/request/coinbase-app-client.js.map +1 -1
- package/dist/cjs/types/request/coinbase-international.d.ts +1 -1
- package/dist/cjs/types/request/coinbase-prime.d.ts +66 -0
- package/dist/cjs/types/response/coinbase-app-client.d.ts +89 -2
- package/dist/cjs/types/response/coinbase-app-client.js.map +1 -1
- package/dist/cjs/types/shared.types.d.ts +8 -0
- package/dist/mjs/CBAdvancedTradeClient.js +1 -1
- package/dist/mjs/CBAdvancedTradeClient.js.map +1 -1
- package/dist/mjs/CBAppClient.d.ts +8 -13
- package/dist/mjs/CBAppClient.js +42 -14
- package/dist/mjs/CBAppClient.js.map +1 -1
- package/dist/mjs/CBInternationalClient.d.ts +45 -0
- package/dist/mjs/CBInternationalClient.js +46 -3
- package/dist/mjs/CBInternationalClient.js.map +1 -1
- package/dist/mjs/CBPrimeClient.d.ts +128 -21
- package/dist/mjs/CBPrimeClient.js +160 -23
- package/dist/mjs/CBPrimeClient.js.map +1 -1
- package/dist/mjs/lib/BaseRestClient.js +42 -9
- package/dist/mjs/lib/BaseRestClient.js.map +1 -1
- package/dist/mjs/lib/BaseWSClient.js +3 -3
- package/dist/mjs/lib/BaseWSClient.js.map +1 -1
- package/dist/mjs/lib/jwtNode.js +0 -44
- package/dist/mjs/lib/jwtNode.js.map +1 -1
- package/dist/mjs/lib/requestUtils.d.ts +11 -1
- package/dist/mjs/lib/requestUtils.js +56 -9
- package/dist/mjs/lib/requestUtils.js.map +1 -1
- package/dist/mjs/lib/websocket/websocket-util.d.ts +6 -0
- package/dist/mjs/lib/websocket/websocket-util.js +18 -0
- package/dist/mjs/lib/websocket/websocket-util.js.map +1 -1
- package/dist/mjs/types/request/advanced-trade-client.d.ts +1 -0
- package/dist/mjs/types/request/advanced-trade-client.js.map +1 -1
- package/dist/mjs/types/request/coinbase-app-client.d.ts +19 -2
- package/dist/mjs/types/request/coinbase-app-client.js.map +1 -1
- package/dist/mjs/types/request/coinbase-international.d.ts +1 -1
- package/dist/mjs/types/request/coinbase-prime.d.ts +66 -0
- package/dist/mjs/types/response/coinbase-app-client.d.ts +89 -2
- package/dist/mjs/types/response/coinbase-app-client.js.map +1 -1
- package/dist/mjs/types/shared.types.d.ts +8 -0
- package/package.json +6 -7
package/dist/mjs/CBAppClient.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BaseRestClient } from './lib/BaseRestClient.js';
|
|
2
|
-
import { REST_CLIENT_TYPE_ENUM, } from './lib/requestUtils.js';
|
|
2
|
+
import { getParamsFromURL, REST_CLIENT_TYPE_ENUM, } from './lib/requestUtils.js';
|
|
3
3
|
/**
|
|
4
4
|
* REST client for Coinbase's Coinbase App API:
|
|
5
5
|
* https://docs.cdp.coinbase.com/coinbase-app/docs/welcome
|
|
@@ -11,7 +11,7 @@ export class CBAppClient extends BaseRestClient {
|
|
|
11
11
|
headers: {
|
|
12
12
|
// Some endpoints return a warning if a version header isn't included: https://docs.cdp.coinbase.com/coinbase-app/docs/versioning
|
|
13
13
|
// Currently set to a date from the changelog: https://docs.cdp.coinbase.com/coinbase-app/docs/changelog
|
|
14
|
-
'CB-VERSION': '
|
|
14
|
+
'CB-VERSION': '2025-FEB-3',
|
|
15
15
|
...requestOptions.headers,
|
|
16
16
|
},
|
|
17
17
|
});
|
|
@@ -35,9 +35,10 @@ export class CBAppClient extends BaseRestClient {
|
|
|
35
35
|
*/
|
|
36
36
|
getAccounts(params) {
|
|
37
37
|
if (params?.paginationURL) {
|
|
38
|
-
|
|
38
|
+
const derivedParams = getParamsFromURL(params.paginationURL);
|
|
39
|
+
return this.getPrivate(derivedParams.endpoint, derivedParams.params);
|
|
39
40
|
}
|
|
40
|
-
return this.getPrivate('/v2/accounts');
|
|
41
|
+
return this.getPrivate('/v2/accounts', params);
|
|
41
42
|
}
|
|
42
43
|
/**
|
|
43
44
|
* Show Account
|
|
@@ -71,10 +72,15 @@ export class CBAppClient extends BaseRestClient {
|
|
|
71
72
|
* If you are paginating, provide the paginationURL value from the previous response and you will receive the next page of addresses.
|
|
72
73
|
*/
|
|
73
74
|
getAddresses(params) {
|
|
75
|
+
const { account_id, ...otherParams } = params;
|
|
74
76
|
if (params?.paginationURL) {
|
|
75
|
-
|
|
77
|
+
const derivedParams = getParamsFromURL(params.paginationURL);
|
|
78
|
+
return this.getPrivate(derivedParams.endpoint, {
|
|
79
|
+
...otherParams,
|
|
80
|
+
...derivedParams.params,
|
|
81
|
+
});
|
|
76
82
|
}
|
|
77
|
-
return this.getPrivate(`/v2/accounts/${
|
|
83
|
+
return this.getPrivate(`/v2/accounts/${account_id}/addresses`, otherParams);
|
|
78
84
|
}
|
|
79
85
|
/**
|
|
80
86
|
* Show Address
|
|
@@ -97,10 +103,15 @@ export class CBAppClient extends BaseRestClient {
|
|
|
97
103
|
* If you are paginating, provide the paginationURL value from the previous response and you will receive the next page of transactions.
|
|
98
104
|
*/
|
|
99
105
|
getAddressTransactions(params) {
|
|
106
|
+
const { account_id, addressId, ...otherParams } = params;
|
|
100
107
|
if (params?.paginationURL) {
|
|
101
|
-
|
|
108
|
+
const derivedParams = getParamsFromURL(params.paginationURL);
|
|
109
|
+
return this.getPrivate(derivedParams.endpoint, {
|
|
110
|
+
...otherParams,
|
|
111
|
+
...derivedParams.params,
|
|
112
|
+
});
|
|
102
113
|
}
|
|
103
|
-
return this.getPrivate(`/v2/accounts/${
|
|
114
|
+
return this.getPrivate(`/v2/accounts/${account_id}/addresses/${addressId}/transactions`, otherParams);
|
|
104
115
|
}
|
|
105
116
|
/**
|
|
106
117
|
*
|
|
@@ -112,6 +123,8 @@ export class CBAppClient extends BaseRestClient {
|
|
|
112
123
|
*
|
|
113
124
|
* Send funds to a network address for any Coinbase supported asset, or email address of the recipient.
|
|
114
125
|
* No transaction fees are required for off-blockchain cryptocurrency transactions.
|
|
126
|
+
*
|
|
127
|
+
* TRAVEL RULE DATA GUIDE: https://docs.cdp.coinbase.com/coinbase-app/docs/coinbase-app-travel-rule
|
|
115
128
|
*/
|
|
116
129
|
sendMoney(params) {
|
|
117
130
|
const { account_id, ...restParams } = params;
|
|
@@ -140,10 +153,15 @@ export class CBAppClient extends BaseRestClient {
|
|
|
140
153
|
* If you are paginating, provide the paginationURL value from the previous response and you will receive the next page of transactions.
|
|
141
154
|
*/
|
|
142
155
|
getTransactions(params) {
|
|
156
|
+
const { account_id, ...otherParams } = params;
|
|
143
157
|
if (params?.paginationURL) {
|
|
144
|
-
|
|
158
|
+
const derivedParams = getParamsFromURL(params.paginationURL);
|
|
159
|
+
return this.getPrivate(derivedParams.endpoint, {
|
|
160
|
+
...otherParams,
|
|
161
|
+
...derivedParams.params,
|
|
162
|
+
});
|
|
145
163
|
}
|
|
146
|
-
return this.getPrivate(`/v2/accounts/${
|
|
164
|
+
return this.getPrivate(`/v2/accounts/${account_id}/transactions`, otherParams);
|
|
147
165
|
}
|
|
148
166
|
/**
|
|
149
167
|
* Show Transaction
|
|
@@ -186,10 +204,15 @@ export class CBAppClient extends BaseRestClient {
|
|
|
186
204
|
* If you are paginating, provide the paginationURL value from the previous response and you will receive the next page of deposits.
|
|
187
205
|
*/
|
|
188
206
|
getDeposits(params) {
|
|
207
|
+
const { account_id, ...otherParams } = params;
|
|
189
208
|
if (params?.paginationURL) {
|
|
190
|
-
|
|
209
|
+
const derivedParams = getParamsFromURL(params.paginationURL);
|
|
210
|
+
return this.getPrivate(derivedParams.endpoint, {
|
|
211
|
+
...otherParams,
|
|
212
|
+
...derivedParams.params,
|
|
213
|
+
});
|
|
191
214
|
}
|
|
192
|
-
return this.getPrivate(`/v2/accounts/${
|
|
215
|
+
return this.getPrivate(`/v2/accounts/${account_id}/deposits`, otherParams);
|
|
193
216
|
}
|
|
194
217
|
/**
|
|
195
218
|
* Show Deposit
|
|
@@ -232,10 +255,15 @@ export class CBAppClient extends BaseRestClient {
|
|
|
232
255
|
* If you are paginating, provide the paginationURL value from the previous response and you will receive the next page of withdrawals.
|
|
233
256
|
*/
|
|
234
257
|
getWithdrawals(params) {
|
|
258
|
+
const { account_id, ...otherParams } = params;
|
|
235
259
|
if (params?.paginationURL) {
|
|
236
|
-
|
|
260
|
+
const derivedParams = getParamsFromURL(params.paginationURL);
|
|
261
|
+
return this.getPrivate(derivedParams.endpoint, {
|
|
262
|
+
...otherParams,
|
|
263
|
+
...derivedParams.params,
|
|
264
|
+
});
|
|
237
265
|
}
|
|
238
|
-
return this.getPrivate(`/v2/accounts/${
|
|
266
|
+
return this.getPrivate(`/v2/accounts/${account_id}/withdrawals`, otherParams);
|
|
239
267
|
}
|
|
240
268
|
/**
|
|
241
269
|
* Show Withdrawal
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CBAppClient.js","sourceRoot":"","sources":["../../src/CBAppClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"CBAppClient.js","sourceRoot":"","sources":["../../src/CBAppClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,gBAAgB,EAChB,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;AAkB/B;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,cAAc;IAC7C,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE;YACvB,GAAG,cAAc;YACjB,OAAO,EAAE;gBACP,iIAAiI;gBACjI,wGAAwG;gBACxG,YAAY,EAAE,YAAY;gBAC1B,GAAG,cAAc,CAAC,OAAO;aAC1B;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,OAAO,qBAAqB,CAAC,WAAW,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IAEH;;;;;;;OAOG;IACH,WAAW,CAAC,MAGX;QAIC,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;YAC1B,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QACvE,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,MAA8B;QAGvC,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,aAAa,CAAC,MAA6C;QAGzD,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,MAAM,CAAC,UAAU,YAAY,EAAE;YACrE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,MAGZ;QAIC,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAC9C,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;YAC1B,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAC7C,GAAG,WAAW;gBACd,GAAG,aAAa,CAAC,MAAM;aACxB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,UAAU,YAAY,EAAE,WAAW,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAiD;QAG1D,OAAO,IAAI,CAAC,UAAU,CACpB,gBAAgB,MAAM,CAAC,UAAU,cAAc,MAAM,CAAC,SAAS,EAAE,CAClE,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,sBAAsB,CAAC,MAItB;QAIC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACzD,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;YAC1B,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAC7C,GAAG,WAAW;gBACd,GAAG,aAAa,CAAC,MAAM;aACxB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CACpB,gBAAgB,UAAU,cAAc,SAAS,eAAe,EAChE,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;;;;OAOG;IACH,SAAS,CACP,MAA6B;QAE7B,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,UAAU,eAAe,EAAE;YACjE,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,aAAa,CACX,MAAiC;QAEjC,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,UAAU,eAAe,EAAE;YACjE,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,MAGf;QAIC,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAC9C,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;YAC1B,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAC7C,GAAG,WAAW;gBACd,GAAG,aAAa,CAAC,MAAM;aACxB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CACpB,gBAAgB,UAAU,eAAe,EACzC,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAGd;QAGC,OAAO,IAAI,CAAC,UAAU,CACpB,gBAAgB,MAAM,CAAC,UAAU,iBAAiB,MAAM,CAAC,aAAa,EAAE,CACzE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,YAAY,CAAC,MAAgC;QAC3C,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,UAAU,WAAW,EAAE;YAC7D,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,MAGb;QACC,OAAO,IAAI,CAAC,WAAW,CACrB,gBAAgB,MAAM,CAAC,UAAU,aAAa,MAAM,CAAC,UAAU,SAAS,CACzE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,MAAsD;QAIhE,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAC9C,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;YAC1B,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAC7C,GAAG,WAAW;gBACd,GAAG,aAAa,CAAC,MAAM;aACxB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,UAAU,WAAW,EAAE,WAAW,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,MAAkD;QAG3D,OAAO,IAAI,CAAC,UAAU,CACpB,gBAAgB,MAAM,CAAC,UAAU,aAAa,MAAM,CAAC,UAAU,EAAE,CAClE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,aAAa,CAAC,MAAiC;QAC7C,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,UAAU,cAAc,EAAE;YAChE,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAGhB;QACC,OAAO,IAAI,CAAC,WAAW,CACrB,gBAAgB,MAAM,CAAC,UAAU,gBAAgB,MAAM,CAAC,aAAa,SAAS,CAC/E,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,MAGd;QAIC,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAC9C,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;YAC1B,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAC7C,GAAG,WAAW;gBACd,GAAG,aAAa,CAAC,MAAM;aACxB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CACpB,gBAAgB,UAAU,cAAc,EACxC,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,MAGb;QAGC,OAAO,IAAI,CAAC,UAAU,CACpB,gBAAgB,MAAM,CAAC,UAAU,gBAAgB,MAAM,CAAC,aAAa,EAAE,CACxE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,iBAAiB;QAGf,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,mBAAmB;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,gBAAgB,CAAC,MAA8B;QAM7C,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,WAAW,CAAC,MAAgC;QAM1C,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,MAAM,CAAC,YAAY,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,MAAgC;QAM3C,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,MAAM,CAAC,YAAY,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,MAA+C;QAM1D,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,YAAY,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,cAAc;QAMZ,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;CACF"}
|
|
@@ -319,6 +319,31 @@ export declare class CBInternationalClient extends BaseRestClient {
|
|
|
319
319
|
portfolio: string;
|
|
320
320
|
instrument: string;
|
|
321
321
|
}): Promise<any>;
|
|
322
|
+
/**
|
|
323
|
+
* Get total open position limit
|
|
324
|
+
*
|
|
325
|
+
* Retrieves the total open position limit across instruments for a given portfolio.
|
|
326
|
+
*/
|
|
327
|
+
getTotalOpenPositionLimit(params: {
|
|
328
|
+
portfolio: string;
|
|
329
|
+
}): Promise<any>;
|
|
330
|
+
/**
|
|
331
|
+
* List open position limits for all instruments
|
|
332
|
+
*
|
|
333
|
+
* Retrieves position limits for all positions a given portfolio currently has or has opened in the past.
|
|
334
|
+
*/
|
|
335
|
+
getOpenPositionLimitsForAllInstruments(params: {
|
|
336
|
+
portfolio: string;
|
|
337
|
+
}): Promise<any>;
|
|
338
|
+
/**
|
|
339
|
+
* Get open position limits for portfolio instrument
|
|
340
|
+
*
|
|
341
|
+
* Retrieves the position limits for a given portfolio and symbol.
|
|
342
|
+
*/
|
|
343
|
+
getOpenPositionLimitsForInstrument(params: {
|
|
344
|
+
portfolio: string;
|
|
345
|
+
instrument: string;
|
|
346
|
+
}): Promise<any>;
|
|
322
347
|
/**
|
|
323
348
|
* List fills by portfolios
|
|
324
349
|
*
|
|
@@ -359,6 +384,16 @@ export declare class CBInternationalClient extends BaseRestClient {
|
|
|
359
384
|
portfolio_id: string;
|
|
360
385
|
margin_override: string;
|
|
361
386
|
}): Promise<any>;
|
|
387
|
+
/**
|
|
388
|
+
* Get fund transfer limit between portfolios
|
|
389
|
+
*
|
|
390
|
+
* Retrieves the maximum amount that can be transferred between portfolios for a specific asset.
|
|
391
|
+
* This applies to transfers between portfolios of the same beneficial owner.
|
|
392
|
+
*/
|
|
393
|
+
getFundTransferLimit(params: {
|
|
394
|
+
portfolio: string;
|
|
395
|
+
asset: string;
|
|
396
|
+
}): Promise<any>;
|
|
362
397
|
/**
|
|
363
398
|
* Transfer funds between portfolios
|
|
364
399
|
*
|
|
@@ -444,6 +479,16 @@ export declare class CBInternationalClient extends BaseRestClient {
|
|
|
444
479
|
validateCounterpartyId(params: {
|
|
445
480
|
counterparty_id: string;
|
|
446
481
|
}): Promise<any>;
|
|
482
|
+
/**
|
|
483
|
+
* Get counterparty withdrawal limit
|
|
484
|
+
*
|
|
485
|
+
* Retrieves the maximum amount that can be withdrawn to a counterparty within the Coinbase transfer network
|
|
486
|
+
* for a specific portfolio and asset.
|
|
487
|
+
*/
|
|
488
|
+
getCounterpartyWithdrawalLimit(params: {
|
|
489
|
+
portfolio: string;
|
|
490
|
+
asset: string;
|
|
491
|
+
}): Promise<any>;
|
|
447
492
|
/**
|
|
448
493
|
* Withdraw to counterparty Id
|
|
449
494
|
*
|
|
@@ -179,9 +179,7 @@ export class CBInternationalClient extends BaseRestClient {
|
|
|
179
179
|
* Cancels all orders matching the requested criteria.
|
|
180
180
|
*/
|
|
181
181
|
cancelOrders(params) {
|
|
182
|
-
return this.deletePrivate('/api/v1/orders', {
|
|
183
|
-
query: params,
|
|
184
|
-
});
|
|
182
|
+
return this.deletePrivate('/api/v1/orders', { query: params });
|
|
185
183
|
}
|
|
186
184
|
/**
|
|
187
185
|
* Modify open order
|
|
@@ -350,6 +348,31 @@ export class CBInternationalClient extends BaseRestClient {
|
|
|
350
348
|
getPositionForPortfolioInstrument(params) {
|
|
351
349
|
return this.getPrivate(`/api/v1/portfolios/${params.portfolio}/positions/${params.instrument}`);
|
|
352
350
|
}
|
|
351
|
+
/**
|
|
352
|
+
* Get total open position limit
|
|
353
|
+
*
|
|
354
|
+
* Retrieves the total open position limit across instruments for a given portfolio.
|
|
355
|
+
*/
|
|
356
|
+
getTotalOpenPositionLimit(params) {
|
|
357
|
+
return this.getPrivate(`/api/v1/portfolios/${params.portfolio}/position-limits`);
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* List open position limits for all instruments
|
|
361
|
+
*
|
|
362
|
+
* Retrieves position limits for all positions a given portfolio currently has or has opened in the past.
|
|
363
|
+
*/
|
|
364
|
+
getOpenPositionLimitsForAllInstruments(params) {
|
|
365
|
+
return this.getPrivate(`/api/v1/portfolios/${params.portfolio}/position-limits/positions`);
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* Get open position limits for portfolio instrument
|
|
369
|
+
*
|
|
370
|
+
* Retrieves the position limits for a given portfolio and symbol.
|
|
371
|
+
*/
|
|
372
|
+
getOpenPositionLimitsForInstrument(params) {
|
|
373
|
+
const { portfolio, instrument } = params;
|
|
374
|
+
return this.getPrivate(`/api/v1/portfolios/${portfolio}/position-limits/positions/${instrument}`);
|
|
375
|
+
}
|
|
353
376
|
/**
|
|
354
377
|
* List fills by portfolios
|
|
355
378
|
*
|
|
@@ -394,6 +417,16 @@ export class CBInternationalClient extends BaseRestClient {
|
|
|
394
417
|
setPortfolioMarginOverride(params) {
|
|
395
418
|
return this.postPrivate('/api/v1/portfolios/margin', { body: params });
|
|
396
419
|
}
|
|
420
|
+
/**
|
|
421
|
+
* Get fund transfer limit between portfolios
|
|
422
|
+
*
|
|
423
|
+
* Retrieves the maximum amount that can be transferred between portfolios for a specific asset.
|
|
424
|
+
* This applies to transfers between portfolios of the same beneficial owner.
|
|
425
|
+
*/
|
|
426
|
+
getFundTransferLimit(params) {
|
|
427
|
+
const { portfolio, asset } = params;
|
|
428
|
+
return this.getPrivate(`/api/v1/portfolios/transfer/${portfolio}/${asset}/transfer-limit`);
|
|
429
|
+
}
|
|
397
430
|
/**
|
|
398
431
|
* Transfer funds between portfolios
|
|
399
432
|
*
|
|
@@ -491,6 +524,16 @@ export class CBInternationalClient extends BaseRestClient {
|
|
|
491
524
|
body: params,
|
|
492
525
|
});
|
|
493
526
|
}
|
|
527
|
+
/**
|
|
528
|
+
* Get counterparty withdrawal limit
|
|
529
|
+
*
|
|
530
|
+
* Retrieves the maximum amount that can be withdrawn to a counterparty within the Coinbase transfer network
|
|
531
|
+
* for a specific portfolio and asset.
|
|
532
|
+
*/
|
|
533
|
+
getCounterpartyWithdrawalLimit(params) {
|
|
534
|
+
const { portfolio, asset } = params;
|
|
535
|
+
return this.getPrivate(`/api/v1/transfers/withdraw/${portfolio}/${asset}/counterparty-withdrawal-limit`);
|
|
536
|
+
}
|
|
494
537
|
/**
|
|
495
538
|
* Withdraw to counterparty Id
|
|
496
539
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CBInternationalClient.js","sourceRoot":"","sources":["../../src/CBInternationalClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;AAoB/B;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvD,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,OAAO,qBAAqB,CAAC,aAAa,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAAyB;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,MAAyB;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,MAAM,CAAC,KAAK,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,mBAAmB,CAAC,MAAyB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,KAAK,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CACxB,MAAsC;QAEtC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,KAAK,sBAAsB,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAyB;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,MAAkC;QAChD,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,KAAK,UAAU,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,MAA8B;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CAAC,MAA8B;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,MAAM,CAAC,UAAU,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,MAAkC;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CAAC,MAAoC;QAC3D,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,UAAU,UAAU,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACH,yBAAyB,CAAC,MAIzB;QACC,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,UAAU,UAAU,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,WAAW,CAAC,MAA8B;QACxC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,MAAiC;QAC7C,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAA+B;QAC1C,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE
|
|
1
|
+
{"version":3,"file":"CBInternationalClient.js","sourceRoot":"","sources":["../../src/CBInternationalClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;AAoB/B;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvD,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,OAAO,qBAAqB,CAAC,aAAa,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAAyB;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,MAAyB;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,MAAM,CAAC,KAAK,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,mBAAmB,CAAC,MAAyB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,KAAK,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CACxB,MAAsC;QAEtC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,KAAK,sBAAsB,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAyB;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,MAAkC;QAChD,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,KAAK,UAAU,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,MAA8B;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CAAC,MAA8B;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,MAAM,CAAC,UAAU,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,MAAkC;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CAAC,MAAoC;QAC3D,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,UAAU,UAAU,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACH,yBAAyB,CAAC,MAIzB;QACC,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,UAAU,UAAU,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,WAAW,CAAC,MAA8B;QACxC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,MAAiC;QAC7C,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAA+B;QAC1C,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAAkC;QAChD,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAAyC;QACvD,MAAM,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAyC;QACnD,MAAM,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,EAAE,EAAE;YAChD,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAAwB;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,yBAAyB,CACvB,MAA4C;QAE5C,OAAO,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAA6B;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAA2C;QACzD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,MAA6B;QAC/C,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,MAAM,CAAC,SAAS,SAAS,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,MAA6B;QAC/C,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,MAAM,CAAC,SAAS,UAAU,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,MAA6B;QAChD,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,MAAM,CAAC,SAAS,WAAW,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,2BAA2B,CAAC,MAG3B;QACC,OAAO,IAAI,CAAC,UAAU,CACpB,sBAAsB,MAAM,CAAC,SAAS,aAAa,MAAM,CAAC,KAAK,EAAE,CAClE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,0BAA0B,CAAC,MAA6B;QACtD,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,MAAM,CAAC,SAAS,QAAQ,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,MAG5B;QACC,OAAO,IAAI,CAAC,UAAU,CACpB,sBAAsB,MAAM,CAAC,SAAS,UAAU,MAAM,CAAC,KAAK,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAKlB;QACC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,sBAAsB,SAAS,UAAU,KAAK,EAAE,EAAE;YACxE,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,MAKjB;QACC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,WAAW,CACrB,sBAAsB,SAAS,UAAU,KAAK,UAAU,EACxD,EAAE,IAAI,EAAE,CACT,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,MAGtB;QACC,OAAO,IAAI,CAAC,UAAU,CACpB,sBAAsB,MAAM,CAAC,SAAS,UAAU,MAAM,CAAC,KAAK,eAAe,CAC5E,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CAAC,MAA6B;QACjD,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,MAAM,CAAC,SAAS,YAAY,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,iCAAiC,CAAC,MAGjC;QACC,OAAO,IAAI,CAAC,UAAU,CACpB,sBAAsB,MAAM,CAAC,SAAS,cAAc,MAAM,CAAC,UAAU,EAAE,CACxE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,yBAAyB,CAAC,MAA6B;QACrD,OAAO,IAAI,CAAC,UAAU,CACpB,sBAAsB,MAAM,CAAC,SAAS,kBAAkB,CACzD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,sCAAsC,CAAC,MAEtC;QACC,OAAO,IAAI,CAAC,UAAU,CACpB,sBAAsB,MAAM,CAAC,SAAS,4BAA4B,CACnE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,kCAAkC,CAAC,MAGlC;QACC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,UAAU,CACpB,sBAAsB,SAAS,8BAA8B,UAAU,EAAE,CAC1E,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,MAAwC;QAC3D,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,MAAoC;QACpD,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,SAAS,QAAQ,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAGlB;QACC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,WAAW,CACrB,sBAAsB,SAAS,2BAA2B,EAC1D,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,MAA+C;QAC3D,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,WAAW,CACrB,sBAAsB,SAAS,sBAAsB,EACrD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,0BAA0B,CAAC,MAG1B;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,MAGpB;QACC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,UAAU,CACpB,+BAA+B,SAAS,IAAI,KAAK,iBAAiB,CACnE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,8BAA8B,CAC5B,MAAiD;QAEjD,OAAO,IAAI,CAAC,WAAW,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACH,kCAAkC,CAChC,MAAqD;QAErD,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE;YAC9D,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,oBAAoB;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;IACzD,CAAC;IACD;;;;OAIG;IAEH;;;;OAIG;IACH,WAAW,CAAC,MAIX;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,oBAAoB,CAAC,MAAwC;QAC3D,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAiC;QAC3C,OAAO,IAAI,CAAC,UAAU,CAAC,qBAAqB,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CACrB,MAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,MAInB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,MAA6B;QAChD,OAAO,IAAI,CAAC,WAAW,CAAC,0CAA0C,EAAE;YAClE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,MAAmC;QACxD,OAAO,IAAI,CAAC,WAAW,CAAC,4CAA4C,EAAE;YACpE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,8BAA8B,CAAC,MAG9B;QACC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,UAAU,CACpB,8BAA8B,SAAS,IAAI,KAAK,gCAAgC,CACjF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CACtB,MAA2C;QAE3C,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE;YACjE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IACD;;;;OAIG;IAEH;;;;OAIG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;CACF"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AxiosRequestConfig } from 'axios';
|
|
2
2
|
import { BaseRestClient } from './lib/BaseRestClient.js';
|
|
3
3
|
import { RestClientOptions, RestClientType } from './lib/requestUtils.js';
|
|
4
|
-
import { CreatePrimeAddressBookEntryRequest, CreatePrimeConversionRequest, CreatePrimePortfolioAllocationsRequest, CreatePrimePortfolioNetAllocationsRequest, CreatePrimeTransferRequest, CreatePrimeWalletRequest, CreatePrimeWithdrawalRequest, GetPrimeActivitiesRequest, GetPrimeAddressBookRequest, GetPrimeInvoicesRequest, GetPrimeOpenOrdersRequest, GetPrimeOrderFillsRequest, GetPrimeOrderPreviewRequest, GetPrimePortfolioAllocationsRequest, GetPrimePortfolioFillsRequest, GetPrimePortfolioOrdersRequest, GetPrimePortfolioProductsRequest, GetPrimePortfolioTransactionsRequest, GetPrimePortfolioUsersRequest, GetPrimePortfolioWalletsRequest, GetPrimeUsersRequest, GetPrimeWalletDepositInstructionsRequest, GetPrimeWalletTransactionsRequest, GetPrimeWeb3WalletBalancesRequest, SubmitPrimeOrderRequest } from './types/request/coinbase-prime.js';
|
|
4
|
+
import { CreatePrimeAddressBookEntryRequest, CreatePrimeConversionRequest, CreatePrimePortfolioAllocationsRequest, CreatePrimePortfolioNetAllocationsRequest, CreatePrimeTransferRequest, CreatePrimeWalletRequest, CreatePrimeWithdrawalRequest, GetPrimeActivitiesRequest, GetPrimeAddressBookRequest, GetPrimeEntityAccrualsRequest, GetPrimeEntityActivitiesRequest, GetPrimeEntityLocateAvailabilitiesRequest, GetPrimeEntityMarginSummariesRequest, GetPrimeEntityTFTieredFeesRequest, GetPrimeInvoicesRequest, GetPrimeOpenOrdersRequest, GetPrimeOrderFillsRequest, GetPrimeOrderPreviewRequest, GetPrimePortfolioAccrualsRequest, GetPrimePortfolioAllocationsRequest, GetPrimePortfolioBuyingPowerRequest, GetPrimePortfolioFillsRequest, GetPrimePortfolioLocatesRequest, GetPrimePortfolioMarginConversionsRequest, GetPrimePortfolioOrdersRequest, GetPrimePortfolioProductsRequest, GetPrimePortfolioTransactionsRequest, GetPrimePortfolioUsersRequest, GetPrimePortfolioWalletsRequest, GetPrimePortfolioWithdrawalPowerRequest, GetPrimeUsersRequest, GetPrimeWalletDepositInstructionsRequest, GetPrimeWalletTransactionsRequest, GetPrimeWeb3WalletBalancesRequest, SubmitPrimeOrderRequest } from './types/request/coinbase-prime.js';
|
|
5
5
|
/**
|
|
6
6
|
* REST client for Coinbase Prime API:
|
|
7
7
|
* https://docs.cdp.coinbase.com/prime/docs/welcome
|
|
@@ -9,6 +9,40 @@ import { CreatePrimeAddressBookEntryRequest, CreatePrimeConversionRequest, Creat
|
|
|
9
9
|
export declare class CBPrimeClient extends BaseRestClient {
|
|
10
10
|
constructor(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
|
|
11
11
|
getClientType(): RestClientType;
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* Activities Endpoints
|
|
15
|
+
*
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* List Activities
|
|
19
|
+
*
|
|
20
|
+
* List all activities associated with a given entity.
|
|
21
|
+
*/
|
|
22
|
+
getActivities(params: GetPrimeActivitiesRequest): Promise<any>;
|
|
23
|
+
/**
|
|
24
|
+
* Get Activity by Activity ID
|
|
25
|
+
*
|
|
26
|
+
* Retrieve an activity by its activity ID - this endpoint can retrieve both portfolio and entity activities when passed the appropriate API key.
|
|
27
|
+
*/
|
|
28
|
+
getActivityById(params: {
|
|
29
|
+
activity_id: string;
|
|
30
|
+
}): Promise<any>;
|
|
31
|
+
/**
|
|
32
|
+
* List Entity Activities
|
|
33
|
+
*
|
|
34
|
+
* List all activities associated with a given entity.
|
|
35
|
+
*/
|
|
36
|
+
getEntityActivities(params: GetPrimeEntityActivitiesRequest): Promise<any>;
|
|
37
|
+
/**
|
|
38
|
+
* Get Portfolio Activity by Activity ID
|
|
39
|
+
*
|
|
40
|
+
* Retrieve an activity by its activity ID for a specific portfolio.
|
|
41
|
+
*/
|
|
42
|
+
getPortfolioActivityById(params: {
|
|
43
|
+
portfolio_id: string;
|
|
44
|
+
activity_id: string;
|
|
45
|
+
}): Promise<any>;
|
|
12
46
|
/**
|
|
13
47
|
*
|
|
14
48
|
* Allocation Endpoints
|
|
@@ -50,6 +84,74 @@ export declare class CBPrimeClient extends BaseRestClient {
|
|
|
50
84
|
portfolio_id: string;
|
|
51
85
|
netting_id: string;
|
|
52
86
|
}): Promise<any>;
|
|
87
|
+
/**
|
|
88
|
+
*
|
|
89
|
+
* Financing Endpoints
|
|
90
|
+
*
|
|
91
|
+
*/
|
|
92
|
+
/**
|
|
93
|
+
* List Interest Accruals
|
|
94
|
+
*
|
|
95
|
+
* Lists interest accruals for an entity between the specified date range given.
|
|
96
|
+
*/
|
|
97
|
+
getEntityAccruals(params: GetPrimeEntityAccrualsRequest): Promise<any>;
|
|
98
|
+
/**
|
|
99
|
+
* Get Entity Locate Availabilities
|
|
100
|
+
*
|
|
101
|
+
* Get currencies available to be located with their corresponding amount and rate.
|
|
102
|
+
*/
|
|
103
|
+
getEntityLocateAvailabilities(params: GetPrimeEntityLocateAvailabilitiesRequest): Promise<any>;
|
|
104
|
+
/**
|
|
105
|
+
* Get Margin Information
|
|
106
|
+
*
|
|
107
|
+
* Gets real-time evaluation of the margin model based on current positions and spot rates.
|
|
108
|
+
*/
|
|
109
|
+
getEntityMargin(params: {
|
|
110
|
+
entity_id: string;
|
|
111
|
+
}): Promise<any>;
|
|
112
|
+
/**
|
|
113
|
+
* List Margin Call Summaries
|
|
114
|
+
*
|
|
115
|
+
* Lists the margin call history for a given entity ID.
|
|
116
|
+
*/
|
|
117
|
+
getEntityMarginSummaries(params: GetPrimeEntityMarginSummariesRequest): Promise<any>;
|
|
118
|
+
/**
|
|
119
|
+
* Get Trade Finance Tiered Pricing Fees
|
|
120
|
+
*
|
|
121
|
+
* Get trade finance tiered pricing fees for a given entity at a specific time, default to current time.
|
|
122
|
+
*/
|
|
123
|
+
getEntityTFTieredFees(params: GetPrimeEntityTFTieredFeesRequest): Promise<any>;
|
|
124
|
+
/**
|
|
125
|
+
* List Interest Accruals For Portfolio
|
|
126
|
+
*
|
|
127
|
+
* Lists interest accruals between the specified date range for a specific portfolio ID.
|
|
128
|
+
*/
|
|
129
|
+
getPortfolioAccruals(params: GetPrimePortfolioAccrualsRequest): Promise<any>;
|
|
130
|
+
/**
|
|
131
|
+
* Get Portfolio Buying Power
|
|
132
|
+
*
|
|
133
|
+
* Returns the size of a buy trade that can be performed based on existing holdings and available credit.
|
|
134
|
+
*/
|
|
135
|
+
getPortfolioBuyingPower(params: GetPrimePortfolioBuyingPowerRequest): Promise<any>;
|
|
136
|
+
/**
|
|
137
|
+
* List Existing Locates
|
|
138
|
+
*
|
|
139
|
+
* List locates for the portfolio.
|
|
140
|
+
*/
|
|
141
|
+
getPortfolioLocates(params: GetPrimePortfolioLocatesRequest): Promise<any>;
|
|
142
|
+
/**
|
|
143
|
+
* List Margin Conversions
|
|
144
|
+
*
|
|
145
|
+
* Lists conversions and short collateral requirement between specified date range.
|
|
146
|
+
* This endpoint is deprecated and will be removed in the future. Use /v1/entities/{entity_id}/margin_summaries instead.
|
|
147
|
+
*/
|
|
148
|
+
getPortfolioMarginConversions(params: GetPrimePortfolioMarginConversionsRequest): Promise<any>;
|
|
149
|
+
/**
|
|
150
|
+
* Get Portfolio Withdrawal Power
|
|
151
|
+
*
|
|
152
|
+
* Returns the nominal quantity of a given asset that can be withdrawn based on holdings and current portfolio equity.
|
|
153
|
+
*/
|
|
154
|
+
getPortfolioWithdrawalPower(params: GetPrimePortfolioWithdrawalPowerRequest): Promise<any>;
|
|
53
155
|
/**
|
|
54
156
|
*
|
|
55
157
|
* Invoice Endpoints
|
|
@@ -61,6 +163,31 @@ export declare class CBPrimeClient extends BaseRestClient {
|
|
|
61
163
|
* Retrieve a list of invoices belonging to an entity.
|
|
62
164
|
*/
|
|
63
165
|
getInvoices(params: GetPrimeInvoicesRequest): Promise<any>;
|
|
166
|
+
/**
|
|
167
|
+
*
|
|
168
|
+
* Position Endpoints
|
|
169
|
+
*
|
|
170
|
+
*/
|
|
171
|
+
/**
|
|
172
|
+
* List Aggregate Entity Positions
|
|
173
|
+
*
|
|
174
|
+
* List paginated aggregate positions for a specific entity.
|
|
175
|
+
*/
|
|
176
|
+
getEntityAggregatePositions(params: {
|
|
177
|
+
entity_id: string;
|
|
178
|
+
cursor?: string;
|
|
179
|
+
limit?: number;
|
|
180
|
+
}): Promise<any>;
|
|
181
|
+
/**
|
|
182
|
+
* List Entity Positions
|
|
183
|
+
*
|
|
184
|
+
* List paginated positions for a specific entity.
|
|
185
|
+
*/
|
|
186
|
+
getEntityPositions(params: {
|
|
187
|
+
entity_id: string;
|
|
188
|
+
cursor?: string;
|
|
189
|
+
limit?: number;
|
|
190
|
+
}): Promise<any>;
|
|
64
191
|
/**
|
|
65
192
|
*
|
|
66
193
|
* Assets Endpoints
|
|
@@ -140,26 +267,6 @@ export declare class CBPrimeClient extends BaseRestClient {
|
|
|
140
267
|
getPortfolioCreditInformation(params: {
|
|
141
268
|
portfolio_id: string;
|
|
142
269
|
}): Promise<any>;
|
|
143
|
-
/**
|
|
144
|
-
*
|
|
145
|
-
* Activities Endpoints
|
|
146
|
-
*
|
|
147
|
-
*/
|
|
148
|
-
/**
|
|
149
|
-
* List Activities
|
|
150
|
-
*
|
|
151
|
-
* List all activities associated with a given entity.
|
|
152
|
-
*/
|
|
153
|
-
getActivities(params: GetPrimeActivitiesRequest): Promise<any>;
|
|
154
|
-
/**
|
|
155
|
-
* Get Activity by Activity ID
|
|
156
|
-
*
|
|
157
|
-
* Retrieve an activity by its activity ID.
|
|
158
|
-
*/
|
|
159
|
-
getActivityById(params: {
|
|
160
|
-
portfolio_id: string;
|
|
161
|
-
activity_id: string;
|
|
162
|
-
}): Promise<any>;
|
|
163
270
|
/**
|
|
164
271
|
*
|
|
165
272
|
* Address Book Endpoints
|