# Portfobit Docs

> AI-native workspace for crypto portfolios.

- [Get Started](https://docs.portfobit.com/guides/get-started.md): Connect Portfobit to an AI agent and analyze your first portfolio.
- [Plugin or MCP Server Setup](https://docs.portfobit.com/guides/mcp-server-setup.md): Install the Portfobit plugin or connect the MCP server to your AI agent.
- [Codex](https://docs.portfobit.com/guides/mcp/codex.md): Connect Portfobit to Codex with browser-based OAuth.
- [Claude Code](https://docs.portfobit.com/guides/mcp/claude-code.md): Connect Portfobit to Claude Code with browser-based OAuth.
- [Cursor](https://docs.portfobit.com/guides/mcp/cursor.md): Connect Portfobit to Cursor with browser-based OAuth.
- [OpenClaw](https://docs.portfobit.com/guides/mcp/openclaw.md): Connect Portfobit to OpenClaw with browser-based OAuth.
- [Hermes](https://docs.portfobit.com/guides/mcp/hermes.md): Connect Portfobit to Hermes with browser-based OAuth.
- [Generic client](https://docs.portfobit.com/guides/mcp/generic-client.md): Connect an MCP client without OAuth support by using a scoped bearer token.
- [Claude Desktop](https://docs.portfobit.com/guides/mcp/claude-desktop.md): Current Portfobit MCP interoperability guidance for Claude Desktop.
- [Plans, Features, and Limits](https://docs.portfobit.com/guides/plans-and-limits.md): Compare Free and Plus, understand current quotas, and see which capabilities are not available yet.
- [Connect Your First Account](https://docs.portfobit.com/guides/connect-your-first-account.md): Use your AI agent to add a crypto CEX account.
- [Sync and Data Freshness](https://docs.portfobit.com/guides/sync-and-data-freshness.md): Understand automatic first syncs, manual refreshes, and sync limits.
- [Use Portfobit with AI](https://docs.portfobit.com/guides/use-portfobit-with-ai.md): Ask useful portfolio questions after your accounts are synchronized.
- [Security](https://docs.portfobit.com/guides/security.md): Use least privilege, provider IP allowlists, and safe secret handling.
- [Troubleshooting](https://docs.portfobit.com/guides/troubleshooting.md): Diagnose MCP configuration, authorization, provider credentials, and sync failures.
- [Overview](https://docs.portfobit.com/api-reference/overview.md): Build integrations with the Portfobit public REST API.
- [Authentication and scopes](https://docs.portfobit.com/api-reference/authentication-and-scopes.md): Authenticate public REST requests with a scoped Portfobit Open API key.
- [Create a Developer API Key](https://docs.portfobit.com/guides/create-api-key.md): Create a scoped Developer API key for direct API access and compatibility clients.
- [API conventions](https://docs.portfobit.com/api-reference/api-conventions.md): Understand Portfobit response envelopes, decimal values, pagination, and safe mutation retries.
- [Get the current authenticated-user context](https://docs.portfobit.com/api-reference/context/get-the-current-authenticated-user-context.md): Returns the current user, effective subscription projection, resource limits, credential type, and authorization scopes. Any valid Open API key can call this public endpoint. MCP OAuth may reach the same internal contract only through private, server-bound delegation; an MCP OAuth access token sent…
- [List service egress IP addresses](https://docs.portfobit.com/api-reference/accounts/list-service-egress-ip-addresses.md): Returns the platform IP addresses to allowlist at a connected CEX. No user data is returned.
- [List supported crypto CEX connectors](https://docs.portfobit.com/api-reference/accounts/list-supported-crypto-cex-connectors.md): Requires `account:read`. Only crypto CEX connectors are returned. `inspectable_permissions` identifies the CEX credential permissions for which the connector can obtain reliable provider evidence.
- [List CEX account connections](https://docs.portfobit.com/api-reference/accounts/list-cex-account-connections.md): Requires `account:read`.
- [Create a CEX account connection](https://docs.portfobit.com/api-reference/accounts/create-a-cex-account-connection.md): Requires `account:write` and `Idempotency-Key`. Credentials are encrypted and are never returned. `requested_permissions` is the user's declaration and execution switch; `withdraw` must be false. A declared permission that the connector cannot inspect remains unknown rather than denied, and the prov…
- [Start synchronization for all eligible accounts](https://docs.portfobit.com/api-reference/accounts/start-synchronization-for-all-eligible-accounts.md): Requires `account:write` and `Idempotency-Key`. Queues one `manual_batch` sync per eligible account; the daily manual-sync quota applies.
- [Get an account connection](https://docs.portfobit.com/api-reference/accounts/get-an-account-connection.md): Requires `account:read`.
- [Replace account tags](https://docs.portfobit.com/api-reference/accounts/replace-account-tags.md): Requires `account:write`. Only `tags` may be changed; name, credentials, permissions, and account deletion are Web-only safety flows.
- [Start synchronization for one account](https://docs.portfobit.com/api-reference/accounts/start-synchronization-for-one-account.md): Requires `account:write` and `Idempotency-Key`.
- [Get synchronization status](https://docs.portfobit.com/api-reference/accounts/get-synchronization-status.md): Requires `account:read`.
- [List account balances](https://docs.portfobit.com/api-reference/accounts/list-account-balances.md): Requires `account:read`. `debt` is a nullable decimal string populated only from the CCXT per-asset trading balance; non-trading locations return null. Internal provider data and raw exchange responses are never returned.
- [Get account equity and risk summary](https://docs.portfobit.com/api-reference/accounts/get-account-equity-and-risk-summary.md): Requires `account:read`. Risk-derived fields are grouped under `risk`.
- [List account positions](https://docs.portfobit.com/api-reference/accounts/list-account-positions.md): Requires `account:read`. Internal provider data and raw exchange responses are never returned.
- [List portfolios](https://docs.portfobit.com/api-reference/portfolios/list-portfolios.md): Requires `portfolio:read`; includes the system `global` portfolio when requested.
- [Create a portfolio](https://docs.portfobit.com/api-reference/portfolios/create-a-portfolio.md): Requires `portfolio:write` and `Idempotency-Key`.
- [Get a portfolio](https://docs.portfobit.com/api-reference/portfolios/get-a-portfolio.md): Requires `portfolio:read`. `global` is the current user's all-account view.
- [Delete a portfolio](https://docs.portfobit.com/api-reference/portfolios/delete-a-portfolio.md): Requires `portfolio:write` and `Idempotency-Key`. Deleting a portfolio never deletes accounts or assets.
- [Update a portfolio](https://docs.portfobit.com/api-reference/portfolios/update-a-portfolio.md): Requires `portfolio:write` and `Idempotency-Key`. `global` cannot be updated.
- [Bind an account to a portfolio](https://docs.portfobit.com/api-reference/portfolios/bind-an-account-to-a-portfolio.md): Requires `portfolio:write` and `Idempotency-Key`. `global` cannot be changed.
- [Unbind an account from a portfolio](https://docs.portfobit.com/api-reference/portfolios/unbind-an-account-from-a-portfolio.md): Requires `portfolio:write` and `Idempotency-Key`. `global` cannot be changed.
- [Get portfolio equity and risk summary](https://docs.portfobit.com/api-reference/portfolios/get-portfolio-equity-and-risk-summary.md): Requires `portfolio:read`. Aggregated monetary amounts use `base_currency`; risk fields are contained in `risk`.
- [List aggregated portfolio balances](https://docs.portfobit.com/api-reference/portfolios/list-aggregated-portfolio-balances.md): Requires `portfolio:read`.
- [List aggregated portfolio positions](https://docs.portfobit.com/api-reference/portfolios/list-aggregated-portfolio-positions.md): Requires `portfolio:read`. `mode` currently accepts `net` or `flat`; `both` is not implemented.
- [List daily account valuation history](https://docs.portfobit.com/api-reference/valuation/list-daily-account-valuation-history.md): Requires `account:read` and an active Plus or Pro subscription. Returns immutable UTC daily valuation/NAV snapshots using cursor pagination. This is not performance history and does not return P&L or returns.
- [List daily portfolio valuation history](https://docs.portfobit.com/api-reference/valuation/list-daily-portfolio-valuation-history.md): Requires `portfolio:read` and an active Plus or Pro subscription. Returns immutable UTC daily valuation/NAV snapshots using cursor pagination. This is not performance history and does not return P&L or returns.
- [List live open orders](https://docs.portfobit.com/api-reference/activity/list-live-open-orders.md): Requires `order:read`. Reads the connected CEX in real time, not local order history.
- [Get one live open order](https://docs.portfobit.com/api-reference/activity/get-one-live-open-order.md): Requires `order:read`. `venue_order_id` is the CEX ID, not a local `ord_*` history ID.
- [List local terminal order history](https://docs.portfobit.com/api-reference/activity/list-local-terminal-order-history.md): Requires `order:read` and an active Plus or Pro subscription. Uses cursor pagination and returns collection coverage metadata for the local 7-day continuous-collection window.
- [List fills and execution history](https://docs.portfobit.com/api-reference/activity/list-fills-and-execution-history.md): Requires `trade:read` and an active Plus or Pro subscription. Uses cursor pagination.
- [List ledger entries](https://docs.portfobit.com/api-reference/activity/list-ledger-entries.md): Requires `ledger:read` and an active Plus or Pro subscription. This is not a tax-grade PnL statement.
- [List CEX deposit, withdrawal, and visible transfer history](https://docs.portfobit.com/api-reference/activity/list-cex-deposit-withdrawal-and-visible-transfer-history.md): Requires `funding:read` and an active Plus or Pro subscription. It returns read-only, masked history from the unified Transaction resource; it never enables a transfer or withdrawal.
- [Start a bounded activity-history import](https://docs.portfobit.com/api-reference/activity/start-a-bounded-activity-history-import.md): Requires `activity:write`, an effective Plus or Pro subscription, `Idempotency-Key`, and the read scope matching `activity_type`. The default maximum range is 90 days. Each user and connected CEX credential has 168 daily work-units, measured as the requested range rounded up to hours. The request do…
- [Get an activity-history import](https://docs.portfobit.com/api-reference/activity/get-an-activity-history-import.md): Requires the read scope matching the import's activity type. A failed task can retain partial counts and successfully written activity facts; interrupted tasks do not resume automatically.
- [Cancel all live open orders for one market](https://docs.portfobit.com/api-reference/trading/cancel-all-live-open-orders-for-one-market.md): Requires `trade:write`, an active Plus or Pro subscription, `Idempotency-Key`, and `otp_code`. `symbol` is required; the server never cancels every market by default.
- [Cancel one live open order](https://docs.portfobit.com/api-reference/trading/cancel-one-live-open-order.md): Requires `trade:write`, an active Plus or Pro subscription, `Idempotency-Key`, and `otp_code`.
- [Natively amend one live order](https://docs.portfobit.com/api-reference/trading/natively-amend-one-live-order.md): Requires `trade:write`, an active Plus or Pro subscription, `Idempotency-Key`, and `otp_code`. Only available when the connector supports native CCXT `editOrder`; it never falls back to cancel-and-replace.
- [Place an order](https://docs.portfobit.com/api-reference/trading/place-an-order.md): Requires `trade:write`, an active Plus or Pro subscription, explicit user confirmation, `Idempotency-Key`, and a current `otp_code`.
- [Start an internal CEX transfer](https://docs.portfobit.com/api-reference/trading/start-an-internal-cex-transfer.md): Requires `transfer:write`, an active Plus or Pro subscription, explicit user confirmation, `Idempotency-Key`, and a current `otp_code`. The transfer is restricted to two account partitions of the same CEX account.
- [Get a CEX market quote](https://docs.portfobit.com/api-reference/market-data/get-a-cex-market-quote.md): Requires `marketdata:read`. Returns one raw normalized ticker from a CEX credential already connected by this user. It never reads a balance or position, uses the internal valuation price or cache, persists the quote, or falls back to another venue. An omitted `venue` selects one healthy connected C…
- [List bounded CEX OHLCV candles](https://docs.portfobit.com/api-reference/market-data/list-bounded-cex-ohlcv-candles.md): Requires `marketdata:read`. Returns a bounded raw OHLCV series from one CEX credential already connected by this user. It never reads a balance or position, uses an internal valuation price or cache, persists candles, retries across venues, or falls back to another venue. The accepted interval enum…
- [Submit a support problem](https://docs.portfobit.com/api-reference/support/submit-a-support-problem.md): Authentication is optional. Anonymous submissions must provide `email`; authenticated requests need no business scope.

## OpenAPI Specs

- [portfobit-openapi](/openapi/portfobit-openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.