Skip to content

Class: PartnerClient ​

Client for Kraken Embed and Ramp APIs. Confirm the base URL and account access for your integration using Kraken’s archived Partner reference.

Extends ​

  • BaseRestClient

Constructors ​

Constructor ​

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

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 ​

PartnerClient

Inherited from ​

BaseRestClient.constructor

Methods ​

cancelEmbedCustomOrder() ​

ts
cancelEmbedCustomOrder(params: PartnerCancelCustomOrderParams): Promise<PartnerCancelCustomOrderResponse>;

Cancel a previously submitted custom order that has not completed. See the archived contract.

Parameters ​

ParameterType
paramsPartnerCancelCustomOrderParams

Returns ​

Promise<PartnerCancelCustomOrderResponse>


createEmbedCustomOrder() ​

ts
createEmbedCustomOrder(params: PartnerCreateCustomOrderParams): Promise<PartnerCreateCustomOrderResponse>;

Submit a custom order with a trigger condition, such as a price trigger. See the archived contract.

Parameters ​

ParameterType
paramsPartnerCreateCustomOrderParams

Returns ​

Promise<PartnerCreateCustomOrderResponse>


createEmbedUser() ​

ts
createEmbedUser(params: PartnerCreateUserParams): Promise<PartnerCreateUserResponse>;

Create a user in Kraken Embed. See the archived contract.

Parameters ​

ParameterType
paramsPartnerCreateUserParams

Returns ​

Promise<PartnerCreateUserResponse>


executeEmbedQuote() ​

ts
executeEmbedQuote(params: PartnerExecuteQuoteParams): Promise<PartnerExecuteQuoteResponse>;

Execute a previously requested quote. See the archived contract.

Parameters ​

ParameterType
paramsPartnerExecuteQuoteParams

Returns ​

Promise<PartnerExecuteQuoteResponse>


getClientType() ​

ts
getClientType(): RestClientType;

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

Returns ​

RestClientType

Overrides ​

BaseRestClient.getClientType


getEmbedAsset() ​

ts
getEmbedAsset(params: PartnerGetAssetParams): Promise<PartnerGetAssetResponse>;

Retrieve information about an asset. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetAssetParams

Returns ​

Promise<PartnerGetAssetResponse>


getEmbedCustomOrder() ​

ts
getEmbedCustomOrder(params: PartnerGetCustomOrderParams): Promise<PartnerGetCustomOrderResponse>;

Retrieve a custom order by its identifier. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetCustomOrderParams

Returns ​

Promise<PartnerGetCustomOrderResponse>


getEmbedEarnSummary() ​

ts
getEmbedEarnSummary(params: PartnerGetEarnSummaryParams): Promise<PartnerGetEarnSummaryResponse>;

Retrieve a user’s Earn summary and Auto-Earn status. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetEarnSummaryParams

Returns ​

Promise<PartnerGetEarnSummaryResponse>


getEmbedPortfolioHistory() ​

ts
getEmbedPortfolioHistory(params: PartnerGetPortfolioHistoryParams): Promise<PartnerGetPortfolioHistoryResponse>;

Retrieve a user’s historical portfolio balances and valuations. The archived reference notes a processing delay before the latest day’s balance appears. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetPortfolioHistoryParams

Returns ​

Promise<PartnerGetPortfolioHistoryResponse>


getEmbedPortfolioSummary() ​

ts
getEmbedPortfolioSummary(params: PartnerGetPortfolioSummaryParams): Promise<PartnerGetPortfolioSummaryResponse>;

Retrieve a user’s portfolio summary. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetPortfolioSummaryParams

Returns ​

Promise<PartnerGetPortfolioSummaryResponse>


getEmbedQuote() ​

ts
getEmbedQuote(params: PartnerGetQuoteParams): Promise<PartnerGetQuoteResponse>;

Retrieve the status of a previously requested quote. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetQuoteParams

Returns ​

Promise<PartnerGetQuoteResponse>


getEmbedQuoteLimits() ​

ts
getEmbedQuoteLimits(params: PartnerGetQuoteLimitsParams): Promise<PartnerGetQuoteLimitsResponse>;

Retrieve the minimum, maximum and precision for a trade in an asset pair. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetQuoteLimitsParams

Returns ​

Promise<PartnerGetQuoteLimitsResponse>


getEmbedSettlementReport() ​

ts
getEmbedSettlementReport(params: PartnerGetSettlementReportParams): Promise<PartnerGetSettlementReportResponse>;

Retrieve a settlement report and its secure download URL for the authenticated master user. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetSettlementReportParams

Returns ​

Promise<PartnerGetSettlementReportResponse>


getEmbedUser() ​

ts
getEmbedUser(params: object): Promise<PartnerGetUserResponse>;

Retrieve a previously created user. See the archived contract.

Parameters ​

ParameterType
params{ user: string; }
params.userstring

Returns ​

Promise<PartnerGetUserResponse>


getRampCheckoutUrl() ​

ts
getRampCheckoutUrl(params: PartnerGetRampCheckoutUrlParams): Promise<PartnerGetRampCheckoutUrlResponse>;

Generate a hosted Ramp checkout URL. The response echoes the submitted transaction parameters. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetRampCheckoutUrlParams

Returns ​

Promise<PartnerGetRampCheckoutUrlResponse>


getRampLimits() ​

ts
getRampLimits(params: PartnerGetRampLimitsParams): Promise<PartnerGetRampLimitsResponse>;

Retrieve the combined minimum and maximum limits for a Ramp transaction configuration. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetRampLimitsParams

Returns ​

Promise<PartnerGetRampLimitsResponse>


getRampProspectiveQuote() ​

ts
getRampProspectiveQuote(params: PartnerGetRampProspectiveQuoteParams): Promise<PartnerGetRampProspectiveQuoteResponse>;

Preview spend and receive amounts for a Ramp transaction without reserving liquidity. See the archived contract.

Parameters ​

ParameterType
paramsPartnerGetRampProspectiveQuoteParams

Returns ​

Promise<PartnerGetRampProspectiveQuoteResponse>


hasAccessToken() ​

ts
hasAccessToken(): boolean;

Returns ​

boolean

Inherited from ​

BaseRestClient.hasAccessToken


listEmbedAssetRates() ​

ts
listEmbedAssetRates(params: PartnerListAssetRatesParams): Promise<PartnerListAssetRatesResponse>;

Retrieve historical asset rates, including a timestamp and median price for each period. See the archived contract.

Parameters ​

ParameterType
paramsPartnerListAssetRatesParams

Returns ​

Promise<PartnerListAssetRatesResponse>


listEmbedAssets() ​

ts
listEmbedAssets(params?: PartnerListAssetsParams): Promise<PartnerListAssetsResponse>;

List assets available through Embed. See the archived contract.

Parameters ​

ParameterType
params?PartnerListAssetsParams

Returns ​

Promise<PartnerListAssetsResponse>


listEmbedCustomOrders() ​

ts
listEmbedCustomOrders(params: PartnerListCustomOrdersParams): Promise<PartnerListCustomOrdersResponse>;

List previously submitted custom orders. See the archived contract.

Parameters ​

ParameterType
paramsPartnerListCustomOrdersParams

Returns ​

Promise<PartnerListCustomOrdersResponse>


listEmbedEarnAssets() ​

ts
listEmbedEarnAssets(params?: PartnerListEarnAssetsParams): Promise<PartnerListEarnAssetsResponse>;

List Earn assets. Supply a user to include that user’s active asset allocations. See the archived contract.

Parameters ​

ParameterType
params?PartnerListEarnAssetsParams

Returns ​

Promise<PartnerListEarnAssetsResponse>


listEmbedFundingTransactions() ​

ts
listEmbedFundingTransactions(params: PartnerListFundingTransactionsParams): Promise<PartnerListFundingTransactionsResponse>;

List master-account funding transactions, including deposits and withdrawals. This archived contract has no user parameter. See the archived contract.

Parameters ​

ParameterType
paramsPartnerListFundingTransactionsParams

Returns ​

Promise<PartnerListFundingTransactionsResponse>


listEmbedPortfolioDetails() ​

ts
listEmbedPortfolioDetails(params: PartnerListPortfolioDetailsParams): Promise<PartnerListPortfolioDetailsResponse>;

List assets owned in a user’s portfolio. See the archived contract.

Parameters ​

ParameterType
paramsPartnerListPortfolioDetailsParams

Returns ​

Promise<PartnerListPortfolioDetailsResponse>


listEmbedPortfolioTransactions() ​

ts
listEmbedPortfolioTransactions(params: PartnerListPortfolioTransactionsParams): Promise<PartnerListPortfolioTransactionsResponse>;

List a user’s trades and portfolio transactions. See the archived contract.

Parameters ​

ParameterType
paramsPartnerListPortfolioTransactionsParams

Returns ​

Promise<PartnerListPortfolioTransactionsResponse>


listEmbedSettlementReports() ​

ts
listEmbedSettlementReports(params?: PartnerListSettlementReportsParams): Promise<PartnerListSettlementReportsResponse>;

Retrieve a paginated list of settlement reports for the authenticated master user, optionally filtered by date range and report type. See the archived contract.

Parameters ​

ParameterType
params?PartnerListSettlementReportsParams

Returns ​

Promise<PartnerListSettlementReportsResponse>


listRampBuyCryptoAssets() ​

ts
listRampBuyCryptoAssets(): Promise<PartnerListRampBuyCryptoAssetsResponse>;

List assets for Ramp purchases, including networks, withdrawal methods and provider-specific identifiers. See the archived contract.

Returns ​

Promise<PartnerListRampBuyCryptoAssetsResponse>


listRampCountries() ​

ts
listRampCountries(): Promise<PartnerListRampCountriesResponse>;

List supported Ramp countries and regions. Availability can be limited to individual states, provinces or regions. See the archived contract.

Returns ​

Promise<PartnerListRampCountriesResponse>


listRampFiatCurrencies() ​

ts
listRampFiatCurrencies(): Promise<PartnerListRampFiatCurrenciesResponse>;

List fiat currencies supported for funding Ramp transactions. See the archived contract.

Returns ​

Promise<PartnerListRampFiatCurrenciesResponse>


listRampPaymentMethods() ​

ts
listRampPaymentMethods(): Promise<PartnerListRampPaymentMethodsResponse>;

List fiat payment methods for Ramp deposits, including optional provider-specific identifiers. See the archived contract.

Returns ​

Promise<PartnerListRampPaymentMethodsResponse>


requestEmbedProspectiveQuote() ​

ts
requestEmbedProspectiveQuote(params: PartnerRequestProspectiveQuoteParams): Promise<PartnerRequestProspectiveQuoteResponse>;

Request an indicative price and fee for an asset pair. See the archived contract.

Parameters ​

ParameterType
paramsPartnerRequestProspectiveQuoteParams

Returns ​

Promise<PartnerRequestProspectiveQuoteResponse>


requestEmbedQuote() ​

ts
requestEmbedQuote(params: PartnerRequestQuoteParams): Promise<PartnerRequestQuoteResponse>;

Request a price quote that can be executed later. See the archived contract.

Parameters ​

ParameterType
paramsPartnerRequestQuoteParams

Returns ​

Promise<PartnerRequestQuoteResponse>


setAccessToken() ​

ts
setAccessToken(newAccessToken: string): void;

Parameters ​

ParameterType
newAccessTokenstring

Returns ​

void

Inherited from ​

BaseRestClient.setAccessToken


submitEmbedVerification() ​

ts
submitEmbedVerification(params: PartnerSubmitVerificationParams): Promise<PartnerSubmitVerificationResponse>;

Submit user verification details for Kraken Embed. See the archived Partner reference for verification requirements.

Parameters ​

ParameterType
paramsPartnerSubmitVerificationParams

Returns ​

Promise<PartnerSubmitVerificationResponse>


toggleEmbedAutoEarn() ​

ts
toggleEmbedAutoEarn(params: PartnerToggleAutoEarnParams): Promise<PartnerToggleAutoEarnResponse>;

Trigger an asynchronous change to a user’s Auto-Earn setting. The successful response body is empty; call getEmbedEarnSummary() to read the current status. See the archived contract.

Parameters ​

ParameterType
paramsPartnerToggleAutoEarnParams

Returns ​

Promise<PartnerToggleAutoEarnResponse>


updateEmbedUser() ​

ts
updateEmbedUser(params: PartnerUpdateUserParams): Promise<PartnerUpdateUserResponse>;

Update an existing user’s profile. See the archived contract.

Parameters ​

ParameterType
paramsPartnerUpdateUserParams

Returns ​

Promise<PartnerUpdateUserResponse>


withdrawEmbedFunds() ​

ts
withdrawEmbedFunds(params: PartnerWithdrawFundsParams): Promise<PartnerWithdrawFundsResponse>;

Request a withdrawal from a master account or subaccount. See the archived contract.

Parameters ​

ParameterType
paramsPartnerWithdrawFundsParams

Returns ​

Promise<PartnerWithdrawFundsResponse>

Built by Siebly. Open source SDKs for exchange APIs.