> ## Documentation Index
> Fetch the complete documentation index at: https://docs.visorfinance.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Read your Visor data from your own scripts and automations.

The Visor Personal API lets a **Visor Pro** or **Visor Premium** user connect their own scripts, spreadsheets, and automations to their financial data. You authenticate with a personal API token that you create in Visor Settings, and every request runs with the same permissions you have in the app.

## What you can do today

| Operation | Endpoint | Scope |
| - | - | - |
| List the spaces you can access | [`GET /v1/spaces`](https://docs.visorfinance.app/api-reference/spaces/list-accessible-spaces) | `pfm:read` |
| List the accounts of a space | [`GET /v1/spaces/{space_id}/accounts`](https://docs.visorfinance.app/api-reference/accounts/list-accounts) | `pfm:read` |
| List the categories of a space | [`GET /v1/spaces/{space_id}/categories`](https://docs.visorfinance.app/api-reference/categories/list-categories) | `pfm:read` |
| List the tags of a space | [`GET /v1/spaces/{space_id}/tags`](https://docs.visorfinance.app/api-reference/tags/list-tags) | `pfm:read` |
| List transactions, page by page | [`GET /v1/spaces/{space_id}/transactions`](https://docs.visorfinance.app/api-reference/transactions/list-transactions) | `pfm:read` |
| Get one transaction | [`GET /v1/spaces/{space_id}/transactions/{transaction_id}`](https://docs.visorfinance.app/api-reference/transactions/get-a-transaction) | `pfm:read` |
| Get the financial overview of a space | [`GET /v1/spaces/{space_id}/overview`](https://docs.visorfinance.app/api-reference/overview/get-the-financial-overview) | `pfm:read` |
| List the credit cards of a space | [`GET /v1/spaces/{space_id}/cards`](https://docs.visorfinance.app/api-reference/cards/list-credit-cards) | `pfm:read` |
| List the bills of a credit card | [`GET /v1/spaces/{space_id}/cards/{card_id}/bills`](https://docs.visorfinance.app/api-reference/cards/list-the-bills-of-a-credit-card) | `pfm:read` |
| List subscriptions | [`GET /v1/spaces/{space_id}/subscriptions`](https://docs.visorfinance.app/api-reference/recurring-expenses/list-subscriptions) | `pfm:read` |
| List fixed bills | [`GET /v1/spaces/{space_id}/fixed-bills`](https://docs.visorfinance.app/api-reference/recurring-expenses/list-fixed-bills) | `pfm:read` |
| List installment plans | [`GET /v1/spaces/{space_id}/installment-plans`](https://docs.visorfinance.app/api-reference/installments/list-installment-plans) | `pfm:read` |
| List goals | [`GET /v1/spaces/{space_id}/goals`](https://docs.visorfinance.app/api-reference/goals/list-goals) | `pfm:read` |
| List investments | [`GET /v1/spaces/{space_id}/investments`](https://docs.visorfinance.app/api-reference/investments/list-investments) | `pfm:read` |
| List Open Finance connections | [`GET /v1/spaces/{space_id}/connections`](https://docs.visorfinance.app/api-reference/connections/list-open-finance-connections) | `pfm:read` |
| Show your profile | [`GET /v1/me`](https://docs.visorfinance.app/api-reference/user/show-the-current-user) | `pfm:read` |
| List your notifications, page by page | [`GET /v1/notifications`](https://docs.visorfinance.app/api-reference/notifications/list-notifications) | `pfm:read` |
| Record a transaction | [`POST /v1/spaces/{space_id}/transactions`](https://docs.visorfinance.app/api-reference/transactions/create-a-transaction) | `pfm:transactions:write` |
| Edit a transaction | [`PATCH /v1/spaces/{space_id}/transactions/{transaction_id}`](https://docs.visorfinance.app/api-reference/transactions/edit-a-transaction) | `pfm:transactions:write` |
| Delete a transaction | [`DELETE /v1/spaces/{space_id}/transactions/{transaction_id}`](https://docs.visorfinance.app/api-reference/transactions/delete-a-transaction) | `pfm:transactions:write` |

More operations ship as they are released. This reference documents only operations that are available now.

## Base URL

```text theme={null}
https://api.visorfinance.app
```

All requests and responses use JSON over HTTPS.

## Who can use it

* You need an active **Pro** or **Premium** plan. A trial, a grace period, and access sponsored by an advisory firm also qualify.
* The personal API is rolling out gradually. If you do not see the **Personal API** card in [Settings > Connected apps](https://dashboard.visorfinance.app/settings/connected_apps), it is not available for your account yet.

> [card] [Quickstart](https://docs.visorfinance.app/quickstart.md)
>
> Create a token and make your first request in a few minutes.

> [card] [Spaces and reference data](https://docs.visorfinance.app/reference-data.md)
>
> Find the IDs of your spaces, accounts, categories, and tags.

> [card] [Transactions](https://docs.visorfinance.app/transactions.md)
>
> Export your history, record expenses, and edit or delete transactions.

## Command-line interface

Prefer the terminal? The [`visor` CLI](https://docs.visorfinance.app/cli) runs every operation in this documentation without writing HTTP requests, and installs with `brew install visor-finance/tap/visor`.

## Personal API or MCP?

The personal API is for code you write and run yourself. To connect an AI assistant such as Claude, ChatGPT, Codex, or Cursor, use the [Visor MCP server](https://help.visorfinance.app/pt-BR/articles/1755006-como-conectar-ao-servidor-mcp-do-visor) instead. MCP signs in with OAuth and is available on Pro and Premium; it does not use personal API tokens.


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