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
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
| Parameter | Type | Description |
|---|---|---|
restClientOptions? | RestClientOptions | options to configure REST API connectivity |
networkOptions? | AxiosRequestConfig | HTTP networking options for axios |
Returns
PartnerClient
Inherited from
BaseRestClient.constructor
Methods
cancelEmbedCustomOrder()
cancelEmbedCustomOrder(params: PartnerCancelCustomOrderParams): Promise<PartnerCancelCustomOrderResponse>;Cancel a previously submitted custom order that has not completed. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerCancelCustomOrderParams |
Returns
Promise<PartnerCancelCustomOrderResponse>
createEmbedCustomOrder()
createEmbedCustomOrder(params: PartnerCreateCustomOrderParams): Promise<PartnerCreateCustomOrderResponse>;Submit a custom order with a trigger condition, such as a price trigger. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerCreateCustomOrderParams |
Returns
Promise<PartnerCreateCustomOrderResponse>
createEmbedUser()
createEmbedUser(params: PartnerCreateUserParams): Promise<PartnerCreateUserResponse>;Create a user in Kraken Embed. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerCreateUserParams |
Returns
Promise<PartnerCreateUserResponse>
executeEmbedQuote()
executeEmbedQuote(params: PartnerExecuteQuoteParams): Promise<PartnerExecuteQuoteResponse>;Execute a previously requested quote. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerExecuteQuoteParams |
Returns
Promise<PartnerExecuteQuoteResponse>
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getEmbedAsset()
getEmbedAsset(params: PartnerGetAssetParams): Promise<PartnerGetAssetResponse>;Retrieve information about an asset. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetAssetParams |
Returns
Promise<PartnerGetAssetResponse>
getEmbedCustomOrder()
getEmbedCustomOrder(params: PartnerGetCustomOrderParams): Promise<PartnerGetCustomOrderResponse>;Retrieve a custom order by its identifier. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetCustomOrderParams |
Returns
Promise<PartnerGetCustomOrderResponse>
getEmbedEarnSummary()
getEmbedEarnSummary(params: PartnerGetEarnSummaryParams): Promise<PartnerGetEarnSummaryResponse>;Retrieve a user’s Earn summary and Auto-Earn status. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetEarnSummaryParams |
Returns
Promise<PartnerGetEarnSummaryResponse>
getEmbedPortfolioHistory()
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
| Parameter | Type |
|---|---|
params | PartnerGetPortfolioHistoryParams |
Returns
Promise<PartnerGetPortfolioHistoryResponse>
getEmbedPortfolioSummary()
getEmbedPortfolioSummary(params: PartnerGetPortfolioSummaryParams): Promise<PartnerGetPortfolioSummaryResponse>;Retrieve a user’s portfolio summary. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetPortfolioSummaryParams |
Returns
Promise<PartnerGetPortfolioSummaryResponse>
getEmbedQuote()
getEmbedQuote(params: PartnerGetQuoteParams): Promise<PartnerGetQuoteResponse>;Retrieve the status of a previously requested quote. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetQuoteParams |
Returns
Promise<PartnerGetQuoteResponse>
getEmbedQuoteLimits()
getEmbedQuoteLimits(params: PartnerGetQuoteLimitsParams): Promise<PartnerGetQuoteLimitsResponse>;Retrieve the minimum, maximum and precision for a trade in an asset pair. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetQuoteLimitsParams |
Returns
Promise<PartnerGetQuoteLimitsResponse>
getEmbedSettlementReport()
getEmbedSettlementReport(params: PartnerGetSettlementReportParams): Promise<PartnerGetSettlementReportResponse>;Retrieve a settlement report and its secure download URL for the authenticated master user. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetSettlementReportParams |
Returns
Promise<PartnerGetSettlementReportResponse>
getEmbedUser()
getEmbedUser(params: object): Promise<PartnerGetUserResponse>;Retrieve a previously created user. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | { user: string; } |
params.user | string |
Returns
Promise<PartnerGetUserResponse>
getRampCheckoutUrl()
getRampCheckoutUrl(params: PartnerGetRampCheckoutUrlParams): Promise<PartnerGetRampCheckoutUrlResponse>;Generate a hosted Ramp checkout URL. The response echoes the submitted transaction parameters. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetRampCheckoutUrlParams |
Returns
Promise<PartnerGetRampCheckoutUrlResponse>
getRampLimits()
getRampLimits(params: PartnerGetRampLimitsParams): Promise<PartnerGetRampLimitsResponse>;Retrieve the combined minimum and maximum limits for a Ramp transaction configuration. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetRampLimitsParams |
Returns
Promise<PartnerGetRampLimitsResponse>
getRampProspectiveQuote()
getRampProspectiveQuote(params: PartnerGetRampProspectiveQuoteParams): Promise<PartnerGetRampProspectiveQuoteResponse>;Preview spend and receive amounts for a Ramp transaction without reserving liquidity. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerGetRampProspectiveQuoteParams |
Returns
Promise<PartnerGetRampProspectiveQuoteResponse>
hasAccessToken()
hasAccessToken(): boolean;Returns
boolean
Inherited from
BaseRestClient.hasAccessToken
listEmbedAssetRates()
listEmbedAssetRates(params: PartnerListAssetRatesParams): Promise<PartnerListAssetRatesResponse>;Retrieve historical asset rates, including a timestamp and median price for each period. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerListAssetRatesParams |
Returns
Promise<PartnerListAssetRatesResponse>
listEmbedAssets()
listEmbedAssets(params?: PartnerListAssetsParams): Promise<PartnerListAssetsResponse>;List assets available through Embed. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params? | PartnerListAssetsParams |
Returns
Promise<PartnerListAssetsResponse>
listEmbedCustomOrders()
listEmbedCustomOrders(params: PartnerListCustomOrdersParams): Promise<PartnerListCustomOrdersResponse>;List previously submitted custom orders. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerListCustomOrdersParams |
Returns
Promise<PartnerListCustomOrdersResponse>
listEmbedEarnAssets()
listEmbedEarnAssets(params?: PartnerListEarnAssetsParams): Promise<PartnerListEarnAssetsResponse>;List Earn assets. Supply a user to include that user’s active asset allocations. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params? | PartnerListEarnAssetsParams |
Returns
Promise<PartnerListEarnAssetsResponse>
listEmbedFundingTransactions()
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
| Parameter | Type |
|---|---|
params | PartnerListFundingTransactionsParams |
Returns
Promise<PartnerListFundingTransactionsResponse>
listEmbedPortfolioDetails()
listEmbedPortfolioDetails(params: PartnerListPortfolioDetailsParams): Promise<PartnerListPortfolioDetailsResponse>;List assets owned in a user’s portfolio. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerListPortfolioDetailsParams |
Returns
Promise<PartnerListPortfolioDetailsResponse>
listEmbedPortfolioTransactions()
listEmbedPortfolioTransactions(params: PartnerListPortfolioTransactionsParams): Promise<PartnerListPortfolioTransactionsResponse>;List a user’s trades and portfolio transactions. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerListPortfolioTransactionsParams |
Returns
Promise<PartnerListPortfolioTransactionsResponse>
listEmbedSettlementReports()
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
| Parameter | Type |
|---|---|
params? | PartnerListSettlementReportsParams |
Returns
Promise<PartnerListSettlementReportsResponse>
listRampBuyCryptoAssets()
listRampBuyCryptoAssets(): Promise<PartnerListRampBuyCryptoAssetsResponse>;List assets for Ramp purchases, including networks, withdrawal methods and provider-specific identifiers. See the archived contract.
Returns
Promise<PartnerListRampBuyCryptoAssetsResponse>
listRampCountries()
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()
listRampFiatCurrencies(): Promise<PartnerListRampFiatCurrenciesResponse>;List fiat currencies supported for funding Ramp transactions. See the archived contract.
Returns
Promise<PartnerListRampFiatCurrenciesResponse>
listRampPaymentMethods()
listRampPaymentMethods(): Promise<PartnerListRampPaymentMethodsResponse>;List fiat payment methods for Ramp deposits, including optional provider-specific identifiers. See the archived contract.
Returns
Promise<PartnerListRampPaymentMethodsResponse>
requestEmbedProspectiveQuote()
requestEmbedProspectiveQuote(params: PartnerRequestProspectiveQuoteParams): Promise<PartnerRequestProspectiveQuoteResponse>;Request an indicative price and fee for an asset pair. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerRequestProspectiveQuoteParams |
Returns
Promise<PartnerRequestProspectiveQuoteResponse>
requestEmbedQuote()
requestEmbedQuote(params: PartnerRequestQuoteParams): Promise<PartnerRequestQuoteResponse>;Request a price quote that can be executed later. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerRequestQuoteParams |
Returns
Promise<PartnerRequestQuoteResponse>
setAccessToken()
setAccessToken(newAccessToken: string): void;Parameters
| Parameter | Type |
|---|---|
newAccessToken | string |
Returns
void
Inherited from
BaseRestClient.setAccessToken
submitEmbedVerification()
submitEmbedVerification(params: PartnerSubmitVerificationParams): Promise<PartnerSubmitVerificationResponse>;Submit user verification details for Kraken Embed. See the archived Partner reference for verification requirements.
Parameters
| Parameter | Type |
|---|---|
params | PartnerSubmitVerificationParams |
Returns
Promise<PartnerSubmitVerificationResponse>
toggleEmbedAutoEarn()
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
| Parameter | Type |
|---|---|
params | PartnerToggleAutoEarnParams |
Returns
Promise<PartnerToggleAutoEarnResponse>
updateEmbedUser()
updateEmbedUser(params: PartnerUpdateUserParams): Promise<PartnerUpdateUserResponse>;Update an existing user’s profile. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerUpdateUserParams |
Returns
Promise<PartnerUpdateUserResponse>
withdrawEmbedFunds()
withdrawEmbedFunds(params: PartnerWithdrawFundsParams): Promise<PartnerWithdrawFundsResponse>;Request a withdrawal from a master account or subaccount. See the archived contract.
Parameters
| Parameter | Type |
|---|---|
params | PartnerWithdrawFundsParams |
Returns
Promise<PartnerWithdrawFundsResponse>