# Wealthyhood API Docs

## Docs

- [Get access token](https://docs.wealthyhood.com/api-reference/auth/get-token.md): Obtain an access token using OAuth 2.0 client credentials flow. The token must be included in the `Authorization` header as `Bearer <token>` for all subsequent API requests.
- [Cancel automation](https://docs.wealthyhood.com/api-reference/automations/cancel-automation.md): Cancel an existing recurring investment or savings automation.
- [Create automation](https://docs.wealthyhood.com/api-reference/automations/create-automation.md): Create a new recurring investment or savings automation with automatic mandate management.
- [Get all automations](https://docs.wealthyhood.com/api-reference/automations/get-automations.md): Retrieve all recurring investment and savings automations for a user.
- [Create bank account](https://docs.wealthyhood.com/api-reference/bank-accounts/create-bank-account.md): Create a bank account for the authenticated user.
- [Get bank account by ID](https://docs.wealthyhood.com/api-reference/bank-accounts/get-bank-account-by-id.md): Retrieve a specific bank account by its identifier.
- [List bank accounts](https://docs.wealthyhood.com/api-reference/bank-accounts/get-bank-accounts.md): List all bank accounts for the authenticated user.
- [Get user cash balance](https://docs.wealthyhood.com/api-reference/cash/get-cash.md): Retrieve available cash balance across one or more currencies.
- [Get daily summaries](https://docs.wealthyhood.com/api-reference/daily-summaries/get-daily-summaries.md): Retrieve historical daily portfolio summaries with performance metrics and market insights.
- [Create deposit expectation](https://docs.wealthyhood.com/api-reference/deposits/create-deposit.md): Register an expected incoming bank transfer for a user bank account.
- [Get deposit by ID](https://docs.wealthyhood.com/api-reference/deposits/get-deposit-by-id.md): Retrieve a specific deposit by its identifier.
- [Get all deposits](https://docs.wealthyhood.com/api-reference/deposits/get-deposits.md): List all deposits for the authenticated user.
- [Future performance (template allocation)](https://docs.wealthyhood.com/api-reference/insights/future-performance.md): Expected future projection for a hypothetical portfolio defined by asset weights.
- [Future performance Monte Carlo](https://docs.wealthyhood.com/api-reference/insights/future-performance-monte-carlo.md): Better and worse scenario bands for future performance charts.
- [Past performance (template allocation)](https://docs.wealthyhood.com/api-reference/insights/past-performance.md): Historical performance chart and metrics for a hypothetical portfolio defined by asset weights.
- [Introduction](https://docs.wealthyhood.com/api-reference/introduction.md): Overview of the Wealthyhood API reference sections
- [Get investment product fundamentals](https://docs.wealthyhood.com/api-reference/investment-products/investment-product-by-isin.md): Return pricing, tags, and fundamentals for an investment product resolved by ISIN.
- [Get user investment details](https://docs.wealthyhood.com/api-reference/investment-products/investment-product-investment-details.md): Return portfolio-specific performance metrics for a user-held investment product.
- [Get recent asset activity](https://docs.wealthyhood.com/api-reference/investment-products/investment-product-recent-activity.md): Retrieve the latest orders and dividends tied to a user-held investment product.
- [Get all investment products](https://docs.wealthyhood.com/api-reference/investment-products/investment-products.md): Retrieve Wealthyhood investment products.
- [Get price history](https://docs.wealthyhood.com/api-reference/investment-products/price-history.md): Retrieve historical price data for an investment product organized by tenor periods.
- [Preview asset buy or sell](https://docs.wealthyhood.com/api-reference/investments/asset-preview.md): Get a preview of a single asset buy or sell transaction showing execution options, fees, and estimated orders
- [Cancel portfolio transaction](https://docs.wealthyhood.com/api-reference/investments/cancel-transaction.md): Cancel a pending portfolio asset transaction and all its associated orders
- [Execute portfolio buy order](https://docs.wealthyhood.com/api-reference/investments/portfolio-order.md): Execute a portfolio buy transaction that distributes the investment amount across multiple assets
- [Preview portfolio buy](https://docs.wealthyhood.com/api-reference/investments/portfolio-preview.md): Get a preview of a portfolio buy transaction showing execution options, fees, and estimated orders
- [Get analyst insight by ID](https://docs.wealthyhood.com/api-reference/learn/analyst-insight-by-id.md): Retrieve a single analyst insight entry by its Wealthyhood identifier.
- [Get all analyst insights](https://docs.wealthyhood.com/api-reference/learn/analyst-insights.md): Retrieve the Learn screen analyst insight feed.
- [Get all glossary entries](https://docs.wealthyhood.com/api-reference/learn/glossary.md): Return alphabetised Learn glossary items.
- [Get learning guide by ID](https://docs.wealthyhood.com/api-reference/learn/learning-guide-by-id.md): Resolve a learning guide via its Wealthyhood identifier.
- [Get all learning guides](https://docs.wealthyhood.com/api-reference/learn/learning-guides.md): Retrieve the learning guide catalogue for the Learn carousel.
- [Get all news articles](https://docs.wealthyhood.com/api-reference/learn/news.md): Fetch the latest Learn news articles with resized imagery.
- [Get news article by ID](https://docs.wealthyhood.com/api-reference/learn/news-by-id.md): Retrieve a single news article by its Wealthyhood identifier.
- [Get notification settings](https://docs.wealthyhood.com/api-reference/notification-settings/get-notification-settings.md): Retrieve all notification settings for a user, organized by category (app and email notifications).
- [Update notification setting](https://docs.wealthyhood.com/api-reference/notification-settings/update-notification-setting.md): Update a specific notification setting for a user by setting ID.
- [Cancel order](https://docs.wealthyhood.com/api-reference/order-execution/cancel-order.md): Cancel a pending order that has not been submitted to the broker
- [Generate trade confirmation](https://docs.wealthyhood.com/api-reference/order-execution/generate-trade-confirmation.md): Generate a trade confirmation PDF for a matched investment order
- [Get order by ID](https://docs.wealthyhood.com/api-reference/order-execution/get-order-by-id.md): Retrieve detailed information about a specific order
- [Get all orders](https://docs.wealthyhood.com/api-reference/order-execution/get-orders.md): Retrieve all orders for the authenticated user with optional filtering
- [Submit order](https://docs.wealthyhood.com/api-reference/order-execution/submit-order.md): Place a single buy or sell order for a portfolio and receive the resulting asset transaction.
- [Get portfolio holdings](https://docs.wealthyhood.com/api-reference/portfolio/get-holdings.md): Retrieve portfolio holdings (ISIN, asset, quantity) and target allocation (percentages per asset)
- [Get user portfolios](https://docs.wealthyhood.com/api-reference/portfolio/get-user-portfolios.md): Retrieve all portfolios for the authenticated user with holdings and target allocation.
- [Get portfolio with returns by tenor](https://docs.wealthyhood.com/api-reference/portfolio/get-with-returns-by-tenor.md): Retrieve portfolio holdings, target allocation, and performance metrics (returns and upBy values) across all time periods.
- [Update my portfolio allocation](https://docs.wealthyhood.com/api-reference/portfolio/post-me-allocation.md): Persist target allocation weights for the signed-in investor portfolio. The response matches GET portfolio by id, including the updated targetAllocation array.
- [Get portfolio prices by tenor](https://docs.wealthyhood.com/api-reference/portfolio/prices-by-tenor.md): Retrieve chart-ready price series for a portfolio across supported tenors.
- [Get savings product details](https://docs.wealthyhood.com/api-reference/savings-details/get-savings-details.md): Retrieve comprehensive details about the EUR Money Market Fund savings product.
- [Generate trade confirmation](https://docs.wealthyhood.com/api-reference/savings-orders/generate-trade-confirmation.md): Generate a trade confirmation PDF for a matched savings order
- [Get savings order by ID](https://docs.wealthyhood.com/api-reference/savings-orders/get-savings-order-by-id.md): Retrieve the latest status of a specific savings order.
- [Submit savings order](https://docs.wealthyhood.com/api-reference/savings-orders/submit-savings-order.md): Create a top up or withdrawal order for a user's savings plan.
- [Get user savings vault balance](https://docs.wealthyhood.com/api-reference/savings-vault/get-savings-vault.md): Retrieve EUR savings vault balance including unrealised interest.
- [Create test deposit](https://docs.wealthyhood.com/api-reference/test/create-deposit.md): Create a settled deposit transaction for a test user. Useful for simulating payments in sandbox environments.
- [Create test user](https://docs.wealthyhood.com/api-reference/test/create-user.md): Create a test user with a specific status and properties for sandbox testing.
- [Delete test user](https://docs.wealthyhood.com/api-reference/test/delete-user.md): Delete a test user by email address. Useful for cleaning up test data.
- [Get available statuses](https://docs.wealthyhood.com/api-reference/test/get-available-statuses.md): Retrieve a list of all available user statuses for test user creation.
- [Get cash activity](https://docs.wealthyhood.com/api-reference/transactions/get-cash-activity.md): Retrieve cash activity including deposits, withdrawals, investments, and dividends.
- [Get investment activity](https://docs.wealthyhood.com/api-reference/transactions/get-investment-activity.md): Retrieve investment activity including buy, sell, rebalance, and dividend transactions.
- [Get savings activity](https://docs.wealthyhood.com/api-reference/transactions/get-savings-activity.md): Retrieve savings activity for the default EUR MMF product.
- [Get universe configuration](https://docs.wealthyhood.com/api-reference/universe-config/get-universe-config.md): Retrieve the complete investment universe and discovery configuration
- [Create user](https://docs.wealthyhood.com/api-reference/users/create-user.md): Create a new user account with personal information, address, tax residency, nationality, and employment details.
- [Generate account statement](https://docs.wealthyhood.com/api-reference/users/generate-account-statement.md): Generate a PDF account statement for the user including investment, cash, and savings activity.
- [Get current user](https://docs.wealthyhood.com/api-reference/users/get-user.md): Retrieve the current authenticated user with complete profile information, portfolio, address, and tax residency details.
- [Update user address](https://docs.wealthyhood.com/api-reference/users/update-user-address.md): Update the physical address for a user account.
- [Update user email](https://docs.wealthyhood.com/api-reference/users/update-user-email.md): Update the email address for a user account.
- [Update user employment info](https://docs.wealthyhood.com/api-reference/users/update-user-employment-info.md): Update employment and source-of-wealth information for a user account.
- [Update user language](https://docs.wealthyhood.com/api-reference/users/update-user-language.md): Update the language preference for a user account.
- [Update user tax residency](https://docs.wealthyhood.com/api-reference/users/update-user-tax-residency.md): Update the tax residency information for a user account.
- [Get user wallet](https://docs.wealthyhood.com/api-reference/wallets/get-wallet.md): Retrieve the wallet assigned to a specific user.
- [Create withdrawal](https://docs.wealthyhood.com/api-reference/withdrawals/create-withdrawal.md): Create a withdrawal from a specified bank account.
- [Get withdrawal by ID](https://docs.wealthyhood.com/api-reference/withdrawals/get-withdrawal-by-id.md): Retrieve a specific withdrawal by its identifier.
- [Get all withdrawals](https://docs.wealthyhood.com/api-reference/withdrawals/get-withdrawals.md): List all withdrawals for the authenticated user.
- [Authentication](https://docs.wealthyhood.com/authentication.md): Learn how to authenticate with the Wealthyhood API using OAuth2 client credentials flow
- [Data Export](https://docs.wealthyhood.com/data-exports/data-export.md): Schema and integration guide for data exports
- [Environments](https://docs.wealthyhood.com/environments.md): Learn about Wealthyhood's sandbox and production API environments
- [Cash movement flow](https://docs.wealthyhood.com/flows/cash-movements.md): End-to-end guide for retrieving wallet details, linking a bank account, depositing funds, and withdrawing cash.
- [Investment universe flow](https://docs.wealthyhood.com/flows/investment-universe.md): How to combine universe configuration with investment products for complete asset data
- [Order execution flow](https://docs.wealthyhood.com/flows/order-execution.md): End-to-end steps to submit a trade using the Investment Orders API
- [Portfolio Quick Buy Flow](https://docs.wealthyhood.com/flows/portfolio-quick-buy.md): End-to-end steps to execute a quick portfolio buy transaction
- [Sandbox payments flow](https://docs.wealthyhood.com/flows/sandbox-payments.md): End-to-end guide for simulating deposits in sandbox environments. Create settled deposits for test users without waiting for actual bank transfers.
- [Savings order flow](https://docs.wealthyhood.com/flows/savings-orders.md): How to create savings top ups and withdrawals using the Savings Orders API
- [User builder flow](https://docs.wealthyhood.com/flows/user-builder.md): End-to-end guide for creating test users with specific statuses and properties in sandbox environments.
- [Introduction](https://docs.wealthyhood.com/index.md): Build powerful investment experiences with the Wealthyhood API platform
- [Quick start](https://docs.wealthyhood.com/quickstart.md): Get up and running with the Wealthyhood API in 5 easy steps
- [Asset Details](https://docs.wealthyhood.com/screens/asset-details.md): How to render an asset detail view: fundamentals, price charts, user metrics, recent activity
- [Autopilot](https://docs.wealthyhood.com/screens/autopilot.md): How to display and manage recurring investment automations
- [Discover Assets](https://docs.wealthyhood.com/screens/discover-assets.md): How to list investment products using the Investment Products API
- [Home screen](https://docs.wealthyhood.com/screens/home.md): How to build the Wealthyhood Home screen with daily portfolio summaries, performance metrics, and market insights
- [Investments screen](https://docs.wealthyhood.com/screens/investments.md): How to hydrate the Wealthyhood investments screen with portfolio prices and holdings data
- [Learn screen](https://docs.wealthyhood.com/screens/learn.md): How to render the Learn screen by fetching the Learn API endpoints

## OpenAPI Specs

- [openapi](https://docs.wealthyhood.com/api-reference/openapi.json)