coinbase-api 1.0.4 → 1.0.5
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/dist/cjs/CBInternationalClient.d.ts +36 -1
- package/dist/cjs/CBInternationalClient.js +41 -0
- package/dist/cjs/CBInternationalClient.js.map +1 -1
- package/dist/cjs/types/request/coinbase-international.d.ts +17 -0
- package/dist/cjs/types/request/coinbase-international.js.map +1 -1
- package/dist/mjs/CBInternationalClient.d.ts +36 -1
- package/dist/mjs/CBInternationalClient.js +41 -0
- package/dist/mjs/CBInternationalClient.js.map +1 -1
- package/dist/mjs/types/request/coinbase-international.d.ts +17 -0
- package/dist/mjs/types/request/coinbase-international.js.map +1 -1
- package/package.json +1 -1
|
@@ -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 { CancelINTXOrdersRequest, GetINTXAggregatedCandlesData, GetINTXDailyTradingVolumes, GetINTXFillsByPortfoliosRequest, GetINTXMatchingTransfersRequest, GetINTXOpenOrdersRequest, GetINTXPortfolioFillsRequest, INTXWithdrawToCounterpartyIdRequest, INTXWithdrawToCryptoAddressRequest, SubmitINTXOrderRequest, TransferINTXFundsBetweenPortfoliosRequest, TransferINTXPositionsBetweenPortfoliosRequest, UpdateINTXOpenOrderRequest, UpdateINTXPortfolioParametersRequest } from './types/request/coinbase-international.js';
|
|
4
|
+
import { CancelINTXOrdersRequest, GetINTXAggregatedCandlesData, GetINTXDailyTradingVolumes, GetINTXFillsByPortfoliosRequest, GetINTXIndexCandlesRequest, GetINTXIndexCompositionHistory, GetINTXMatchingTransfersRequest, GetINTXOpenOrdersRequest, GetINTXPortfolioFillsRequest, INTXWithdrawToCounterpartyIdRequest, INTXWithdrawToCryptoAddressRequest, SubmitINTXOrderRequest, TransferINTXFundsBetweenPortfoliosRequest, TransferINTXPositionsBetweenPortfoliosRequest, UpdateINTXOpenOrderRequest, UpdateINTXPortfolioParametersRequest } from './types/request/coinbase-international.js';
|
|
5
5
|
/**
|
|
6
6
|
* REST client for Coinbase's Institutional International Exchange API:
|
|
7
7
|
* https://docs.cdp.coinbase.com/intx/docs/welcome
|
|
@@ -36,6 +36,41 @@ export declare class CBInternationalClient extends BaseRestClient {
|
|
|
36
36
|
getSupportedNetworksPerAsset(params: {
|
|
37
37
|
asset: string;
|
|
38
38
|
}): Promise<any>;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* Index Endpoints
|
|
42
|
+
*
|
|
43
|
+
*/
|
|
44
|
+
/**
|
|
45
|
+
* Get index composition
|
|
46
|
+
*
|
|
47
|
+
* Retrieves the latest index composition (metadata) with an ordered set of constituents.
|
|
48
|
+
*/
|
|
49
|
+
getIndexComposition(params: {
|
|
50
|
+
index: string;
|
|
51
|
+
}): Promise<any>;
|
|
52
|
+
/**
|
|
53
|
+
* Get index composition history
|
|
54
|
+
*
|
|
55
|
+
* Retrieves a history of index composition records in a descending time order.
|
|
56
|
+
* The results are an array of index composition data recorded at different "timestamps".
|
|
57
|
+
*/
|
|
58
|
+
getIndexCompositionHistory(params: GetINTXIndexCompositionHistory): Promise<any>;
|
|
59
|
+
/**
|
|
60
|
+
* Get index price
|
|
61
|
+
*
|
|
62
|
+
* Retrieves the latest index price.
|
|
63
|
+
*/
|
|
64
|
+
getIndexPrice(params: {
|
|
65
|
+
index: string;
|
|
66
|
+
}): Promise<any>;
|
|
67
|
+
/**
|
|
68
|
+
* Get index candles
|
|
69
|
+
*
|
|
70
|
+
* Retrieves the historical daily index prices in time descending order.
|
|
71
|
+
* The daily values are represented as aggregated entries for the day in typical OHLC format.
|
|
72
|
+
*/
|
|
73
|
+
getIndexCandles(params: GetINTXIndexCandlesRequest): Promise<any>;
|
|
39
74
|
/**
|
|
40
75
|
*
|
|
41
76
|
* Instruments Endpoints
|
|
@@ -44,6 +44,47 @@ class CBInternationalClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
44
44
|
getSupportedNetworksPerAsset(params) {
|
|
45
45
|
return this.get(`/api/v1/assets/${params.asset}/networks`);
|
|
46
46
|
}
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* Index Endpoints
|
|
50
|
+
*
|
|
51
|
+
*/
|
|
52
|
+
/**
|
|
53
|
+
* Get index composition
|
|
54
|
+
*
|
|
55
|
+
* Retrieves the latest index composition (metadata) with an ordered set of constituents.
|
|
56
|
+
*/
|
|
57
|
+
getIndexComposition(params) {
|
|
58
|
+
return this.get(`/api/v1/index/${params.index}/composition`);
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Get index composition history
|
|
62
|
+
*
|
|
63
|
+
* Retrieves a history of index composition records in a descending time order.
|
|
64
|
+
* The results are an array of index composition data recorded at different "timestamps".
|
|
65
|
+
*/
|
|
66
|
+
getIndexCompositionHistory(params) {
|
|
67
|
+
const { index, ...query } = params;
|
|
68
|
+
return this.get(`/api/v1/index/${index}/composition-history`, query);
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Get index price
|
|
72
|
+
*
|
|
73
|
+
* Retrieves the latest index price.
|
|
74
|
+
*/
|
|
75
|
+
getIndexPrice(params) {
|
|
76
|
+
return this.get(`/api/v1/index/${params.index}/price`);
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Get index candles
|
|
80
|
+
*
|
|
81
|
+
* Retrieves the historical daily index prices in time descending order.
|
|
82
|
+
* The daily values are represented as aggregated entries for the day in typical OHLC format.
|
|
83
|
+
*/
|
|
84
|
+
getIndexCandles(params) {
|
|
85
|
+
const { index, ...query } = params;
|
|
86
|
+
return this.get(`/api/v1/index/${index}/candles`, query);
|
|
87
|
+
}
|
|
47
88
|
/**
|
|
48
89
|
*
|
|
49
90
|
* Instruments Endpoints
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CBInternationalClient.js","sourceRoot":"","sources":["../../src/CBInternationalClient.ts"],"names":[],"mappings":";;;AAEA,+DAAyD;AACzD,2DAI+B;
|
|
1
|
+
{"version":3,"file":"CBInternationalClient.js","sourceRoot":"","sources":["../../src/CBInternationalClient.ts"],"names":[],"mappings":";;;AAEA,+DAAyD;AACzD,2DAI+B;AAoB/B;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,kCAAc;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,uCAAqB,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;YAC1C,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,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,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,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;;;;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;;;;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;AA3jBD,sDA2jBC"}
|
|
@@ -3,6 +3,23 @@
|
|
|
3
3
|
* Assets Endpoints
|
|
4
4
|
*
|
|
5
5
|
*/
|
|
6
|
+
/**
|
|
7
|
+
*
|
|
8
|
+
* Index Endpoints
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
export interface GetINTXIndexCompositionHistory {
|
|
12
|
+
index: string;
|
|
13
|
+
time_from?: string;
|
|
14
|
+
result_limit?: number;
|
|
15
|
+
result_offset?: number;
|
|
16
|
+
}
|
|
17
|
+
export interface GetINTXIndexCandlesRequest {
|
|
18
|
+
index: string;
|
|
19
|
+
granularity: string;
|
|
20
|
+
start: string;
|
|
21
|
+
end?: string;
|
|
22
|
+
}
|
|
6
23
|
/**
|
|
7
24
|
*
|
|
8
25
|
* Instruments Endpoints
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coinbase-international.js","sourceRoot":"","sources":["../../../../src/types/request/coinbase-international.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;
|
|
1
|
+
{"version":3,"file":"coinbase-international.js","sourceRoot":"","sources":["../../../../src/types/request/coinbase-international.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AA+LH;;;;GAIG"}
|
|
@@ -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 { CancelINTXOrdersRequest, GetINTXAggregatedCandlesData, GetINTXDailyTradingVolumes, GetINTXFillsByPortfoliosRequest, GetINTXMatchingTransfersRequest, GetINTXOpenOrdersRequest, GetINTXPortfolioFillsRequest, INTXWithdrawToCounterpartyIdRequest, INTXWithdrawToCryptoAddressRequest, SubmitINTXOrderRequest, TransferINTXFundsBetweenPortfoliosRequest, TransferINTXPositionsBetweenPortfoliosRequest, UpdateINTXOpenOrderRequest, UpdateINTXPortfolioParametersRequest } from './types/request/coinbase-international.js';
|
|
4
|
+
import { CancelINTXOrdersRequest, GetINTXAggregatedCandlesData, GetINTXDailyTradingVolumes, GetINTXFillsByPortfoliosRequest, GetINTXIndexCandlesRequest, GetINTXIndexCompositionHistory, GetINTXMatchingTransfersRequest, GetINTXOpenOrdersRequest, GetINTXPortfolioFillsRequest, INTXWithdrawToCounterpartyIdRequest, INTXWithdrawToCryptoAddressRequest, SubmitINTXOrderRequest, TransferINTXFundsBetweenPortfoliosRequest, TransferINTXPositionsBetweenPortfoliosRequest, UpdateINTXOpenOrderRequest, UpdateINTXPortfolioParametersRequest } from './types/request/coinbase-international.js';
|
|
5
5
|
/**
|
|
6
6
|
* REST client for Coinbase's Institutional International Exchange API:
|
|
7
7
|
* https://docs.cdp.coinbase.com/intx/docs/welcome
|
|
@@ -36,6 +36,41 @@ export declare class CBInternationalClient extends BaseRestClient {
|
|
|
36
36
|
getSupportedNetworksPerAsset(params: {
|
|
37
37
|
asset: string;
|
|
38
38
|
}): Promise<any>;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* Index Endpoints
|
|
42
|
+
*
|
|
43
|
+
*/
|
|
44
|
+
/**
|
|
45
|
+
* Get index composition
|
|
46
|
+
*
|
|
47
|
+
* Retrieves the latest index composition (metadata) with an ordered set of constituents.
|
|
48
|
+
*/
|
|
49
|
+
getIndexComposition(params: {
|
|
50
|
+
index: string;
|
|
51
|
+
}): Promise<any>;
|
|
52
|
+
/**
|
|
53
|
+
* Get index composition history
|
|
54
|
+
*
|
|
55
|
+
* Retrieves a history of index composition records in a descending time order.
|
|
56
|
+
* The results are an array of index composition data recorded at different "timestamps".
|
|
57
|
+
*/
|
|
58
|
+
getIndexCompositionHistory(params: GetINTXIndexCompositionHistory): Promise<any>;
|
|
59
|
+
/**
|
|
60
|
+
* Get index price
|
|
61
|
+
*
|
|
62
|
+
* Retrieves the latest index price.
|
|
63
|
+
*/
|
|
64
|
+
getIndexPrice(params: {
|
|
65
|
+
index: string;
|
|
66
|
+
}): Promise<any>;
|
|
67
|
+
/**
|
|
68
|
+
* Get index candles
|
|
69
|
+
*
|
|
70
|
+
* Retrieves the historical daily index prices in time descending order.
|
|
71
|
+
* The daily values are represented as aggregated entries for the day in typical OHLC format.
|
|
72
|
+
*/
|
|
73
|
+
getIndexCandles(params: GetINTXIndexCandlesRequest): Promise<any>;
|
|
39
74
|
/**
|
|
40
75
|
*
|
|
41
76
|
* Instruments Endpoints
|
|
@@ -41,6 +41,47 @@ export class CBInternationalClient extends BaseRestClient {
|
|
|
41
41
|
getSupportedNetworksPerAsset(params) {
|
|
42
42
|
return this.get(`/api/v1/assets/${params.asset}/networks`);
|
|
43
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* Index Endpoints
|
|
47
|
+
*
|
|
48
|
+
*/
|
|
49
|
+
/**
|
|
50
|
+
* Get index composition
|
|
51
|
+
*
|
|
52
|
+
* Retrieves the latest index composition (metadata) with an ordered set of constituents.
|
|
53
|
+
*/
|
|
54
|
+
getIndexComposition(params) {
|
|
55
|
+
return this.get(`/api/v1/index/${params.index}/composition`);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Get index composition history
|
|
59
|
+
*
|
|
60
|
+
* Retrieves a history of index composition records in a descending time order.
|
|
61
|
+
* The results are an array of index composition data recorded at different "timestamps".
|
|
62
|
+
*/
|
|
63
|
+
getIndexCompositionHistory(params) {
|
|
64
|
+
const { index, ...query } = params;
|
|
65
|
+
return this.get(`/api/v1/index/${index}/composition-history`, query);
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Get index price
|
|
69
|
+
*
|
|
70
|
+
* Retrieves the latest index price.
|
|
71
|
+
*/
|
|
72
|
+
getIndexPrice(params) {
|
|
73
|
+
return this.get(`/api/v1/index/${params.index}/price`);
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Get index candles
|
|
77
|
+
*
|
|
78
|
+
* Retrieves the historical daily index prices in time descending order.
|
|
79
|
+
* The daily values are represented as aggregated entries for the day in typical OHLC format.
|
|
80
|
+
*/
|
|
81
|
+
getIndexCandles(params) {
|
|
82
|
+
const { index, ...query } = params;
|
|
83
|
+
return this.get(`/api/v1/index/${index}/candles`, query);
|
|
84
|
+
}
|
|
44
85
|
/**
|
|
45
86
|
*
|
|
46
87
|
* Instruments Endpoints
|
|
@@ -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;
|
|
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;YAC1C,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,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,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,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;;;;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;;;;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"}
|
|
@@ -3,6 +3,23 @@
|
|
|
3
3
|
* Assets Endpoints
|
|
4
4
|
*
|
|
5
5
|
*/
|
|
6
|
+
/**
|
|
7
|
+
*
|
|
8
|
+
* Index Endpoints
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
export interface GetINTXIndexCompositionHistory {
|
|
12
|
+
index: string;
|
|
13
|
+
time_from?: string;
|
|
14
|
+
result_limit?: number;
|
|
15
|
+
result_offset?: number;
|
|
16
|
+
}
|
|
17
|
+
export interface GetINTXIndexCandlesRequest {
|
|
18
|
+
index: string;
|
|
19
|
+
granularity: string;
|
|
20
|
+
start: string;
|
|
21
|
+
end?: string;
|
|
22
|
+
}
|
|
6
23
|
/**
|
|
7
24
|
*
|
|
8
25
|
* Instruments Endpoints
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coinbase-international.js","sourceRoot":"","sources":["../../../../src/types/request/coinbase-international.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;
|
|
1
|
+
{"version":3,"file":"coinbase-international.js","sourceRoot":"","sources":["../../../../src/types/request/coinbase-international.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;AA+LH;;;;GAIG"}
|