Skip to content

Action Types

This page documents all possible action types used throughout the Definitive API. These action types are used in transfer history, vault operations, and portfolio management endpoints.

Available Action Types

Action TypeDescription
VAULT_ACTION_DEPOSITInbound transfers into the portfolio vault
VAULT_ACTION_WITHDRAWALOutbound transfers from the vault
VAULT_ACTION_SWAPInternal swaps between vault assets

Action Type Categories

Transfer Actions

These action types represent different types of asset movements:

  • VAULT_ACTION_DEPOSIT: Used when assets are deposited into a vault from an external source
  • VAULT_ACTION_WITHDRAWAL: Used when assets are withdrawn from a vault to an external destination
  • VAULT_ACTION_SWAP: Used when assets are swapped within the vault (e.g., USDC to ETH)

Usage in API Endpoints

Action types are used as filter parameters in the following API endpoints:

Example Usage

// Filter for deposits and withdrawals only
const queryParams = {
  actionTypes: ["VAULT_ACTION_DEPOSIT", "VAULT_ACTION_WITHDRAWAL"],
};
 
// Filter for all action types
const queryParams = {
  actionTypes: [
    "VAULT_ACTION_DEPOSIT",
    "VAULT_ACTION_WITHDRAWAL",
    "VAULT_ACTION_SWAP",
  ],
};

Related Endpoints

These action types are used in the following API endpoints: