# Yoshi API

> API documentation for the Yoshi consumer API. Access your financial accounts, transactions, investments, and more.

## Docs

- [Create brokerage account](https://docs.yoshi.ai/apex/create-account.md): Use POST /apex/accounts to open an Apex-backed brokerage account. Covers request body fields, sync and async responses, and error handling.
- [Get brokerage account creation status](https://docs.yoshi.ai/apex/get-account-status.md): Poll GET /apex/accounts/by-request/{request_id} to check brokerage account creation status. Returns ready, pending, or failed states.
- [Get balance history](https://docs.yoshi.ai/api-reference/accounts/get-balance-history.md): Get historical daily balance series for an account.
- [List accounts](https://docs.yoshi.ai/api-reference/accounts/list-accounts.md): List linked financial accounts with display metadata and public lifecycle status.
- [Get approval status](https://docs.yoshi.ai/api-reference/approvals/get-approval-status.md): Check the approval status of a pending action (Test Drive account creation, trade execution, etc.).
- [List goals](https://docs.yoshi.ai/api-reference/goals/list-goals.md): List financial goals with optional status filter.
- [Get income analysis](https://docs.yoshi.ai/api-reference/income/get-income-analysis.md): Get income analysis and distribution.
- [Get investment holdings](https://docs.yoshi.ai/api-reference/investments/get-investment-holdings.md): Get investment holdings grouped by asset class.
- [List recurring streams](https://docs.yoshi.ai/api-reference/recurring/list-recurring-streams.md): List recurring transaction streams (subscriptions, bills, income).
- [Get scores](https://docs.yoshi.ai/api-reference/scores/get-scores.md): Get the latest financial health scores.
- [Create Test Drive account](https://docs.yoshi.ai/api-reference/test-drive/create-test-drive-account.md): Create a Test Drive account. Requires user approval in the Yoshi web app before the account is created.
- [Execute trade](https://docs.yoshi.ai/api-reference/test-drive/execute-trade.md): Place a buy or sell trade. Requires user approval in the Yoshi web app before execution.
- [Get holdings](https://docs.yoshi.ai/api-reference/test-drive/get-holdings.md): Get current holdings/positions for a Test Drive account.
- [List Test Drive accounts](https://docs.yoshi.ai/api-reference/test-drive/list-test-drive-accounts.md): List Test Drive accounts with current balances for the user.
- [List trade history](https://docs.yoshi.ai/api-reference/test-drive/list-trade-history.md): List trade history for a Test Drive account with cursor-based pagination.
- [List transactions](https://docs.yoshi.ai/api-reference/transactions/list-transactions.md): Sync transactions for the authenticated user with cursor-based pagination and optional date backfill filters.
- [Get financial summary](https://docs.yoshi.ai/api-reference/user/get-financial-summary.md): Get a comprehensive financial summary including accounts, scores, and goals.
- [Get user profile](https://docs.yoshi.ai/api-reference/user/get-user-profile.md): Get the authenticated user profile (non-sensitive fields only).
- [API key authentication and key management](https://docs.yoshi.ai/authentication.md): Create and manage Yoshi API keys from your dashboard. Learn how to authenticate requests with Bearer tokens and rotate keys safely.
- [Changelog](https://docs.yoshi.ai/changelog.md): Chronological release notes for the Yoshi API, including new endpoints, breaking changes, deprecations, bug fixes, and SDK version updates.
- [Best practices for building with the Yoshi API](https://docs.yoshi.ai/concepts/best-practices.md): Patterns for error handling, retry strategies, caching, webhook processing, security, and rate limit budgeting when building on the Yoshi API.
- [Data freshness and sync model](https://docs.yoshi.ai/concepts/data-freshness.md): Understand when and how Yoshi syncs financial data from connected institutions, what the as_of timestamp means, and how to handle stale data gracefully.
- [Understanding your financial data](https://docs.yoshi.ai/concepts/data-models.md): Reference for Yoshi resources: accounts, transactions, scores, recurring streams, goals, income, and investments, plus key fields and relationships.
- [Idempotency for safe retries](https://docs.yoshi.ai/concepts/idempotency.md): Use the Idempotency-Key header to safely retry POST requests without creating duplicate trades, actions, or accounts when networks fail or time out.
- [Cursor-based pagination](https://docs.yoshi.ai/concepts/pagination.md): Navigate large result sets with cursor-based pagination. Learn how to iterate through all pages, handle concurrent changes, and avoid common pitfalls.
- [Local development](https://docs.yoshi.ai/development.md): Set up the Mintlify CLI to preview Yoshi API docs locally. Includes install steps, custom ports, link validation, and troubleshooting.
- [Error codes, response format, and handling](https://docs.yoshi.ai/errors.md): Reference for Yoshi API error codes, the standard error response envelope, and code examples for handling 401, 404, 429, and 500 errors.
- [Actions and approvals for safe financial operations](https://docs.yoshi.ai/guides/actions-approvals.md): Create, track, and approve actions that modify financial data. Understand the approval state machine and build approval workflows into your application.
- [Track card rewards and expiring benefits](https://docs.yoshi.ai/guides/card-rewards.md): Use the benefits endpoints to track credit card perks, monitor usage against period limits, and surface expiring benefits before value goes to waste.
- [CLI: manage your data from the terminal](https://docs.yoshi.ai/guides/cli.md): Install the Yoshi CLI and use it to list accounts, fetch transactions, check scores, and manage your financial data from the command line.
- [Build a personal finance dashboard with the Yoshi API](https://docs.yoshi.ai/guides/financial-dashboard.md): Fetch accounts, transactions, scores, and recurring data to build a personal finance dashboard. Includes caching strategies and webhook-driven updates.
- [MCP integration for AI assistants](https://docs.yoshi.ai/guides/mcp.md): Connect Yoshi's MCP server to Claude, ChatGPT, or other AI assistants to give them access to your financial data through natural language.
- [Paper trading: simulate trades with virtual portfolios](https://docs.yoshi.ai/guides/paper-trading.md): Create paper trading accounts, place simulated buy and sell orders, track holdings, and understand the action approval flow for safe financial operations.
- [Set up transaction alerts with webhooks](https://docs.yoshi.ai/guides/transaction-alerts.md): Register a webhook endpoint and filter transaction events by amount, category, or account to send Slack or email notifications for large or unusual purchases.
- [Troubleshooting and frequently asked questions](https://docs.yoshi.ai/guides/troubleshooting.md): Solutions and FAQs for common Yoshi API issues, including authentication errors, rate limiting, webhook delivery failures, and transaction data quirks.
- [SDK helpers for currency, idempotency, and conversions](https://docs.yoshi.ai/helpers.md): Use Yoshi SDK helper functions to format currency amounts, generate idempotency keys for POST requests, and convert between cents and dollars.
- [Yoshi API introduction and key concepts](https://docs.yoshi.ai/index.md): Get started with the Yoshi API to access financial accounts, transactions, investments, and scores. Includes base URL, auth, and pagination.
- [Quickstart: fetch accounts and transactions](https://docs.yoshi.ai/quickstart.md): Make your first Yoshi API call in under a minute. Fetch linked accounts and transactions in three steps with cursor-based pagination.
- [Rate limits, headers, and retry strategies](https://docs.yoshi.ai/rate-limits.md): Learn how Yoshi API rate limiting works, including the 100 requests-per-minute cap, response headers, 429 handling, and retry strategies.
- [TypeScript and Python SDK setup and usage](https://docs.yoshi.ai/sdks.md): Install and configure the official Yoshi SDKs for TypeScript and Python. Includes usage examples, configuration options, error handling, and auto-pagination.
- [Webhook delivery guarantees, retries, and idempotency](https://docs.yoshi.ai/webhooks/delivery.md): How Yoshi delivers webhooks with at-least-once semantics. Covers the retry schedule, event deduplication, ordering, and failure handling.
- [Webhook event types and payload reference](https://docs.yoshi.ai/webhooks/events.md): Complete list of Yoshi webhook event types with example payloads for accounts, transactions, balances, investments, scores, and income.
- [Manage webhook endpoints](https://docs.yoshi.ai/webhooks/management.md): Create, update, list, and delete webhook endpoints via the API. Configure event filters, rotate signing secrets, and manage endpoint lifecycle.
- [Webhooks for real-time financial data updates](https://docs.yoshi.ai/webhooks/overview.md): Receive real-time HTTP callbacks from Yoshi when financial data changes. Covers event structure, security headers, and the self-service portal.
- [Test and debug webhook integrations locally](https://docs.yoshi.ai/webhooks/testing.md): Test Yoshi webhook integrations locally with ngrok, send test events, inspect delivery logs, replay failed events, and debug common issues.
- [Webhook signature verification with HMAC-SHA256](https://docs.yoshi.ai/webhooks/verification.md): Verify Yoshi webhook authenticity with HMAC-SHA256 signatures. Includes SDK helpers, manual verification, and replay protection examples.

## OpenAPI Specs

- [openapi.documented](https://app.stainless.com/api/spec/documented/yoshi/openapi.documented.yml)