Skip to content

Class: InstitutionalClient ​

Client for Kraken Custody and OTC endpoints.

Extends ​

  • BaseRestClient

Constructors ​

Constructor ​

ts
new InstitutionalClient(restClientOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig): InstitutionalClient;

Create an instance of the REST client. Pass API credentials in the object in the first parameter.

Parameters ​

ParameterTypeDescription
restClientOptions?RestClientOptionsoptions to configure REST API connectivity
networkOptions?AxiosRequestConfigHTTP networking options for axios

Returns ​

InstitutionalClient

Inherited from ​

BaseRestClient.constructor

Methods ​

checkOtcClient() ​

ts
checkOtcClient(params?: object): Promise<OTCCheckClientResponse>;

Check OTC Eligibility

Retrieves the client permissions for the OTC Portal. API Key Permissions Required: Funds permissions - Query and Funds permissions - Deposit

Parameters ​

ParameterType
params?{ nonce?: number; }
params.nonce?number

Returns ​

Promise<OTCCheckClientResponse>


createOtcQuoteRequest() ​

ts
createOtcQuoteRequest(params: OTCCreateQuoteRequestParams): Promise<OTCCreateQuoteResponse>;

Create OTC Quote

Creates a new OTC request for quote. API Key Permissions Required: Orders and trades - Create & modify orders

Parameters ​

ParameterType
paramsOTCCreateQuoteRequestParams

Returns ​

Promise<OTCCreateQuoteResponse>


generateNewOrderID() ​

ts
generateNewOrderID(): string;

Misc Utility Methods

Returns ​

string


getClientType() ​

ts
getClientType(): RestClientType;

Defines the client type (affecting how requests & signatures behave)

Returns ​

RestClientType

Overrides ​

BaseRestClient.getClientType


getCustodyActivitybyId() ​

ts
getCustodyActivitybyId(params: object): Promise<CustodyGetActivityResponse>;

Get activity by id

Retrieve details for a specific task activity.

Parameters ​

ParameterType
params{ id: string; nonce?: number; }
params.idstring
params.nonce?number

Returns ​

Promise<CustodyGetActivityResponse>


getCustodyDepositAddresses() ​

ts
getCustodyDepositAddresses(params: CustodyDepositAddressesParams): Promise<CustodyDepositAddressesResponse>;

Retrieve deposit addresses for an asset and funding method, or generate a new address. Use the Get Deposit Methods API to choose the deposit method.

Parameters ​

ParameterType
paramsCustodyDepositAddressesParams

Returns ​

Promise<CustodyDepositAddressesResponse>


getCustodyDepositMethods() ​

ts
getCustodyDepositMethods(params: CustodyDepositMethodsParams): Promise<CustodyDepositMethodsResponse>;

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.

Parameters ​

ParameterType
paramsCustodyDepositMethodsParams

Returns ​

Promise<CustodyDepositMethodsResponse>


getCustodyTaskbyId() ​

ts
getCustodyTaskbyId(params: object): Promise<CustodyGetTaskResponse>;

Get task by id

Retrieve details for a specific task.

Parameters ​

ParameterType
params{ id: string; nonce?: number; }
params.idstring
params.nonce?number

Returns ​

Promise<CustodyGetTaskResponse>


getCustodyTransactionbyId() ​

ts
getCustodyTransactionbyId(params: CustodyGetTransactionParams): Promise<CustodyGetTransactionResponse>;

Get transaction by id

Get transaction by id

Parameters ​

ParameterType
paramsCustodyGetTransactionParams

Returns ​

Promise<CustodyGetTransactionResponse>


getCustodyVaultbyId() ​

ts
getCustodyVaultbyId(params: object): Promise<CustodyGetVaultResponse>;

Get vault information by id

Retrieve information and balances for a specific vault.

Parameters ​

ParameterType
params{ id: string; nonce?: number; }
params.idstring
params.nonce?number

Returns ​

Promise<CustodyGetVaultResponse>


getCustodyWithdrawAddresses() ​

ts
getCustodyWithdrawAddresses(params: CustodyWithdrawAddressesParams): Promise<CustodyWithdrawAddressesResponse>;

Get withdraw addresses

Retrieve a list of withdrawal addresses for a specified vault.

Parameters ​

ParameterType
paramsCustodyWithdrawAddressesParams

Returns ​

Promise<CustodyWithdrawAddressesResponse>


getCustodyWithdrawMethods() ​

ts
getCustodyWithdrawMethods(params: CustodyWithdrawMethodsParams): Promise<CustodyWithdrawMethodsResponse>;

Get withdraw methods

Retrieve a list of withdrawal methods available for a specified vault.

Parameters ​

ParameterType
paramsCustodyWithdrawMethodsParams

Returns ​

Promise<CustodyWithdrawMethodsResponse>


getOtcActiveQuotes() ​

ts
getOtcActiveQuotes(params?: object): Promise<OTCGetActiveQuotesResponse>;

Get OTC Active Quotes

Retrieves a list of active OTC quotes. API Key Permissions Required: Orders and trades - Query open orders & trades

Parameters ​

ParameterType
params?{ nonce?: number; vault_id?: string; }
params.nonce?number
params.vault_id?string

Returns ​

Promise<OTCGetActiveQuotesResponse>


getOtcExposures() ​

ts
getOtcExposures(params?: object): Promise<OTCGetExposuresResponse>;

Get OTC Exposures

Retrieves the max and used OTC exposures. API Key Permissions Required: Orders and trades - Query open orders & trades

Parameters ​

ParameterType
params?{ nonce?: number; }
params.nonce?number

Returns ​

Promise<OTCGetExposuresResponse>


getOtcHistoricalQuotes() ​

ts
getOtcHistoricalQuotes(params?: object): Promise<OTCGetHistoricalQuotesResponse>;

Get OTC Historical Quotes

Retrieves OTC quotes history. API Key Permissions Required: Orders and trades - Query open orders & trades

Parameters ​

ParameterType
params?{ nonce?: number; }
params.nonce?number

Returns ​

Promise<OTCGetHistoricalQuotesResponse>


getOtcPairs() ​

ts
getOtcPairs(params?: object): Promise<OTCGetPairsResponse>;

Get OTC Pairs

Retrieves the list of OTC trading pairs. API Key Permissions Required: Funds permissions - Query and Funds permissions - Deposit

Parameters ​

ParameterType
params?{ nonce?: number; }
params.nonce?number

Returns ​

Promise<OTCGetPairsResponse>


hasAccessToken() ​

ts
hasAccessToken(): boolean;

Returns ​

boolean

Inherited from ​

BaseRestClient.hasAccessToken


listCustodyActivities() ​

ts
listCustodyActivities(params: CustodyListActivitiesParams): Promise<CustodyListActivitiesResponse>;

List activities

Retrieve all activities that match the specified filter criteria.

Parameters ​

ParameterType
paramsCustodyListActivitiesParams

Returns ​

Promise<CustodyListActivitiesResponse>


listCustodyTasks() ​

ts
listCustodyTasks(params: CustodyListTasksParams): Promise<CustodyListTasksResponse>;

List tasks

Retrieve review tasks that match the specified filter criteria.

Parameters ​

ParameterType
paramsCustodyListTasksParams

Returns ​

Promise<CustodyListTasksResponse>


listCustodyTransactions() ​

ts
listCustodyTransactions(params: CustodyListTransactionsParams): Promise<CustodyListTransactionsResponse>;

List custody transactions

Retrieve the transaction history for a specified vault.

Parameters ​

ParameterType
paramsCustodyListTransactionsParams

Returns ​

Promise<CustodyListTransactionsResponse>


listCustodyVaults() ​

ts
listCustodyVaults(params: CustodyListVaultsParams): Promise<CustodyListVaultsResponse>;

List vaults

Retrieve all vaults within the custody domain.

Parameters ​

ParameterType
paramsCustodyListVaultsParams

Returns ​

Promise<CustodyListVaultsResponse>


setAccessToken() ​

ts
setAccessToken(newAccessToken: string): void;

Parameters ​

ParameterType
newAccessTokenstring

Returns ​

void

Inherited from ​

BaseRestClient.setAccessToken


updateOtcQuote() ​

ts
updateOtcQuote(params: OTCUpdateQuoteParams): Promise<OTCUpdateQuoteResponse>;

Update OTC Quote

Accepts or rejects an OTC quote. API Key Permissions Required: Orders and trades - Create & modify orders

Parameters ​

ParameterType
paramsOTCUpdateQuoteParams

Returns ​

Promise<OTCUpdateQuoteResponse>

Built by Siebly. Open source SDKs for exchange APIs.