PRprivy-io
Kraken Embed

Get Portfolio Transactions

Changed on

Get transaction history for a user's portfolio with filtering and pagination options.

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

Request

  • Base URL
    https://api.privy.io
  • Auth
    HTTP basic

Path parameters

user_idstring required

The ID of the Privy user.

Query parameters

cursorstring
typesKrakenEmbedTransactionType[]
page_sizeinteger
assetsstring[]
from_timestring date-time
until_timestring date-time
statusesKrakenEmbedTransactionStatus[]
idsstring[]
sorting'descending' | 'ascending'

Sort direction for paginated transaction lists.

quotestring
type'simple_order_quote' | 'simple_order_quote_failed' required

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

ref_idstring required

Headers

privy-app-idstring required

ID of your Privy app.

Response

Transaction history retrieved successfully.

Example response

{
  "data": {
    "result": {
      "transactions": [
        {
          "id": "TXN-12345",
          "time": "2024-04-15T11:00:00Z",
          "type": "simple_order",
          "status": "successful",
          "ref_id": "REF-12345",
          "ref_id2": "QTE-12345-ABCDE",
          "spend": {
            "ledger_id": "LED-001",
            "time": "2024-04-15T11:00:00Z",
            "amount": {
              "asset": "USD",
              "asset_class": "currency",
              "amount": "100.00"
            },
            "quoted_amount": null,
            "fee": {
              "asset": "USD",
              "asset_class": "currency",
              "amount": "1.00"
            },
            "quoted_fee": null,
            "total": {
              "asset": "USD",
              "asset_class": "currency",
              "amount": "101.00"
            },
            "quoted_total": null,
            "balance": {
              "asset": "USD",
              "asset_class": "currency",
              "amount": "899.00"
            }
          },
          "receive": {
            "ledger_id": "LED-002",
            "time": "2024-04-15T11:00:00Z",
            "amount": {
              "asset": "BTC",
              "asset_class": "currency",
              "amount": "0.00150000"
            },
            "quoted_amount": null,
            "fee": {
              "asset": "BTC",
              "asset_class": "currency",
              "amount": "0.00000150"
            },
            "quoted_fee": null,
            "total": {
              "asset": "BTC",
              "asset_class": "currency",
              "amount": "0.00149850"
            },
            "quoted_total": null,
            "balance": {
              "asset": "BTC",
              "asset_class": "currency",
              "amount": "0.00149850"
            }
          },
          "details": {
            "type": "simple_order",
            "quote_id": "QTE-12345-ABCDE",
            "trade_type": "buy",
            "parent_transaction": null
          }
        }
      ],
      "stats": {
        "transactions_seen": 1
      },
      "next_cursor": "next_page_token_xyz"
    }
  }
}

Changes

  • c10a42ebeddbRevision changes
    • breaking

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

    • info

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

    • info

      removed the failed enum value from the //// response property for the response status

    • info

      removed the in_progress enum value from the //// response property for the response status

    • info

      removed the successful enum value from the //// response property for the response status

    • info

      removed the unspecified enum value from the //// response property for the response status