@siebly/kraken-api 0.0.9

package/dist/mjs/DerivativesClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DerivativesClient.js","sourceRoot":"","sources":["../../src/DerivativesClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAkB,MAAM,uBAAuB,CAAC;AAsE9E;;;;;;;GAOG;AACH,MAAM,OAAO,iBAAkB,SAAQ,cAAc;IACnD,aAAa;QACX,OAAO,qBAAqB,CAAC,WAAW,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IAEH,kBAAkB;QAChB,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,eAAe,CAAC,MAGf;QAGC,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAEZ;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,UAAU;QAGR,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAET;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,cAAc;QAGZ,OAAO,IAAI,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,uBAAuB;QAKrB,OAAO,IAAI,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,MAEnB;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,kCAAkC,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,oBAAoB,CAClB,MAA+B;QAI/B,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE;YACvD,IAAI,EAAE;gBACJ,aAAa,EAAE,aAAa;gBAC5B,IAAI;aACL;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAA4B;QAK1C,OAAO,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE;YAC5D,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,MAEpB;QAGC,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE;YACjE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,MAAgC;QAIhC,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE;YACxD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,SAAS,CACP,MAA8B;QAI9B,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE;YACtD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa;QAGX,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,MAA8B;QAI9B,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE;YACtD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAGd;QAGC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE;YAC1D,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,iBAAiB;QAGf,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,MAGhB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE;YAC1D,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,mBAAmB;QAKjB,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,MAGnB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,EAAE;YAC/D,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;;;OAMG;IACH,WAAW;QAGT,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,gBAAgB;QAGd,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QAGnB,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,4BAA4B;QAG1B,OAAO,IAAI,CAAC,UAAU,CAAC,mDAAmD,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CAAC,MAE1B;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,iDAAiD,EAAE;YACzE,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,qBAAqB;QAGnB,OAAO,IAAI,CAAC,UAAU,CAAC,8CAA8C,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CACrB,MAA4C;QAE5C,OAAO,IAAI,CAAC,WAAW,CAAC,0CAA0C,EAAE;YAClE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,0BAA0B,CAAC,MAE1B;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,6CAA6C,EAAE;YACrE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,+BAA+B;QAK7B,OAAO,IAAI,CAAC,UAAU,CAAC,8CAA8C,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,eAAe;QAGb,OAAO,IAAI,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QAKnB,OAAO,IAAI,CAAC,UAAU,CAAC,yCAAyC,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,gBAAgB;QAGd,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,QAAQ,CAAC,MAER;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,yBAAyB,CAAC,MAEzB;QAGC,OAAO,IAAI,CAAC,GAAG,CAAC,6CAA6C,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,oBAAoB;QAKlB,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CACrB,MAA4C;QAM5C,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,EAAE;YAC/D,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,0BAA0B,CAAC,MAE1B;QACC,OAAO,IAAI,CAAC,UAAU,CACpB,iCAAiC,MAAM,CAAC,aAAa,kBAAkB,CACxE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,6BAA6B,CAAC,MAG7B;QACC,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACjD,OAAO,IAAI,CAAC,UAAU,CACpB,iCAAiC,aAAa,kBAAkB,EAChE,EAAE,KAAK,EAAE,WAAW,EAAE,CACvB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,cAAc;QAGZ,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,oBAAoB,CAClB,MAA2C;QAE3C,OAAO,IAAI,CAAC,WAAW,CAAC,6BAA6B,EAAE;YACrD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CACtB,MAA+C;QAE/C,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE;YAChE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAClB,MAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE;YACvD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,WAAW;QAGT,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,MAEV;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,gBAAgB;QAGd,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,MAIjB;QACC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,MAAM,cAAc,EAAE;YACvE,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,MAIlB;QACC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,MAAM,gBAAgB,EAAE;YACxE,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,MAEd;QACC,OAAO,IAAI,CAAC,aAAa,CACvB,2BAA2B,MAAM,CAAC,MAAM,eAAe,CACxD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,kBAAkB,CAChB,MAAiC;QAMjC,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,MAAoC;QAMpC,OAAO,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CACd,MAAsC;QAMtC,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,MAAuC;QAMvC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,aAAa,CACX,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAyC;QACxD,OAAO,IAAI,CAAC,UAAU,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,wBAAwB,CACtB,MAAsC;QAEtC,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,SAAS,aAAa,EAAE;YAC/D,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAClB,MAAsC;QAEtC,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,SAAS,SAAS,EAAE;YAC3D,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CACtB,MAAsC;QAEtC,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,SAAS,QAAQ,EAAE;YAC1D,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,MAErB;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,MAGd;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAA+B;QACxC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QAChE,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,QAAQ,IAAI,MAAM,IAAI,UAAU,EAAE,EAAE;YACnE,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,yBAAyB,CACvB,MAAiC;QAEjC,OAAO,IAAI,CAAC,GAAG,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAChB,MAAiC;QAEjC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;QACzD,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,MAAM,IAAI,aAAa,EAAE,EAAE;YACpE,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,qBAAqB;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,CAAC,CAAC;IACnE,CAAC;CACF"}

package/dist/mjs/InstitutionalClient.d.ts

@@ -0,0 +1,183 @@
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import { RestClientType } from './lib/requestUtils.js';
+import { CustodyDepositAddressesParams, CustodyDepositMethodsParams, CustodyGetTransactionParams, CustodyListActivitiesParams, CustodyListTasksParams, CustodyListTransactionsParams, CustodyListVaultsParams, CustodyWithdrawAddressesParams, CustodyWithdrawMethodsParams, OTCCreateQuoteRequestParams, OTCUpdateQuoteParams } from './types/request/institutional.types.js';
+import { CustodyDepositAddressesResponse, CustodyDepositMethodsResponse, CustodyGetActivityResponse, CustodyGetTaskResponse, CustodyGetTransactionResponse, CustodyGetVaultResponse, CustodyListActivitiesResponse, CustodyListTasksResponse, CustodyListTransactionsResponse, CustodyListVaultsResponse, CustodyWithdrawAddressesResponse, CustodyWithdrawMethodsResponse, OTCCheckClientResponse, OTCCreateQuoteResponse, OTCGetActiveQuotesResponse, OTCGetExposuresResponse, OTCGetHistoricalQuotesResponse, OTCGetPairsResponse, OTCUpdateQuoteResponse } from './types/response/institutional.types.js';
+/**
+ * The InstitutionalClient provides integration to the Kraken Institutional API.
+ *
+ * Docs:
+ * - https://docs.kraken.com/api/docs/custody-api
+ * - https://docs.kraken.com/api/docs/otc-api
+ */
+export declare class InstitutionalClient extends BaseRestClient {
+    getClientType(): RestClientType;
+    /**
+     *
+     * Misc Utility Methods
+     *
+     */
+    generateNewOrderID(): string;
+    /**
+     *
+     * Custody REST API - Portfolios
+     *
+     */
+    /**
+     * List vaults
+     *
+     * Retrieve all vaults within the custody domain.
+     */
+    listCustodyVaults(params: CustodyListVaultsParams): Promise<CustodyListVaultsResponse>;
+    /**
+     * Get vault information by id
+     *
+     * Retrieve information and balances for a specific vault.
+     */
+    getCustodyVaultbyId(params: {
+        id: string;
+        nonce?: number;
+    }): Promise<CustodyGetVaultResponse>;
+    /**
+     * Get deposit methods
+     *
+     * Retrieve the available deposit funding methods for depositing a specific asset.
+     * The deposit method is required to retrieve deposit addresses using the Get Deposit Addresses API.
+     */
+    getCustodyDepositMethods(params: CustodyDepositMethodsParams): Promise<CustodyDepositMethodsResponse>;
+    /**
+     * Get deposit addresses
+     *
+     * Retrieve (or generate a new) deposit addresses for a particular asset and funding method.
+     * Use the Get Deposit Methods API to identify the appropriate deposit method.
+     */
+    getCustodyDepositAddresses(params: CustodyDepositAddressesParams): Promise<CustodyDepositAddressesResponse>;
+    /**
+     * List custody transactions
+     *
+     * Retrieve the transaction history for a specified vault.
+     */
+    listCustodyTransactions(params: CustodyListTransactionsParams): Promise<CustodyListTransactionsResponse>;
+    /**
+     * Get transaction by id
+     *
+     * Get transaction by id
+     */
+    getCustodyTransactionbyId(params: CustodyGetTransactionParams): Promise<CustodyGetTransactionResponse>;
+    /**
+     *
+     * Custody REST API - Transfers
+     *
+     */
+    /**
+     * Get withdraw methods
+     *
+     * Retrieve a list of withdrawal methods available for a specified vault.
+     */
+    getCustodyWithdrawMethods(params: CustodyWithdrawMethodsParams): Promise<CustodyWithdrawMethodsResponse>;
+    /**
+     * Get withdraw addresses
+     *
+     * Retrieve a list of withdrawal addresses for a specified vault.
+     */
+    getCustodyWithdrawAddresses(params: CustodyWithdrawAddressesParams): Promise<CustodyWithdrawAddressesResponse>;
+    /**
+     *
+     * Custody REST API - Tasks
+     *
+     */
+    /**
+     * List tasks
+     *
+     * Retrieve review tasks that match the specified filter criteria.
+     */
+    listCustodyTasks(params: CustodyListTasksParams): Promise<CustodyListTasksResponse>;
+    /**
+     * Get task by id
+     *
+     * Retrieve details for a specific task.
+     */
+    getCustodyTaskbyId(params: {
+        id: string;
+        nonce?: number;
+    }): Promise<CustodyGetTaskResponse>;
+    /**
+     * List activities
+     *
+     * Retrieve all activities that match the specified filter criteria.
+     */
+    listCustodyActivities(params: CustodyListActivitiesParams): Promise<CustodyListActivitiesResponse>;
+    /**
+     * Get activity by id
+     *
+     * Retrieve details for a specific task activity.
+     */
+    getCustodyActivitybyId(params: {
+        id: string;
+        nonce?: number;
+    }): Promise<CustodyGetActivityResponse>;
+    /**
+     *
+     * OTC REST API - Quotes
+     *
+     */
+    /**
+     * Create OTC Quote
+     *
+     * Creates a new OTC request for quote.
+     * API Key Permissions Required: Orders and trades - Create & modify orders
+     */
+    createOtcQuoteRequest(params: OTCCreateQuoteRequestParams): Promise<OTCCreateQuoteResponse>;
+    /**
+     * Update OTC Quote
+     *
+     * Accepts or rejects an OTC quote.
+     * API Key Permissions Required: Orders and trades - Create & modify orders
+     */
+    updateOtcQuote(params: OTCUpdateQuoteParams): Promise<OTCUpdateQuoteResponse>;
+    /**
+     * Get OTC Pairs
+     *
+     * Retrieves the list of OTC trading pairs.
+     * API Key Permissions Required: Funds permissions - Query and Funds permissions - Deposit
+     */
+    getOtcPairs(params?: {
+        nonce?: number;
+    }): Promise<OTCGetPairsResponse>;
+    /**
+     * Get OTC Active Quotes
+     *
+     * Retrieves a list of active OTC quotes.
+     * API Key Permissions Required: Orders and trades - Query open orders & trades
+     */
+    getOtcActiveQuotes(params?: {
+        nonce?: number;
+        vault_id?: string;
+    }): Promise<OTCGetActiveQuotesResponse>;
+    /**
+     * Get OTC Historical Quotes
+     *
+     * Retrieves OTC quotes history.
+     * API Key Permissions Required: Orders and trades - Query open orders & trades
+     */
+    getOtcHistoricalQuotes(params?: {
+        nonce?: number;
+    }): Promise<OTCGetHistoricalQuotesResponse>;
+    /**
+     * Get OTC Exposures
+     *
+     * Retrieves the max and used OTC exposures.
+     * API Key Permissions Required: Orders and trades - Query open orders & trades
+     */
+    getOtcExposures(params?: {
+        nonce?: number;
+    }): Promise<OTCGetExposuresResponse>;
+    /**
+     * Check OTC Eligibility
+     *
+     * Retrieves the client permissions for the OTC Portal.
+     * API Key Permissions Required: Funds permissions - Query and Funds permissions - Deposit
+     */
+    checkOtcClient(params?: {
+        nonce?: number;
+    }): Promise<OTCCheckClientResponse>;
+}

package/dist/mjs/InstitutionalClient.js

@@ -0,0 +1,262 @@
+import { nanoid } from 'nanoid';
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import { REST_CLIENT_TYPE_ENUM } from './lib/requestUtils.js';
+/**
+ * The InstitutionalClient provides integration to the Kraken Institutional API.
+ *
+ * Docs:
+ * - https://docs.kraken.com/api/docs/custody-api
+ * - https://docs.kraken.com/api/docs/otc-api
+ */
+export class InstitutionalClient extends BaseRestClient {
+    getClientType() {
+        return REST_CLIENT_TYPE_ENUM.institutional;
+    }
+    /**
+     *
+     * Misc Utility Methods
+     *
+     */
+    generateNewOrderID() {
+        return nanoid(32);
+    }
+    /**
+     *
+     * Custody REST API - Portfolios
+     *
+     */
+    /**
+     * List vaults
+     *
+     * Retrieve all vaults within the custody domain.
+     */
+    listCustodyVaults(params) {
+        return this.postPrivate('0/private/ListCustodyVaults', {
+            body: params,
+        });
+    }
+    /**
+     * Get vault information by id
+     *
+     * Retrieve information and balances for a specific vault.
+     */
+    getCustodyVaultbyId(params) {
+        const { id, ...bodyParams } = params;
+        return this.postPrivate('0/private/GetCustodyVault', {
+            query: { id: id },
+            body: bodyParams,
+        });
+    }
+    /**
+     * Get deposit methods
+     *
+     * Retrieve the available deposit funding methods for depositing a specific asset.
+     * The deposit method is required to retrieve deposit addresses using the Get Deposit Addresses API.
+     */
+    getCustodyDepositMethods(params) {
+        const { 'x-vault-id': vaultId, ...bodyParams } = params;
+        return this.postPrivate('0/private/DepositMethods', {
+            headers: { 'x-vault-id': vaultId },
+            body: bodyParams,
+        });
+    }
+    /**
+     * Get deposit addresses
+     *
+     * Retrieve (or generate a new) deposit addresses for a particular asset and funding method.
+     * Use the Get Deposit Methods API to identify the appropriate deposit method.
+     */
+    getCustodyDepositAddresses(params) {
+        const { 'x-vault-id': vaultId, ...bodyParams } = params;
+        return this.postPrivate('0/private/DepositAddresses', {
+            headers: { 'x-vault-id': vaultId },
+            body: bodyParams,
+        });
+    }
+    /**
+     * List custody transactions
+     *
+     * Retrieve the transaction history for a specified vault.
+     */
+    listCustodyTransactions(params) {
+        const { id, ...bodyParams } = params;
+        return this.postPrivate('0/private/ListCustodyTransactions', {
+            query: { id: id },
+            body: bodyParams,
+        });
+    }
+    /**
+     * Get transaction by id
+     *
+     * Get transaction by id
+     */
+    getCustodyTransactionbyId(params) {
+        const { id, ...bodyParams } = params;
+        return this.postPrivate('0/private/GetCustodyTransaction', {
+            query: { id: id },
+            body: bodyParams,
+        });
+    }
+    /**
+     *
+     * Custody REST API - Transfers
+     *
+     */
+    /**
+     * Get withdraw methods
+     *
+     * Retrieve a list of withdrawal methods available for a specified vault.
+     */
+    getCustodyWithdrawMethods(params) {
+        const { 'x-vault-id': vaultId, ...bodyParams } = params;
+        return this.postPrivate('0/private/WithdrawMethods', {
+            headers: { 'x-vault-id': vaultId },
+            body: bodyParams,
+        });
+    }
+    /**
+     * Get withdraw addresses
+     *
+     * Retrieve a list of withdrawal addresses for a specified vault.
+     */
+    getCustodyWithdrawAddresses(params) {
+        const { 'x-vault-id': vaultId, preferred_asset_name, ...bodyParams } = params;
+        return this.postPrivate('0/private/WithdrawAddresses', {
+            query: preferred_asset_name ? { preferred_asset_name } : undefined,
+            headers: { 'x-vault-id': vaultId },
+            body: bodyParams,
+        });
+    }
+    /**
+     *
+     * Custody REST API - Tasks
+     *
+     */
+    /**
+     * List tasks
+     *
+     * Retrieve review tasks that match the specified filter criteria.
+     */
+    listCustodyTasks(params) {
+        return this.postPrivate('0/private/ListCustodyTasks', {
+            body: params,
+        });
+    }
+    /**
+     * Get task by id
+     *
+     * Retrieve details for a specific task.
+     */
+    getCustodyTaskbyId(params) {
+        const { id, ...bodyParams } = params;
+        return this.postPrivate('0/private/GetCustodyTask', {
+            query: { id: id },
+            body: bodyParams,
+        });
+    }
+    /**
+     * List activities
+     *
+     * Retrieve all activities that match the specified filter criteria.
+     */
+    listCustodyActivities(params) {
+        return this.postPrivate('0/private/ListCustodyActivities', {
+            body: params,
+        });
+    }
+    /**
+     * Get activity by id
+     *
+     * Retrieve details for a specific task activity.
+     */
+    getCustodyActivitybyId(params) {
+        const { id, ...bodyParams } = params;
+        return this.postPrivate('0/private/GetCustodyActivity', {
+            query: { id: id },
+            body: bodyParams,
+        });
+    }
+    /**
+     *
+     * OTC REST API - Quotes
+     *
+     */
+    /**
+     * Create OTC Quote
+     *
+     * Creates a new OTC request for quote.
+     * API Key Permissions Required: Orders and trades - Create & modify orders
+     */
+    createOtcQuoteRequest(params) {
+        return this.postPrivate('0/private/CreateOtcQuoteRequest', {
+            body: params,
+        });
+    }
+    /**
+     * Update OTC Quote
+     *
+     * Accepts or rejects an OTC quote.
+     * API Key Permissions Required: Orders and trades - Create & modify orders
+     */
+    updateOtcQuote(params) {
+        return this.postPrivate('0/private/UpdateOtcQuote', {
+            body: params,
+        });
+    }
+    /**
+     * Get OTC Pairs
+     *
+     * Retrieves the list of OTC trading pairs.
+     * API Key Permissions Required: Funds permissions - Query and Funds permissions - Deposit
+     */
+    getOtcPairs(params) {
+        return this.postPrivate('0/private/GetOtcPairs', {
+            body: params,
+        });
+    }
+    /**
+     * Get OTC Active Quotes
+     *
+     * Retrieves a list of active OTC quotes.
+     * API Key Permissions Required: Orders and trades - Query open orders & trades
+     */
+    getOtcActiveQuotes(params) {
+        return this.postPrivate('0/private/GetOtcActiveQuotes', {
+            body: params,
+        });
+    }
+    /**
+     * Get OTC Historical Quotes
+     *
+     * Retrieves OTC quotes history.
+     * API Key Permissions Required: Orders and trades - Query open orders & trades
+     */
+    getOtcHistoricalQuotes(params) {
+        return this.postPrivate('0/private/GetOtcHistoricalQuotes', {
+            body: params,
+        });
+    }
+    /**
+     * Get OTC Exposures
+     *
+     * Retrieves the max and used OTC exposures.
+     * API Key Permissions Required: Orders and trades - Query open orders & trades
+     */
+    getOtcExposures(params) {
+        return this.postPrivate('0/private/GetOtcExposures', {
+            body: params,
+        });
+    }
+    /**
+     * Check OTC Eligibility
+     *
+     * Retrieves the client permissions for the OTC Portal.
+     * API Key Permissions Required: Funds permissions - Query and Funds permissions - Deposit
+     */
+    checkOtcClient(params) {
+        return this.postPrivate('0/private/CheckOtcClient', {
+            body: params,
+        });
+    }
+}
+//# sourceMappingURL=InstitutionalClient.js.map

package/dist/mjs/InstitutionalClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstitutionalClient.js","sourceRoot":"","sources":["../../src/InstitutionalClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAkB,MAAM,uBAAuB,CAAC;AAoC9E;;;;;;GAMG;AACH,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrD,aAAa;QACX,OAAO,qBAAqB,CAAC,aAAa,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IAEH,kBAAkB;QAChB,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,iBAAiB,CACf,MAA+B;QAE/B,OAAO,IAAI,CAAC,WAAW,CAAC,6BAA6B,EAAE;YACrD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,MAGnB;QACC,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE;YACnD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;YACjB,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CACtB,MAAmC;QAEnC,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE;YAClD,OAAO,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE;YAClC,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CACxB,MAAqC;QAErC,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE;YACpD,OAAO,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE;YAClC,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CACrB,MAAqC;QAErC,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE;YAC3D,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;YACjB,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,yBAAyB,CACvB,MAAmC;QAEnC,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE;YACzD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;YACjB,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,yBAAyB,CACvB,MAAoC;QAEpC,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE;YACnD,OAAO,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE;YAClC,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,2BAA2B,CACzB,MAAsC;QAEtC,MAAM,EACJ,YAAY,EAAE,OAAO,EACrB,oBAAoB,EACpB,GAAG,UAAU,EACd,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,WAAW,CAAC,6BAA6B,EAAE;YACrD,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,CAAC,CAAC,SAAS;YAClE,OAAO,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE;YAClC,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,gBAAgB,CACd,MAA8B;QAE9B,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE;YACpD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAGlB;QACC,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE;YAClD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;YACjB,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CACnB,MAAmC;QAEnC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE;YACzD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,MAGtB;QACC,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE;YACtD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;YACjB,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,qBAAqB,CACnB,MAAmC;QAEnC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE;YACzD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,cAAc,CACZ,MAA4B;QAE5B,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE;YAClD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,MAA2B;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE;YAC/C,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,MAGlB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE;YACtD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE;YAC1D,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE;YACnD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,MAA2B;QACxC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE;YAClD,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;CACF"}