Documentation

Kraken Embed

kraken_embed

Domain types

KrakenEmbedAssetSortOption = "trending" | "market_cap_rank" | "-market_cap_rank" | 16 more...

Sorting options for the asset list endpoint.

KrakenEmbedCancelCustomOrderInput = { user_id }

Request body for cancelling a custom order.

KrakenEmbedCancelCustomOrderPath = { order_id }

Path parameters for cancelling a custom order.

KrakenEmbedCancelCustomOrderResponse = { result, error, errors }

Response body for cancelling a custom order.

KrakenEmbedCancelCustomOrderResult = { order }

Result payload for cancel custom order response.

KrakenEmbedCountryCode = "AD" | "AE" | "AF" | 259 more...

ISO 3166-1 alpha-2 country codes supported by Kraken Embed.

KrakenEmbedCreateCustomOrderInput = { action, name, trigger, 1 more... }

Request body for creating a custom order.

KrakenEmbedCreateCustomOrderResponse = { result, error, errors }

Response body for creating a custom order.

KrakenEmbedCreateCustomOrderResult = { order }

Result payload for create custom order response.

KrakenEmbedCurrentDayPnl = { pnl, since }

Current day profit and loss for a portfolio, calculated from the most recent available balance.

KrakenEmbedCustomOrder = { id, action, created_at, 4 more... }

Full custom order object.

KrakenEmbedCustomOrderAction = { amount, fee_bps, quote, 2 more... }

Trade action for a custom order.

KrakenEmbedCustomOrderAmount = { amount, asset, asset_class }

Asset amount for custom order actions.

KrakenEmbedCustomOrderOccurrence = { id, created_at, status, 5 more... }

A single execution occurrence of a custom order.

KrakenEmbedCustomOrderOccurrenceExecutedAction = { quote_id }

Executed action details for a custom order occurrence.

KrakenEmbedCustomOrderOccurrenceStatus = "success" | "failure" | "skipped"

Outcome status of a custom order execution occurrence.

KrakenEmbedCustomOrderOccurrenceTrigger = { type }

Trigger metadata for a custom order occurrence.

KrakenEmbedCustomOrderOccurrenceTriggerType = "time" | "price" | "crypto_deposit" | 1 more...

The trigger type that caused a custom order occurrence to execute.

KrakenEmbedCustomOrderQuoteAsset = { asset }

Target asset for the other side of the custom order trade.

KrakenEmbedCustomOrderStatus = { status, reason }

Custom order status with optional reason for cancelled or paused states.

KrakenEmbedCustomOrderStatusValue = "active" | "completed" | "cancelled" | 1 more...

The lifecycle state of a custom order.

KrakenEmbedCustomOrderTrigger = { base_asset, condition, quote_asset, 2 more... }

Price trigger for a custom order. The order executes when base_asset/quote_asset rate meets the condition against target_price.

KrakenEmbedCustomOrderTriggerCondition = "gte" | "lte"

Comparison operator for a custom order price trigger.

KrakenEmbedEarnAmount = { converted, native }

An earn amount with native and converted values.

KrakenEmbedEarnAprEstimate = { high, low }

Low and high estimate of the yield of an earn asset.

KrakenEmbedEarnAsset = { apr_estimate, user_allocation }

A single asset that can yield rewards.

KrakenEmbedEarnUserAllocation = { total_allocated, total_rewarded, upcoming_reward_date }

User allocation for an earn asset.

KrakenEmbedFullName = { first_name, last_name, middle_name }

User's full name including first, optional middle, and last name.

KrakenEmbedGetAssetListQueryParamsSchema = { filter[assets], filter[platform_statuses], filter[tradable_only], 6 more... }

Query parameters for listing and filtering available assets.

KrakenEmbedGetCustomOrderHistoryQueryParams = { order_id, user_id }

Query parameters for getting custom order history.

KrakenEmbedGetCustomOrderHistoryResponse = { result, error, errors }

Response body for getting custom order execution history.

KrakenEmbedGetCustomOrderHistoryResult = { history }

Result payload for custom order history response.

KrakenEmbedGetCustomOrderQueryParams = { order_id, user_id }

Query parameters for getting a single custom order.

KrakenEmbedGetCustomOrderResponse = { result, error, errors }

Response body for getting a single custom order.

KrakenEmbedGetCustomOrderResult = { order }

Result payload for get custom order response.

KrakenEmbedGetEarnAssetsKrakenResponse = { result, error, errors }

Kraken API response envelope for earn assets.

KrakenEmbedGetEarnAssetsQueryParams = { assets, currency, user }

Query parameters for listing earn assets.

KrakenEmbedGetEarnAssetsResponse = { data }

List of earn assets with APR estimates and optional user allocations.

KrakenEmbedGetEarnAssetsResult = { assets }

Result payload for earn assets response.

KrakenEmbedGetEarnSummaryKrakenResponse = { result, error, errors }

Kraken API response envelope for earn summary.

KrakenEmbedGetEarnSummaryQueryParams = { currency }

Query parameters for getting an earn summary.

KrakenEmbedGetEarnSummaryResponse = { data }

Earn summary for a user including Auto-Earn status, total rewards, and upcoming payouts.

KrakenEmbedGetEarnSummaryResult = { auto_earn_eligible, auto_earn_enabled, num_earning_assets, 6 more... }

Result payload for earn summary response.

KrakenEmbedGetPortfolioDetailsQueryParamsSchema = { quote }

Query parameters for portfolio details endpoint.

KrakenEmbedGetPortfolioSummaryQueryParams = { include[current_day_pnl], quote }

Query parameters for getting a portfolio summary.

KrakenEmbedGetPortfolioSummaryResponse = { data }

High-level summary of a user's portfolio including total value, available balance, and unrealized P&L.

KrakenEmbedGetPortfolioSummaryResult = { result, error, errors }

Kraken API response envelope for portfolio summary, containing optional errors and the result payload.

KrakenEmbedGetPortfolioTransactionsQueryParamsSchema = { assets, cursor, from_time, 8 more... }

Query parameters for filtering and paginating portfolio transactions.

KrakenEmbedGetQuoteQueryParams = { user_id }

Query parameters for getting a quote status.

KrakenEmbedIdentityDocumentType = "passport" | "drivers_license" | "id_card" | 2 more...

Document types accepted for proof of identity verification.

KrakenEmbedIncludeCurrentDayPnlQueryParam = "true" | "false"

A string-encoded boolean query parameter on including current day profit and loss.

KrakenEmbedListCustomOrdersQueryParams = { user_id, cursor, statuses }

Query parameters for listing custom orders.

KrakenEmbedListCustomOrdersResponse = { result, error, errors }

Response body for listing custom orders.

KrakenEmbedListCustomOrdersResult = { orders }

Result payload for list custom orders response.

KrakenEmbedPortfolioSummaryPayload = { available_balance, currency, open_orders, 6 more... }

Portfolio summary payload containing balances, value, and profit/loss information.

KrakenEmbedPortfolioTransactionRefID = { ref_id, type }

A reference ID filter for portfolio transaction queries, identifying a transaction by type and reference identifier.

KrakenEmbedPortfolioTransactionRefIDType = "simple_order_quote" | "simple_order_quote_failed"

The type of reference ID used to filter portfolio transactions by quote or failed quote references.

KrakenEmbedQuoteType = "receive" | "spend"

Whether the quote amount refers to the asset being received or spent.

KrakenEmbedResidence = { city, country, line1, 3 more... }

User's residential address including street, city, postal code, and country.

KrakenEmbedResidenceDocumentType = "bank_statement" | "credit_card_statement" | "employer_letter_or_work_contract" | 14 more...

Document types accepted for proof of address verification.

KrakenEmbedSortingOrder = "descending" | "ascending"

Sort direction for paginated transaction lists.

KrakenEmbedStartAddressMetadata = { address, document_number, document_type, 1 more... }

Optional best-effort metadata hints for proof of address verification.

KrakenEmbedStartAddressVerificationURLInput = { document_url, type, debug, 1 more... }

Input payload for starting proof of address verification via URL.

KrakenEmbedStartIdentityInfo = { date_of_birth, full_name }

Identity information hints including full name and date of birth for proof of identity verification.

KrakenEmbedStartIdentityMetadata = { document_number, document_type, expiration_date, 3 more... }

Optional best-effort metadata hints for proof of identity verification.

KrakenEmbedStartIdentityVerificationURLInput = { front_url, type, back_url, 2 more... }

Input payload for starting proof of identity verification via URLs.

KrakenEmbedStartLivenessVerificationURLInput = { center_url, left_url, right_url, 2 more... }

Input payload for starting proof of liveness verification via URLs.

KrakenEmbedStartVerificationDebug = { outcome }

Debug options for start verification. Only works in non-production environments.

KrakenEmbedStartVerificationURLInput =
KrakenEmbedStartIdentityVerificationURLInput
|
KrakenEmbedStartAddressVerificationURLInput
|
KrakenEmbedStartLivenessVerificationURLInput

Discriminated union of all start verification URL input types.

KrakenEmbedStartVerificationURLResponse = { result }

Response body for starting verification via URL.

KrakenEmbedStartVerificationURLResult = { verification_id }

Result payload for start verification URL response.

KrakenEmbedToggleAutoEarnKrakenResponse = { error, errors, result }

Kraken API response envelope for toggle auto-earn. Result is null on success.

KrakenEmbedToggleAutoEarnQueryParams = { want_enabled }

Query parameters for toggling Auto-Earn.

KrakenEmbedToggleAutoEarnResponse = { data }

Response from toggling Auto-Earn. The response body is empty on success.

KrakenEmbedTransactionStatus = "unspecified" | "in_progress" | "successful" | 1 more...

Lifecycle status of a portfolio transaction.

KrakenEmbedTransactionType = "simple_order" | "simple_order_failed" | "earn_reward"

Type of portfolio transaction in the transaction history.

KrakenEmbedUpcomingReward = { accumulated_amount, asset, date, 1 more... }

An upcoming earn reward for a specific asset.