# List Cash Activities
Retrieves account transaction activities records with details.
# OpenAPI definition
```json
{
"info": {
"title": "Webull Open API Reference",
"description": "application.yml\\ncom\\ni18n\\nMETA-INF\\nstatic\\n\\r\\n",
"contact": {
"name": "",
"url": "",
"email": ""
},
"version": "2.0",
"x-logo": {
"url": "static/png/logo.png"
}
},
"servers": [
{
"url": "https://broker-api.sandbox.webull.hk"
}
],
"path": "/broker/activities/cash-activities/list",
"method": "get",
"tags": [
"Activity"
],
"description": "Retrieves account transaction activities records with details.",
"operationId": "brokerActivityByType",
"parameters": [
{
"name": "account_id",
"in": "query",
"description": "Provide the target account id",
"required": true,
"schema": {
"type": "String"
},
"example": "943a9802f6c14983b3b4755c69c01717"
},
{
"name": "activity_types",
"in": "query",
"description": "Account activity types",
"required": false,
"schema": {
"type": "string",
"description": "Activity Type
ADJUSTMENT - Adjustment Activity Type
ALLOCATION - Allocation Activity Type
DEPOSIT - Deposit Activity Type
DIVIDENDS - Dividends Activity Type
EXECUTION - Execution Activity Type
FEES - Fees Activity Type
INTERESTS - Interests Activity Type
JOURNAL - Journal Activity Type
OPTION_EA - Option EA Activity Type
REORGANIZATION - Reorganization Activity Type
SUBSCRIBE - Subscribe Activity Type
TAX - Tax Activity Type
TRADE - Trade Activity Type
TRANSFER - Transfer Activity Type
WITHDRAW - Withdraw Activity Type",
"enum": [
"ADJUSTMENT",
"ALLOCATION",
"DEPOSIT",
"DIVIDENDS",
"EXECUTION",
"FEES",
"INTERESTS",
"JOURNAL",
"OPTION_EA",
"REORGANIZATION",
"SUBSCRIBE",
"TAX",
"TRADE",
"TRANSFER",
"WITHDRAW"
]
},
"example": "TRADE,TRANSFER"
},
{
"name": "start_time",
"in": "query",
"description": "Activity query start time, formats: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required": false,
"schema": {
"type": "String"
},
"example": "2025-01-05T22:59:11.591Z"
},
{
"name": "end_time",
"in": "query",
"description": "Activity query end time, formats: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"required": false,
"schema": {
"type": "String"
},
"example": "2025-01-05T23:59:11.591Z"
},
{
"name": "pagination_key",
"in": "query",
"description": "Pagination key from previous response for next page.",
"required": false,
"schema": {
"type": "String"
},
"example": "eyJ2IjoxLCJsYXN0SWQiOiI5MTMyNDQ3NjkiLCJwYWdlSW===="
},
{
"name": "x-app-key",
"in": "header",
"description": "A unique identifier issued to a developer for accessing an application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-app-secret",
"in": "header",
"description": "A unique key issued to developers to access the application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-timestamp",
"in": "header",
"description": "Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-signature-version",
"in": "header",
"description": "Signature algorithm version, default is 1.0.",
"required": true,
"schema": {
"type": "string",
"default": "1.0"
},
"examples": {
"1.0": {
"value": "1.0"
}
}
},
{
"name": "x-signature-algorithm",
"in": "header",
"description": "Signature algorithm, default is HMAC-SHA1.",
"required": true,
"schema": {
"type": "string",
"default": "HMAC-SHA1"
},
"examples": {
"HMAC-SHA1": {
"value": "HMAC-SHA1"
}
}
},
{
"name": "x-signature-nonce",
"in": "header",
"description": "Signature unique random number.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-version",
"in": "header",
"description": "API interface version. Supported values: `v2`, `v3`.",
"required": true,
"schema": {
"type": "string",
"default": "v3"
},
"examples": {
"v3": {
"value": "v3"
}
}
},
{
"name": "x-signature",
"in": "header",
"description": "A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Result data list",
"items": {
"required": [
"account_id",
"account_number",
"activity_sub_type",
"activity_type",
"biz_time",
"currency",
"id",
"net_amount",
"trade_date"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID",
"example": "a1b2c3d4e5f6g7h8i9j0"
},
"account_id": {
"type": "string",
"description": "Account ID",
"example": "943a9802f6c14983b3b4755c69c01717"
},
"account_number": {
"type": "string",
"description": "Account Number",
"example": "VA000000001"
},
"activity_type": {
"type": "string",
"description": "Activity Type
ADJUSTMENT - Adjustment Activity Type
ALLOCATION - Allocation Activity Type
DEPOSIT - Deposit Activity Type
DIVIDENDS - Dividends Activity Type
EXECUTION - Execution Activity Type
FEES - Fees Activity Type
INTERESTS - Interests Activity Type
JOURNAL - Journal Activity Type
OPTION_EA - Option EA Activity Type
REORGANIZATION - Reorganization Activity Type
SUBSCRIBE - Subscribe Activity Type
TAX - Tax Activity Type
TRADE - Trade Activity Type
TRANSFER - Transfer Activity Type
WITHDRAW - Withdraw Activity Type
OTHER - Other Activity Type",
"example": "TRADE",
"enum": [
"ADJUSTMENT",
"ALLOCATION",
"DEPOSIT",
"DIVIDENDS",
"EXECUTION",
"FEES",
"INTERESTS",
"JOURNAL",
"OPTION_EA",
"REORGANIZATION",
"SUBSCRIBE",
"TAX",
"TRADE",
"TRANSFER",
"WITHDRAW",
"OTHER"
]
},
"activity_sub_type": {
"type": "string",
"description": "Activity Sub Type. Provides detailed classification under each ActivityType.
Multiple sub-types may share the same enum value but belong to different parent types.
For example, FOREIGN_TAX_WITHHELD can appear under DIVIDENDS, FEES, or TAX types.
NOT_SET - No sub type
CASH_ADJUSTMENT - Cash Adjustment Sub Type, super type is ADJUSTMENT
WIRE - Wire Deposit Sub Type, super type is DEPOSIT or WITHDRAW
TAX_WITHHOLD - Tax Withhold Dividend Sub Type, super type is DIVIDENDS
COLLECTION_FEE - Collection Fee Dividend Sub Type, super type is DIVIDENDS or INTERESTS
INCOME - Income Dividend Sub Type, super type is DIVIDENDS
PAYMENT_IN_LIEU - Payment In Lieu Dividend Sub Type, super type is DIVIDENDS
SCRIP_FEE - Scrip Fee Dividend Sub Type, super type is DIVIDENDS or REORGANIZATION
US_TAX_WITHHOLDING - US Tax Withholding Dividend or Tax Sub Type, super type is DIVIDENDS or TAX
CA_HANDLING_FEE - CA Handling Fee Sub Type, super type is DIVIDENDS or REORGANIZATION
FOREIGN_TAX_WITHHELD - Foreign Tax Withheld Sub Type, super type is DIVIDENDS or FEES or TAX
CASH_IN_LIEU - Cash In Lieu Sub Type, super type is DIVIDENDS or REORGANIZATION
ADJUSTMENT - Adjustment Dividend Sub Type, super type is DIVIDENDS
ADR - ADR Fees Sub Type, super type is FEES
IPO_SUBSCRIPTION_FEE - IPO Subscription Fee Sub Type, super type is FEES
TRANSACTION_FEES - Transaction Fees Sub Type, super type is FEES
CCASS_SETTLEMENT_FEE - CCASS Settlement Fee Sub Type, super type is FEES
JOURNAL_BETWEEN_ACCOUNTS - Journal Between Accounts Sub Type, super type is FEES or JOURNAL
CUSTODIAN_FEE - Custodian Fee Sub Type, super type is FEES
SETTLEMENT_FEES - Settlement Fees Sub Type, super type is FEES
TRANSFER_FOP - Transfer FOP Fees Sub Type, super type is FEES
FTT - FTT Fees Sub Type, super type is FEES
COMMISSION - Commission Fees Sub Type, super type is FEES
SYSTEM_FEE - System Fee Sub Type, super type is FEES
CORRESPONDENT_BILLING - Correspondent Billing Fees Sub Type, super type is FEES
CUSTODY_FEE - Custody Fee Sub Type, super type is FEES
STOCK_BORROW_INTEREST - Stock Borrow Interest Sub Type, super type is INTERESTS
DEBIT_CASH - Debit Cash Sub Type, super type is INTERESTS
IPO_FINANCING - IPO Financing Interest Sub Type, super type is INTERESTS
PAYMENT - Payment Interests Sub Type, super type is INTERESTS
ACCOUNT_MIGRATION - Account Migration Sub Type, super type is JOURNAL
IPO_REFUND - IPO Refund Sub Type, super type is JOURNAL
JOURNAL_BETWEEN_TYPES - Journal Between Types Sub Type, super type is JOURNAL
GIFTING - Gifting Sub Type, super type is JOURNAL
BANK_TRANSFER - Bank Transfer Sub Type, super type is JOURNAL
FX_EXCHANGE - FX Exchange Sub Type, super type is JOURNAL
CA_BREAK_RESOLVING - CA Break Resolving Sub Type, super type is JOURNAL
MARK_TO_MARKET - Mark To Market Sub Type, super type is JOURNAL
INV_DEPOSIT - INV Deposit Sub Type, super type is JOURNAL
IPO_SUBSCRIPTION - IPO Subscription Sub Type, super type is JOURNAL
FIXED_INCOME_SPREAD - Fixed Income Spread Sub Type, super type is JOURNAL
HK_CBBC_EXERCISE - HK CBBC Exercise Sub Type, super type is OPTION_EA
HK_CBBC_EXPIRATION - HK CBBC Expiration Sub Type, super type is OPTION_EA
HK_WARRANT_EXERCISE - HK Warrant Exercise Sub Type, super type is OPTION_EA
OPTION_EXERCISE - Option Exercise Sub Type, super type is OPTION_EA or TRADE
HK_INLINE_WARRANT_EXERCISE - HK Inline Warrant Exercise Sub Type, super type is OPTION_EA
OPTION_ASSIGNMENT - Option Assignment Sub Type, super type is OPTION_EA or TRADE
MERGER - Merger Sub Type, super type is REORGANIZATION
RIGHT_SUBSCRIPTION - Right Subscription Sub Type, super type is REORGANIZATION
CORP_ACTION_FEE - Corp Action Fee Sub Type, super type is REORGANIZATION
LIQUIDATION - Liquidation Sub Type, super type is REORGANIZATION
REDEMPTION - Redemption Sub Type, super type is REORGANIZATION
REPURCHASE - Repurchase Sub Type, super type is REORGANIZATION
FEE - Subscribe Fee Sub Type, super type is SUBSCRIBE
FEE_RETURN - Subscribe Fee Return Sub Type, super type is SUBSCRIBE
INTERNAL_TRANSFER - Internal Transfer Sub Type, super type is TRANSFER
DTC_OUT - DTC Out Sub Type, super type is TRANSFER
WIRE_FEE_LOCAL - Wire Fee Local Sub Type, super type is WITHDRAW
OPTION_TRADE - Option Trade Sub Type, super type is TRADE
FUND_TRADE - Fund Trade Sub Type, super type is TRADE
OTHER - Other",
"example": "NOT_SET",
"enum": [
"NOT_SET",
"CASH_ADJUSTMENT",
"WIRE",
"TAX_WITHHOLD",
"COLLECTION_FEE",
"INCOME",
"PAYMENT_IN_LIEU",
"SCRIP_FEE",
"US_TAX_WITHHOLDING",
"CA_HANDLING_FEE",
"FOREIGN_TAX_WITHHELD",
"CASH_IN_LIEU",
"ADJUSTMENT",
"ADR",
"IPO_SUBSCRIPTION_FEE",
"TRANSACTION_FEES",
"CCASS_SETTLEMENT_FEE",
"JOURNAL_BETWEEN_ACCOUNTS",
"CUSTODIAN_FEE",
"SETTLEMENT_FEES",
"TRANSFER_FOP",
"FTT",
"COMMISSION",
"SYSTEM_FEE",
"CORRESPONDENT_BILLING",
"CUSTODY_FEE",
"STOCK_BORROW_INTEREST",
"DEBIT_CASH",
"IPO_FINANCING",
"PAYMENT",
"ACCOUNT_MIGRATION",
"IPO_REFUND",
"JOURNAL_BETWEEN_TYPES",
"GIFTING",
"BANK_TRANSFER",
"FX_EXCHANGE",
"CA_BREAK_RESOLVING",
"MARK_TO_MARKET",
"INV_DEPOSIT",
"IPO_SUBSCRIPTION",
"FIXED_INCOME_SPREAD",
"HK_CBBC_EXERCISE",
"HK_CBBC_EXPIRATION",
"HK_WARRANT_EXERCISE",
"OPTION_EXERCISE",
"HK_INLINE_WARRANT_EXERCISE",
"OPTION_ASSIGNMENT",
"MERGER",
"RIGHT_SUBSCRIPTION",
"CORP_ACTION_FEE",
"LIQUIDATION",
"REDEMPTION",
"REPURCHASE",
"FEE",
"FEE_RETURN",
"INTERNAL_TRANSFER",
"DTC_OUT",
"WIRE_FEE_LOCAL",
"OPTION_TRADE",
"FUND_TRADE",
"OTHER"
]
},
"currency": {
"type": "string",
"description": "Currency
CNH - RMB
HKD - Hong Kong Dollar
USD - US Dollar",
"example": "USD",
"enum": [
"CNH",
"HKD",
"USD"
]
},
"market": {
"type": "string",
"description": "Market Code
HK - Hong Kong Market
US - US Market
CN - China Market",
"example": "US",
"enum": [
"HK",
"US",
"CN"
]
},
"symbol": {
"type": "string",
"description": "Activity Symbol",
"example": "AAPL"
},
"trade_date": {
"type": "string",
"description": "Accounting date of the transaction (trade date), format: yyyy-MM-dd",
"example": "2024-05-01"
},
"net_amount": {
"type": "string",
"description": "Net change amount of the transaction (positive for credit, negative for debit)",
"example": "1500.0"
},
"biz_time": {
"type": "string",
"description": "Business event time when the transaction occurred",
"example": "2024-05-01T10:15:30Z"
}
},
"description": "Activity Result",
"title": "ActivityResult"
}
},
"pagination_key": {
"type": "string",
"description": "Pagination key for next page. If absent, indicates this is the last page.",
"example": "eyJ2IjoxLCJsYXN0SWQiOiI5MTMyNDQ3NjkiLCJwYWdlSW===="
}
},
"description": "Paginated result with cursor-based pagination",
"title": "PaginatedResultVoActivityResult"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Insufficient permission"
}
}
}
}
}
},
"417": {
"description": "A business logic error triggered when the request cannot be processed due to domain-specific constraints.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "INVALID_PARAMETER"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Parameter error, phone"
}
}
}
}
}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "SYSTEM_ERROR"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Internal Server Error"
}
}
}
}
}
}
},
"postman": {
"name": "List Cash Activities",
"description": {
"content": "Retrieves account transaction activities records with details.",
"type": "text/plain"
},
"url": {
"path": [
"broker",
"activities",
"cash-activities",
"list"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "(Required) Provide the target account id",
"type": "text/plain"
},
"key": "account_id",
"value": ""
},
{
"disabled": false,
"description": {
"content": "Account activity types",
"type": "text/plain"
},
"key": "activity_types",
"value": ""
},
{
"disabled": false,
"description": {
"content": "Activity query start time, formats: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"type": "text/plain"
},
"key": "start_time",
"value": ""
},
{
"disabled": false,
"description": {
"content": "Activity query end time, formats: yyyy-MM-dd'T'HH:mm:ss.SSSZ",
"type": "text/plain"
},
"key": "end_time",
"value": ""
},
{
"disabled": false,
"description": {
"content": "Pagination key from previous response for next page.",
"type": "text/plain"
},
"key": "pagination_key",
"value": ""
}
],
"variable": []
},
"header": [
{
"disabled": false,
"description": {
"content": "(Required) A unique identifier issued to a developer for accessing an application's API.",
"type": "text/plain"
},
"key": "x-app-key",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A unique key issued to developers to access the application's API.",
"type": "text/plain"
},
"key": "x-app-secret",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"type": "text/plain"
},
"key": "x-timestamp",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm version, default is 1.0.",
"type": "text/plain"
},
"key": "x-signature-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm, default is HMAC-SHA1.",
"type": "text/plain"
},
"key": "x-signature-algorithm",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature unique random number.",
"type": "text/plain"
},
"key": "x-signature-nonce",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) API interface version. Supported values: `v2`, `v3`.",
"type": "text/plain"
},
"key": "x-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"type": "text/plain"
},
"key": "x-signature",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET"
}
}
```