Kraken Embed

Get Portfolio Summary

Changed on

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

get/v1/kraken_embed/users/{user_id}/summary

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/kraken_embed/users/{user_id}/summary
  • Auth
    HTTP basic

Path parameters

user_idstring required

The ID of the Privy user.

Query parameters

quotestring
include[current_day_pnl]'true' | 'false'

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

Headers

privy-app-idstring required

ID of your Privy app.

Response

Portfolio summary retrieved successfully.

Example response

{
  "data": {
    "result": {
      "timestamp": "2024-04-15T12:00:00Z",
      "currency": "USD",
      "portfolio_value": "35000.00",
      "withheld_value": "0.00",
      "open_orders": "0.00",
      "available_balance": "35000.00",
      "lots_upnl": "5000.00",
      "cost_basis": "30000.00",
      "current_day_pnl": null
    }
  }
}

Changes

  • a8d27de9e15dRevision changes
    • breaking

      the / response's property type changed from object null to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added subschema #2 to the / response property anyOf list for the response status