@siebly/kraken-api 0.0.9

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.
Files changed (204) hide show
  1. package/LICENSE.md +7 -0
  2. package/README.md +624 -0
  3. package/dist/cjs/DerivativesClient.d.ts +657 -0
  4. package/dist/cjs/DerivativesClient.js +726 -0
  5. package/dist/cjs/DerivativesClient.js.map +1 -0
  6. package/dist/cjs/InstitutionalClient.d.ts +183 -0
  7. package/dist/cjs/InstitutionalClient.js +266 -0
  8. package/dist/cjs/InstitutionalClient.js.map +1 -0
  9. package/dist/cjs/PartnerClient.d.ts +257 -0
  10. package/dist/cjs/PartnerClient.js +344 -0
  11. package/dist/cjs/PartnerClient.js.map +1 -0
  12. package/dist/cjs/SpotClient.d.ts +547 -0
  13. package/dist/cjs/SpotClient.js +607 -0
  14. package/dist/cjs/SpotClient.js.map +1 -0
  15. package/dist/cjs/WebsocketAPIClient.d.ts +95 -0
  16. package/dist/cjs/WebsocketAPIClient.js +136 -0
  17. package/dist/cjs/WebsocketAPIClient.js.map +1 -0
  18. package/dist/cjs/WebsocketClient.d.ts +120 -0
  19. package/dist/cjs/WebsocketClient.js +669 -0
  20. package/dist/cjs/WebsocketClient.js.map +1 -0
  21. package/dist/cjs/index.d.ts +24 -0
  22. package/dist/cjs/index.js +41 -0
  23. package/dist/cjs/index.js.map +1 -0
  24. package/dist/cjs/lib/BaseRestClient.d.ts +66 -0
  25. package/dist/cjs/lib/BaseRestClient.js +548 -0
  26. package/dist/cjs/lib/BaseRestClient.js.map +1 -0
  27. package/dist/cjs/lib/BaseWSClient.d.ts +230 -0
  28. package/dist/cjs/lib/BaseWSClient.js +935 -0
  29. package/dist/cjs/lib/BaseWSClient.js.map +1 -0
  30. package/dist/cjs/lib/misc-util.d.ts +1 -0
  31. package/dist/cjs/lib/misc-util.js +7 -0
  32. package/dist/cjs/lib/misc-util.js.map +1 -0
  33. package/dist/cjs/lib/requestUtils.d.ts +68 -0
  34. package/dist/cjs/lib/requestUtils.js +82 -0
  35. package/dist/cjs/lib/requestUtils.js.map +1 -0
  36. package/dist/cjs/lib/webCryptoAPI.d.ts +15 -0
  37. package/dist/cjs/lib/webCryptoAPI.js +85 -0
  38. package/dist/cjs/lib/webCryptoAPI.js.map +1 -0
  39. package/dist/cjs/lib/websocket/WsStore.d.ts +75 -0
  40. package/dist/cjs/lib/websocket/WsStore.js +303 -0
  41. package/dist/cjs/lib/websocket/WsStore.js.map +1 -0
  42. package/dist/cjs/lib/websocket/WsStore.types.d.ts +51 -0
  43. package/dist/cjs/lib/websocket/WsStore.types.js +14 -0
  44. package/dist/cjs/lib/websocket/WsStore.types.js.map +1 -0
  45. package/dist/cjs/lib/websocket/logger.d.ts +7 -0
  46. package/dist/cjs/lib/websocket/logger.js +16 -0
  47. package/dist/cjs/lib/websocket/logger.js.map +1 -0
  48. package/dist/cjs/lib/websocket/rest-client-cache.d.ts +22 -0
  49. package/dist/cjs/lib/websocket/rest-client-cache.js +66 -0
  50. package/dist/cjs/lib/websocket/rest-client-cache.js.map +1 -0
  51. package/dist/cjs/lib/websocket/websocket-util.d.ts +76 -0
  52. package/dist/cjs/lib/websocket/websocket-util.js +59 -0
  53. package/dist/cjs/lib/websocket/websocket-util.js.map +1 -0
  54. package/dist/cjs/package.json +3 -0
  55. package/dist/cjs/types/request/derivatives.types.d.ts +186 -0
  56. package/dist/cjs/types/request/derivatives.types.js +6 -0
  57. package/dist/cjs/types/request/derivatives.types.js.map +1 -0
  58. package/dist/cjs/types/request/institutional.types.d.ts +313 -0
  59. package/dist/cjs/types/request/institutional.types.js +4 -0
  60. package/dist/cjs/types/request/institutional.types.js.map +1 -0
  61. package/dist/cjs/types/request/partner.types.d.ts +291 -0
  62. package/dist/cjs/types/request/partner.types.js +4 -0
  63. package/dist/cjs/types/request/partner.types.js.map +1 -0
  64. package/dist/cjs/types/request/spot.types.d.ts +324 -0
  65. package/dist/cjs/types/request/spot.types.js +6 -0
  66. package/dist/cjs/types/request/spot.types.js.map +1 -0
  67. package/dist/cjs/types/request/wsapi.types.d.ts +90 -0
  68. package/dist/cjs/types/request/wsapi.types.js +6 -0
  69. package/dist/cjs/types/request/wsapi.types.js.map +1 -0
  70. package/dist/cjs/types/response/derivatives.types.d.ts +712 -0
  71. package/dist/cjs/types/response/derivatives.types.js +6 -0
  72. package/dist/cjs/types/response/derivatives.types.js.map +1 -0
  73. package/dist/cjs/types/response/institutional.types.d.ts +318 -0
  74. package/dist/cjs/types/response/institutional.types.js +4 -0
  75. package/dist/cjs/types/response/institutional.types.js.map +1 -0
  76. package/dist/cjs/types/response/partner.types.d.ts +332 -0
  77. package/dist/cjs/types/response/partner.types.js +4 -0
  78. package/dist/cjs/types/response/partner.types.js.map +1 -0
  79. package/dist/cjs/types/response/shared.types.d.ts +27 -0
  80. package/dist/cjs/types/response/shared.types.js +3 -0
  81. package/dist/cjs/types/response/shared.types.js.map +1 -0
  82. package/dist/cjs/types/response/spot.types.d.ts +590 -0
  83. package/dist/cjs/types/response/spot.types.js +6 -0
  84. package/dist/cjs/types/response/spot.types.js.map +1 -0
  85. package/dist/cjs/types/response/ws.d.ts +11 -0
  86. package/dist/cjs/types/response/ws.js +3 -0
  87. package/dist/cjs/types/response/ws.js.map +1 -0
  88. package/dist/cjs/types/response/wsapi.types.d.ts +44 -0
  89. package/dist/cjs/types/response/wsapi.types.js +6 -0
  90. package/dist/cjs/types/response/wsapi.types.js.map +1 -0
  91. package/dist/cjs/types/websockets/ws-api.d.ts +71 -0
  92. package/dist/cjs/types/websockets/ws-api.js +18 -0
  93. package/dist/cjs/types/websockets/ws-api.js.map +1 -0
  94. package/dist/cjs/types/websockets/ws-events.d.ts +11 -0
  95. package/dist/cjs/types/websockets/ws-events.js +11 -0
  96. package/dist/cjs/types/websockets/ws-events.js.map +1 -0
  97. package/dist/cjs/types/websockets/ws-general.d.ts +67 -0
  98. package/dist/cjs/types/websockets/ws-general.js +3 -0
  99. package/dist/cjs/types/websockets/ws-general.js.map +1 -0
  100. package/dist/cjs/types/websockets/ws-subscriptions.d.ts +11 -0
  101. package/dist/cjs/types/websockets/ws-subscriptions.js +31 -0
  102. package/dist/cjs/types/websockets/ws-subscriptions.js.map +1 -0
  103. package/dist/mjs/DerivativesClient.d.ts +657 -0
  104. package/dist/mjs/DerivativesClient.js +722 -0
  105. package/dist/mjs/DerivativesClient.js.map +1 -0
  106. package/dist/mjs/InstitutionalClient.d.ts +183 -0
  107. package/dist/mjs/InstitutionalClient.js +262 -0
  108. package/dist/mjs/InstitutionalClient.js.map +1 -0
  109. package/dist/mjs/PartnerClient.d.ts +257 -0
  110. package/dist/mjs/PartnerClient.js +340 -0
  111. package/dist/mjs/PartnerClient.js.map +1 -0
  112. package/dist/mjs/SpotClient.d.ts +547 -0
  113. package/dist/mjs/SpotClient.js +603 -0
  114. package/dist/mjs/SpotClient.js.map +1 -0
  115. package/dist/mjs/WebsocketAPIClient.d.ts +95 -0
  116. package/dist/mjs/WebsocketAPIClient.js +132 -0
  117. package/dist/mjs/WebsocketAPIClient.js.map +1 -0
  118. package/dist/mjs/WebsocketClient.d.ts +120 -0
  119. package/dist/mjs/WebsocketClient.js +665 -0
  120. package/dist/mjs/WebsocketClient.js.map +1 -0
  121. package/dist/mjs/index.d.ts +24 -0
  122. package/dist/mjs/index.js +25 -0
  123. package/dist/mjs/index.js.map +1 -0
  124. package/dist/mjs/lib/BaseRestClient.d.ts +66 -0
  125. package/dist/mjs/lib/BaseRestClient.js +541 -0
  126. package/dist/mjs/lib/BaseRestClient.js.map +1 -0
  127. package/dist/mjs/lib/BaseWSClient.d.ts +230 -0
  128. package/dist/mjs/lib/BaseWSClient.js +928 -0
  129. package/dist/mjs/lib/BaseWSClient.js.map +1 -0
  130. package/dist/mjs/lib/misc-util.d.ts +1 -0
  131. package/dist/mjs/lib/misc-util.js +4 -0
  132. package/dist/mjs/lib/misc-util.js.map +1 -0
  133. package/dist/mjs/lib/requestUtils.d.ts +68 -0
  134. package/dist/mjs/lib/requestUtils.js +76 -0
  135. package/dist/mjs/lib/requestUtils.js.map +1 -0
  136. package/dist/mjs/lib/webCryptoAPI.d.ts +15 -0
  137. package/dist/mjs/lib/webCryptoAPI.js +80 -0
  138. package/dist/mjs/lib/webCryptoAPI.js.map +1 -0
  139. package/dist/mjs/lib/websocket/WsStore.d.ts +75 -0
  140. package/dist/mjs/lib/websocket/WsStore.js +298 -0
  141. package/dist/mjs/lib/websocket/WsStore.js.map +1 -0
  142. package/dist/mjs/lib/websocket/WsStore.types.d.ts +51 -0
  143. package/dist/mjs/lib/websocket/WsStore.types.js +11 -0
  144. package/dist/mjs/lib/websocket/WsStore.types.js.map +1 -0
  145. package/dist/mjs/lib/websocket/logger.d.ts +7 -0
  146. package/dist/mjs/lib/websocket/logger.js +13 -0
  147. package/dist/mjs/lib/websocket/logger.js.map +1 -0
  148. package/dist/mjs/lib/websocket/rest-client-cache.d.ts +22 -0
  149. package/dist/mjs/lib/websocket/rest-client-cache.js +62 -0
  150. package/dist/mjs/lib/websocket/rest-client-cache.js.map +1 -0
  151. package/dist/mjs/lib/websocket/websocket-util.d.ts +76 -0
  152. package/dist/mjs/lib/websocket/websocket-util.js +54 -0
  153. package/dist/mjs/lib/websocket/websocket-util.js.map +1 -0
  154. package/dist/mjs/package.json +3 -0
  155. package/dist/mjs/types/request/derivatives.types.d.ts +186 -0
  156. package/dist/mjs/types/request/derivatives.types.js +5 -0
  157. package/dist/mjs/types/request/derivatives.types.js.map +1 -0
  158. package/dist/mjs/types/request/institutional.types.d.ts +313 -0
  159. package/dist/mjs/types/request/institutional.types.js +3 -0
  160. package/dist/mjs/types/request/institutional.types.js.map +1 -0
  161. package/dist/mjs/types/request/partner.types.d.ts +291 -0
  162. package/dist/mjs/types/request/partner.types.js +3 -0
  163. package/dist/mjs/types/request/partner.types.js.map +1 -0
  164. package/dist/mjs/types/request/spot.types.d.ts +324 -0
  165. package/dist/mjs/types/request/spot.types.js +5 -0
  166. package/dist/mjs/types/request/spot.types.js.map +1 -0
  167. package/dist/mjs/types/request/wsapi.types.d.ts +90 -0
  168. package/dist/mjs/types/request/wsapi.types.js +5 -0
  169. package/dist/mjs/types/request/wsapi.types.js.map +1 -0
  170. package/dist/mjs/types/response/derivatives.types.d.ts +712 -0
  171. package/dist/mjs/types/response/derivatives.types.js +5 -0
  172. package/dist/mjs/types/response/derivatives.types.js.map +1 -0
  173. package/dist/mjs/types/response/institutional.types.d.ts +318 -0
  174. package/dist/mjs/types/response/institutional.types.js +3 -0
  175. package/dist/mjs/types/response/institutional.types.js.map +1 -0
  176. package/dist/mjs/types/response/partner.types.d.ts +332 -0
  177. package/dist/mjs/types/response/partner.types.js +3 -0
  178. package/dist/mjs/types/response/partner.types.js.map +1 -0
  179. package/dist/mjs/types/response/shared.types.d.ts +27 -0
  180. package/dist/mjs/types/response/shared.types.js +2 -0
  181. package/dist/mjs/types/response/shared.types.js.map +1 -0
  182. package/dist/mjs/types/response/spot.types.d.ts +590 -0
  183. package/dist/mjs/types/response/spot.types.js +5 -0
  184. package/dist/mjs/types/response/spot.types.js.map +1 -0
  185. package/dist/mjs/types/response/ws.d.ts +11 -0
  186. package/dist/mjs/types/response/ws.js +2 -0
  187. package/dist/mjs/types/response/ws.js.map +1 -0
  188. package/dist/mjs/types/response/wsapi.types.d.ts +44 -0
  189. package/dist/mjs/types/response/wsapi.types.js +5 -0
  190. package/dist/mjs/types/response/wsapi.types.js.map +1 -0
  191. package/dist/mjs/types/websockets/ws-api.d.ts +71 -0
  192. package/dist/mjs/types/websockets/ws-api.js +15 -0
  193. package/dist/mjs/types/websockets/ws-api.js.map +1 -0
  194. package/dist/mjs/types/websockets/ws-events.d.ts +11 -0
  195. package/dist/mjs/types/websockets/ws-events.js +8 -0
  196. package/dist/mjs/types/websockets/ws-events.js.map +1 -0
  197. package/dist/mjs/types/websockets/ws-general.d.ts +67 -0
  198. package/dist/mjs/types/websockets/ws-general.js +2 -0
  199. package/dist/mjs/types/websockets/ws-general.js.map +1 -0
  200. package/dist/mjs/types/websockets/ws-subscriptions.d.ts +11 -0
  201. package/dist/mjs/types/websockets/ws-subscriptions.js +28 -0
  202. package/dist/mjs/types/websockets/ws-subscriptions.js.map +1 -0
  203. package/llms.txt +10925 -0
  204. package/package.json +89 -0
@@ -0,0 +1,257 @@
1
+ import { BaseRestClient } from './lib/BaseRestClient.js';
2
+ import { RestClientType } from './lib/requestUtils.js';
3
+ import { PartnerCreateUserParams, PartnerExecuteQuoteParams, PartnerGetAssetParams, PartnerGetEarnSummaryParams, PartnerGetPortfolioHistoryParams, PartnerGetPortfolioSummaryParams, PartnerGetQuoteParams, PartnerGetRampCheckoutUrlParams, PartnerGetRampLimitsParams, PartnerGetRampProspectiveQuoteParams, PartnerGetSettlementReportParams, PartnerListAssetRatesParams, PartnerListAssetsParams, PartnerListEarnAssetsParams, PartnerListFundingTransactionsParams, PartnerListPortfolioDetailsParams, PartnerListPortfolioTransactionsParams, PartnerListSettlementReportsParams, PartnerRequestQuoteParams, PartnerSubmitVerificationParams, PartnerToggleAutoEarnParams, PartnerUpdateUserParams, PartnerWithdrawFundsParams } from './types/request/partner.types.js';
4
+ import { PartnerCreateUserResponse, PartnerExecuteQuoteResponse, PartnerGetAssetResponse, PartnerGetEarnSummaryResponse, PartnerGetPortfolioHistoryResponse, PartnerGetPortfolioSummaryResponse, PartnerGetQuoteResponse, PartnerGetRampCheckoutUrlResponse, PartnerGetRampLimitsResponse, PartnerGetRampProspectiveQuoteResponse, PartnerGetSettlementReportResponse, PartnerGetUserResponse, PartnerListAssetRatesResponse, PartnerListAssetsResponse, PartnerListEarnAssetsResponse, PartnerListFundingTransactionsResponse, PartnerListPortfolioDetailsResponse, PartnerListPortfolioTransactionsResponse, PartnerListRampBuyCryptoAssetsResponse, PartnerListRampCountriesResponse, PartnerListRampFiatCurrenciesResponse, PartnerListRampPaymentMethodsResponse, PartnerListSettlementReportsResponse, PartnerRequestQuoteResponse, PartnerSubmitVerificationResponse, PartnerToggleAutoEarnResponse, PartnerUpdateUserResponse, PartnerWithdrawFundsResponse } from './types/response/partner.types.js';
5
+ /**
6
+ * The PartnerClient provides integration to the Kraken Partner API.
7
+ *
8
+ * Docs:
9
+ * - https://docs.kraken.com/api/docs/embed-api
10
+ * - https://docs.kraken.com/api/docs/ramp-api
11
+ */
12
+ export declare class PartnerClient extends BaseRestClient {
13
+ getClientType(): RestClientType;
14
+ /**
15
+ *
16
+ * Partner REST API - Embed API - Users
17
+ *
18
+ */
19
+ /**
20
+ * Create User
21
+ *
22
+ * Create a new user in the Kraken system.
23
+ */
24
+ createEmbedUser(params: PartnerCreateUserParams): Promise<PartnerCreateUserResponse>;
25
+ /**
26
+ * Get User
27
+ *
28
+ * Get a previously created user.
29
+ */
30
+ getEmbedUser(params: {
31
+ user: string;
32
+ }): Promise<PartnerGetUserResponse>;
33
+ /**
34
+ * Update User
35
+ *
36
+ * Update an existing user's profile.
37
+ */
38
+ updateEmbedUser(params: PartnerUpdateUserParams): Promise<PartnerUpdateUserResponse>;
39
+ /**
40
+ *
41
+ * Partner REST API - Embed API - Verifications
42
+ *
43
+ */
44
+ /**
45
+ * Submit Verification
46
+ *
47
+ * Submit a verification for a user with documents and details.
48
+ * A verification is defined as a check that has been performed on a user to verify information provided by the user.
49
+ * Note: This endpoint uses multipart/form-data for file uploads.
50
+ */
51
+ submitEmbedVerification(params: PartnerSubmitVerificationParams): Promise<PartnerSubmitVerificationResponse>;
52
+ /**
53
+ *
54
+ * Partner REST API - Embed API - Assets
55
+ *
56
+ */
57
+ /**
58
+ * List Assets
59
+ *
60
+ * List all assets available on the platform.
61
+ * This endpoint returns a list of all assets available on the platform.
62
+ */
63
+ listEmbedAssets(params?: PartnerListAssetsParams): Promise<PartnerListAssetsResponse>;
64
+ /**
65
+ * Get Asset
66
+ *
67
+ * Get information about a specific asset.
68
+ */
69
+ getEmbedAsset(params: PartnerGetAssetParams): Promise<PartnerGetAssetResponse>;
70
+ /**
71
+ * List Asset Rates
72
+ *
73
+ * Returns historical rates for a given asset.
74
+ * This endpoint returns historical rates for a given asset with timestamp and median price for each period.
75
+ */
76
+ listEmbedAssetRates(params: PartnerListAssetRatesParams): Promise<PartnerListAssetRatesResponse>;
77
+ /**
78
+ *
79
+ * Partner REST API - Embed API - Quotes
80
+ *
81
+ */
82
+ /**
83
+ * Request Quote
84
+ *
85
+ * Request a price quote for an asset, that may be used to execute a trade later on.
86
+ */
87
+ requestEmbedQuote(params: PartnerRequestQuoteParams): Promise<PartnerRequestQuoteResponse>;
88
+ /**
89
+ * Get Quote
90
+ *
91
+ * Gets the status of a quote that was previously requested.
92
+ */
93
+ getEmbedQuote(params: PartnerGetQuoteParams): Promise<PartnerGetQuoteResponse>;
94
+ /**
95
+ * Execute Quote
96
+ *
97
+ * Executes a quote that was previously requested.
98
+ */
99
+ executeEmbedQuote(params: PartnerExecuteQuoteParams): Promise<PartnerExecuteQuoteResponse>;
100
+ /**
101
+ *
102
+ * Partner REST API - Embed API - Portfolios
103
+ *
104
+ */
105
+ /**
106
+ * Get Portfolio Summary
107
+ *
108
+ * Get the portfolio summary for a user.
109
+ */
110
+ getEmbedPortfolioSummary(params: PartnerGetPortfolioSummaryParams): Promise<PartnerGetPortfolioSummaryResponse>;
111
+ /**
112
+ * Get Portfolio History
113
+ *
114
+ * Gets a portfolio's historical balances and valuations over time.
115
+ * Note: Balance for the last day shows up at UTC + 5h due to processing times.
116
+ */
117
+ getEmbedPortfolioHistory(params: PartnerGetPortfolioHistoryParams): Promise<PartnerGetPortfolioHistoryResponse>;
118
+ /**
119
+ * List Portfolio Details
120
+ *
121
+ * Lists owned assets in a user's portfolio.
122
+ */
123
+ listEmbedPortfolioDetails(params: PartnerListPortfolioDetailsParams): Promise<PartnerListPortfolioDetailsResponse>;
124
+ /**
125
+ * List Portfolio Transactions
126
+ *
127
+ * Lists the user's trades and transactions.
128
+ */
129
+ listEmbedPortfolioTransactions(params: PartnerListPortfolioTransactionsParams): Promise<PartnerListPortfolioTransactionsResponse>;
130
+ /**
131
+ *
132
+ * Partner REST API - Embed API - Earn
133
+ *
134
+ */
135
+ /**
136
+ * Get Earn Summary
137
+ *
138
+ * Get Earn summary of a user.
139
+ * Response holds total amounts (all-time). For per-asset granularity, use listEarnAssets().
140
+ */
141
+ getEmbedEarnSummary(params: PartnerGetEarnSummaryParams): Promise<PartnerGetEarnSummaryResponse>;
142
+ /**
143
+ * List Earn Assets
144
+ *
145
+ * List Earn Assets.
146
+ * The user can optionally be passed in the request, which shows active asset allocations of the user in the response.
147
+ */
148
+ listEmbedEarnAssets(params?: PartnerListEarnAssetsParams): Promise<PartnerListEarnAssetsResponse>;
149
+ /**
150
+ * Toggle Auto-Earn
151
+ *
152
+ * Toggle Auto-Earn of a user.
153
+ * Toggling Auto-Earn is an async operation. The response is empty on success.
154
+ * To fetch the user's current Auto-Earn status, use getEarnSummary().
155
+ */
156
+ toggleEmbedAutoEarn(params: PartnerToggleAutoEarnParams): Promise<PartnerToggleAutoEarnResponse>;
157
+ /**
158
+ *
159
+ * Partner REST API - Embed API - Transfers
160
+ *
161
+ */
162
+ /**
163
+ * Withdraw Funds
164
+ *
165
+ * Withdraw funds.
166
+ * Note: Currently, this is a master-only operation. No User parameter exists.
167
+ */
168
+ withdrawEmbedFunds(params: PartnerWithdrawFundsParams): Promise<PartnerWithdrawFundsResponse>;
169
+ /**
170
+ * List Funding Transactions
171
+ *
172
+ * List Funding transactions.
173
+ * Funding transactions can be of type withdrawal or deposit.
174
+ * Note: Currently, this is a master-only operation. No User parameter exists.
175
+ */
176
+ listEmbedFundingTransactions(params: PartnerListFundingTransactionsParams): Promise<PartnerListFundingTransactionsResponse>;
177
+ /**
178
+ *
179
+ * Partner REST API - Embed API - Reports
180
+ *
181
+ */
182
+ /**
183
+ * List Settlement Reports
184
+ *
185
+ * Retrieves a paginated list of settlement reports available to the authenticated master user,
186
+ * with optional filters for date range and report type.
187
+ */
188
+ listEmbedSettlementReports(params?: PartnerListSettlementReportsParams): Promise<PartnerListSettlementReportsResponse>;
189
+ /**
190
+ * Get Settlement Report
191
+ *
192
+ * Retrieves a settlement report and provides a secure download URL for the authenticated master user.
193
+ */
194
+ getEmbedSettlementReport(params: PartnerGetSettlementReportParams): Promise<PartnerGetSettlementReportResponse>;
195
+ /**
196
+ *
197
+ * Partner REST API - Ramp API - Supported Options
198
+ *
199
+ */
200
+ /**
201
+ * List Buy Crypto Assets
202
+ *
203
+ * List cryptocurrency assets available for Ramp buy transactions,
204
+ * including the networks, withdrawal methods, and provider-specific identifiers.
205
+ */
206
+ listRampBuyCryptoAssets(): Promise<PartnerListRampBuyCryptoAssetsResponse>;
207
+ /**
208
+ * List Fiat Currencies
209
+ *
210
+ * List fiat currencies supported for funding Ramp transactions.
211
+ */
212
+ listRampFiatCurrencies(): Promise<PartnerListRampFiatCurrenciesResponse>;
213
+ /**
214
+ * List Payment Methods
215
+ *
216
+ * List fiat payment methods supported for Ramp deposits,
217
+ * including optional mapping to provider-specific identifiers.
218
+ */
219
+ listRampPaymentMethods(): Promise<PartnerListRampPaymentMethodsResponse>;
220
+ /**
221
+ * List Countries
222
+ *
223
+ * List countries and regions where Ramp is available.
224
+ * Depending on regulatory rules, availability may be scoped to specific states, provinces, or regions.
225
+ */
226
+ listRampCountries(): Promise<PartnerListRampCountriesResponse>;
227
+ /**
228
+ *
229
+ * Partner REST API - Ramp API - Quotes
230
+ *
231
+ */
232
+ /**
233
+ * Get Limits
234
+ *
235
+ * Retrieve combined min/max limits for a Ramp transaction configuration.
236
+ */
237
+ getRampLimits(params: PartnerGetRampLimitsParams): Promise<PartnerGetRampLimitsResponse>;
238
+ /**
239
+ * Get Prospective Quote
240
+ *
241
+ * Retrieve a prospective quote for a Ramp transaction without reserving liquidity.
242
+ * Use this to preview spend/receive amounts before creating a checkout URL.
243
+ */
244
+ getRampProspectiveQuote(params: PartnerGetRampProspectiveQuoteParams): Promise<PartnerGetRampProspectiveQuoteResponse>;
245
+ /**
246
+ *
247
+ * Partner REST API - Ramp API - Checkout
248
+ *
249
+ */
250
+ /**
251
+ * Get Checkout URL
252
+ *
253
+ * Generate a hosted Ramp checkout URL for the provided transaction configuration.
254
+ * The response echoes the request parameters so the Ramp partner can confirm what was submitted.
255
+ */
256
+ getRampCheckoutUrl(params: PartnerGetRampCheckoutUrlParams): Promise<PartnerGetRampCheckoutUrlResponse>;
257
+ }
@@ -0,0 +1,340 @@
1
+ import { BaseRestClient } from './lib/BaseRestClient.js';
2
+ import { REST_CLIENT_TYPE_ENUM } from './lib/requestUtils.js';
3
+ /**
4
+ * The PartnerClient provides integration to the Kraken Partner API.
5
+ *
6
+ * Docs:
7
+ * - https://docs.kraken.com/api/docs/embed-api
8
+ * - https://docs.kraken.com/api/docs/ramp-api
9
+ */
10
+ export class PartnerClient extends BaseRestClient {
11
+ getClientType() {
12
+ return REST_CLIENT_TYPE_ENUM.partner;
13
+ }
14
+ /**
15
+ *
16
+ * Partner REST API - Embed API - Users
17
+ *
18
+ */
19
+ /**
20
+ * Create User
21
+ *
22
+ * Create a new user in the Kraken system.
23
+ */
24
+ createEmbedUser(params) {
25
+ return this.postPrivate('b2b/users', {
26
+ body: params,
27
+ });
28
+ }
29
+ /**
30
+ * Get User
31
+ *
32
+ * Get a previously created user.
33
+ */
34
+ getEmbedUser(params) {
35
+ return this.getPrivate(`b2b/users/${params.user}`);
36
+ }
37
+ /**
38
+ * Update User
39
+ *
40
+ * Update an existing user's profile.
41
+ */
42
+ updateEmbedUser(params) {
43
+ const { user, ...bodyParams } = params;
44
+ return this.patchPrivate(`b2b/users/${user}`, {
45
+ body: bodyParams,
46
+ });
47
+ }
48
+ /**
49
+ *
50
+ * Partner REST API - Embed API - Verifications
51
+ *
52
+ */
53
+ /**
54
+ * Submit Verification
55
+ *
56
+ * Submit a verification for a user with documents and details.
57
+ * A verification is defined as a check that has been performed on a user to verify information provided by the user.
58
+ * Note: This endpoint uses multipart/form-data for file uploads.
59
+ */
60
+ submitEmbedVerification(params) {
61
+ const { user, ...bodyParams } = params;
62
+ return this.postPrivate(`b2b/verifications/${user}`, {
63
+ body: bodyParams,
64
+ });
65
+ }
66
+ /**
67
+ *
68
+ * Partner REST API - Embed API - Assets
69
+ *
70
+ */
71
+ /**
72
+ * List Assets
73
+ *
74
+ * List all assets available on the platform.
75
+ * This endpoint returns a list of all assets available on the platform.
76
+ */
77
+ listEmbedAssets(params) {
78
+ return this.getPrivate('b2b/assets', params);
79
+ }
80
+ /**
81
+ * Get Asset
82
+ *
83
+ * Get information about a specific asset.
84
+ */
85
+ getEmbedAsset(params) {
86
+ const { asset, ...queryParams } = params;
87
+ return this.getPrivate(`b2b/assets/${asset}`, queryParams);
88
+ }
89
+ /**
90
+ * List Asset Rates
91
+ *
92
+ * Returns historical rates for a given asset.
93
+ * This endpoint returns historical rates for a given asset with timestamp and median price for each period.
94
+ */
95
+ listEmbedAssetRates(params) {
96
+ const { asset, ...queryParams } = params;
97
+ return this.getPrivate(`b2b/assets/${asset}/rates`, queryParams);
98
+ }
99
+ /**
100
+ *
101
+ * Partner REST API - Embed API - Quotes
102
+ *
103
+ */
104
+ /**
105
+ * Request Quote
106
+ *
107
+ * Request a price quote for an asset, that may be used to execute a trade later on.
108
+ */
109
+ requestEmbedQuote(params) {
110
+ const { user, ...bodyParams } = params;
111
+ return this.postPrivate('b2b/quotes', {
112
+ query: { user },
113
+ body: bodyParams,
114
+ });
115
+ }
116
+ /**
117
+ * Get Quote
118
+ *
119
+ * Gets the status of a quote that was previously requested.
120
+ */
121
+ getEmbedQuote(params) {
122
+ const { quote_id, user } = params;
123
+ return this.getPrivate(`b2b/quotes/${quote_id}`, { user });
124
+ }
125
+ /**
126
+ * Execute Quote
127
+ *
128
+ * Executes a quote that was previously requested.
129
+ */
130
+ executeEmbedQuote(params) {
131
+ const { quote_id, ...queryParams } = params;
132
+ return this.putPrivate(`b2b/quotes/${quote_id}`, {
133
+ query: queryParams,
134
+ });
135
+ }
136
+ /**
137
+ *
138
+ * Partner REST API - Embed API - Portfolios
139
+ *
140
+ */
141
+ /**
142
+ * Get Portfolio Summary
143
+ *
144
+ * Get the portfolio summary for a user.
145
+ */
146
+ getEmbedPortfolioSummary(params) {
147
+ const { user, ...queryParams } = params;
148
+ return this.getPrivate(`b2b/portfolio/${user}/summary`, queryParams);
149
+ }
150
+ /**
151
+ * Get Portfolio History
152
+ *
153
+ * Gets a portfolio's historical balances and valuations over time.
154
+ * Note: Balance for the last day shows up at UTC + 5h due to processing times.
155
+ */
156
+ getEmbedPortfolioHistory(params) {
157
+ const { user, ...queryParams } = params;
158
+ return this.getPrivate(`b2b/portfolio/${user}/history`, queryParams);
159
+ }
160
+ /**
161
+ * List Portfolio Details
162
+ *
163
+ * Lists owned assets in a user's portfolio.
164
+ */
165
+ listEmbedPortfolioDetails(params) {
166
+ const { user, ...queryParams } = params;
167
+ return this.getPrivate(`b2b/portfolio/${user}/details`, queryParams);
168
+ }
169
+ /**
170
+ * List Portfolio Transactions
171
+ *
172
+ * Lists the user's trades and transactions.
173
+ */
174
+ listEmbedPortfolioTransactions(params) {
175
+ const { user, ...queryParams } = params;
176
+ return this.getPrivate(`b2b/portfolio/${user}/transactions`, queryParams);
177
+ }
178
+ /**
179
+ *
180
+ * Partner REST API - Embed API - Earn
181
+ *
182
+ */
183
+ /**
184
+ * Get Earn Summary
185
+ *
186
+ * Get Earn summary of a user.
187
+ * Response holds total amounts (all-time). For per-asset granularity, use listEarnAssets().
188
+ */
189
+ getEmbedEarnSummary(params) {
190
+ const { user, ...queryParams } = params;
191
+ return this.getPrivate(`b2b/earn/${user}`, queryParams);
192
+ }
193
+ /**
194
+ * List Earn Assets
195
+ *
196
+ * List Earn Assets.
197
+ * The user can optionally be passed in the request, which shows active asset allocations of the user in the response.
198
+ */
199
+ listEmbedEarnAssets(params) {
200
+ return this.getPrivate('b2b/earn/assets', params);
201
+ }
202
+ /**
203
+ * Toggle Auto-Earn
204
+ *
205
+ * Toggle Auto-Earn of a user.
206
+ * Toggling Auto-Earn is an async operation. The response is empty on success.
207
+ * To fetch the user's current Auto-Earn status, use getEarnSummary().
208
+ */
209
+ toggleEmbedAutoEarn(params) {
210
+ const { user, ...queryParams } = params;
211
+ return this.putPrivate(`b2b/earn/${user}/auto`, {
212
+ query: queryParams,
213
+ });
214
+ }
215
+ /**
216
+ *
217
+ * Partner REST API - Embed API - Transfers
218
+ *
219
+ */
220
+ /**
221
+ * Withdraw Funds
222
+ *
223
+ * Withdraw funds.
224
+ * Note: Currently, this is a master-only operation. No User parameter exists.
225
+ */
226
+ withdrawEmbedFunds(params) {
227
+ return this.postPrivate('b2b/funds/withdrawals', {
228
+ body: params,
229
+ });
230
+ }
231
+ /**
232
+ * List Funding Transactions
233
+ *
234
+ * List Funding transactions.
235
+ * Funding transactions can be of type withdrawal or deposit.
236
+ * Note: Currently, this is a master-only operation. No User parameter exists.
237
+ */
238
+ listEmbedFundingTransactions(params) {
239
+ return this.getPrivate('b2b/funds/transactions', params);
240
+ }
241
+ /**
242
+ *
243
+ * Partner REST API - Embed API - Reports
244
+ *
245
+ */
246
+ /**
247
+ * List Settlement Reports
248
+ *
249
+ * Retrieves a paginated list of settlement reports available to the authenticated master user,
250
+ * with optional filters for date range and report type.
251
+ */
252
+ listEmbedSettlementReports(params) {
253
+ return this.getPrivate('b2b/reports/settlement', params);
254
+ }
255
+ /**
256
+ * Get Settlement Report
257
+ *
258
+ * Retrieves a settlement report and provides a secure download URL for the authenticated master user.
259
+ */
260
+ getEmbedSettlementReport(params) {
261
+ return this.getPrivate(`b2b/reports/settlement/${params.id}`);
262
+ }
263
+ /**
264
+ *
265
+ * Partner REST API - Ramp API - Supported Options
266
+ *
267
+ */
268
+ /**
269
+ * List Buy Crypto Assets
270
+ *
271
+ * List cryptocurrency assets available for Ramp buy transactions,
272
+ * including the networks, withdrawal methods, and provider-specific identifiers.
273
+ */
274
+ listRampBuyCryptoAssets() {
275
+ return this.getPrivate('b2b/ramp/buy/crypto');
276
+ }
277
+ /**
278
+ * List Fiat Currencies
279
+ *
280
+ * List fiat currencies supported for funding Ramp transactions.
281
+ */
282
+ listRampFiatCurrencies() {
283
+ return this.getPrivate('b2b/ramp/fiat-currencies');
284
+ }
285
+ /**
286
+ * List Payment Methods
287
+ *
288
+ * List fiat payment methods supported for Ramp deposits,
289
+ * including optional mapping to provider-specific identifiers.
290
+ */
291
+ listRampPaymentMethods() {
292
+ return this.getPrivate('b2b/ramp/payment-methods');
293
+ }
294
+ /**
295
+ * List Countries
296
+ *
297
+ * List countries and regions where Ramp is available.
298
+ * Depending on regulatory rules, availability may be scoped to specific states, provinces, or regions.
299
+ */
300
+ listRampCountries() {
301
+ return this.getPrivate('b2b/ramp/countries');
302
+ }
303
+ /**
304
+ *
305
+ * Partner REST API - Ramp API - Quotes
306
+ *
307
+ */
308
+ /**
309
+ * Get Limits
310
+ *
311
+ * Retrieve combined min/max limits for a Ramp transaction configuration.
312
+ */
313
+ getRampLimits(params) {
314
+ return this.getPrivate('b2b/ramp/limits', params);
315
+ }
316
+ /**
317
+ * Get Prospective Quote
318
+ *
319
+ * Retrieve a prospective quote for a Ramp transaction without reserving liquidity.
320
+ * Use this to preview spend/receive amounts before creating a checkout URL.
321
+ */
322
+ getRampProspectiveQuote(params) {
323
+ return this.getPrivate('b2b/ramp/quotes/prospective', params);
324
+ }
325
+ /**
326
+ *
327
+ * Partner REST API - Ramp API - Checkout
328
+ *
329
+ */
330
+ /**
331
+ * Get Checkout URL
332
+ *
333
+ * Generate a hosted Ramp checkout URL for the provided transaction configuration.
334
+ * The response echoes the request parameters so the Ramp partner can confirm what was submitted.
335
+ */
336
+ getRampCheckoutUrl(params) {
337
+ return this.getPrivate('b2b/ramp/checkout', params);
338
+ }
339
+ }
340
+ //# sourceMappingURL=PartnerClient.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PartnerClient.js","sourceRoot":"","sources":["../../src/PartnerClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAkB,MAAM,uBAAuB,CAAC;AAyD9E;;;;;;GAMG;AACH,MAAM,OAAO,aAAc,SAAQ,cAAc;IAC/C,aAAa;QACX,OAAO,qBAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,eAAe,CACb,MAA+B;QAE/B,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YACnC,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAAwB;QACnC,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,eAAe,CACb,MAA+B;QAE/B,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,IAAI,EAAE,EAAE;YAC5C,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;;;OAMG;IACH,uBAAuB,CACrB,MAAuC;QAEvC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAqB,IAAI,EAAE,EAAE;YACnD,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,eAAe,CACb,MAAgC;QAEhC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,MAA6B;QAE7B,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CACjB,MAAmC;QAEnC,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,KAAK,QAAQ,EAAE,WAAW,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,iBAAiB,CACf,MAAiC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;YACpC,KAAK,EAAE,EAAE,IAAI,EAAE;YACf,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,MAA6B;QAE7B,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,MAAiC;QAEjC,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,QAAQ,EAAE,EAAE;YAC/C,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,wBAAwB,CACtB,MAAwC;QAExC,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,IAAI,UAAU,EAAE,WAAW,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CACtB,MAAwC;QAExC,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,IAAI,UAAU,EAAE,WAAW,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,yBAAyB,CACvB,MAAyC;QAEzC,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,IAAI,UAAU,EAAE,WAAW,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,8BAA8B,CAC5B,MAA8C;QAE9C,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,IAAI,eAAe,EAAE,WAAW,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,mBAAmB,CACjB,MAAmC;QAEnC,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CACjB,MAAoC;QAEpC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CACjB,MAAmC;QAEnC,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,IAAI,OAAO,EAAE;YAC9C,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,kBAAkB,CAChB,MAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE;YAC/C,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,4BAA4B,CAC1B,MAA4C;QAE5C,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,0BAA0B,CACxB,MAA2C;QAE3C,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CACtB,MAAwC;QAExC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,uBAAuB;QACrB,OAAO,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,aAAa,CACX,MAAkC;QAElC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,uBAAuB,CACrB,MAA4C;QAE5C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,kBAAkB,CAChB,MAAuC;QAEvC,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;CACF"}