> ## 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.

# Introdução

> Leia seus dados do Visor nos seus próprios scripts e automações.

A API pessoal do Visor permite que quem tem o **Visor Pro** ou o **Visor Premium** conecte seus próprios scripts, planilhas e automações aos seus dados financeiros. Você se autentica com um token pessoal que cria nas Configurações do Visor, e cada requisição tem as mesmas permissões que você tem no app.

## O que você já pode fazer

| Operação | Endpoint | Escopo |
| - | - | - |
| Listar os espaços que você acessa | [`GET /v1/spaces`](https://docs.visorfinance.app/api-reference/spaces/list-accessible-spaces) | `pfm:read` |
| Listar as contas de um espaço | [`GET /v1/spaces/{space_id}/accounts`](https://docs.visorfinance.app/api-reference/accounts/list-accounts) | `pfm:read` |
| Listar as categorias de um espaço | [`GET /v1/spaces/{space_id}/categories`](https://docs.visorfinance.app/api-reference/categories/list-categories) | `pfm:read` |
| Listar as tags de um espaço | [`GET /v1/spaces/{space_id}/tags`](https://docs.visorfinance.app/api-reference/tags/list-tags) | `pfm:read` |
| Listar transações, página por página | [`GET /v1/spaces/{space_id}/transactions`](https://docs.visorfinance.app/api-reference/transactions/list-transactions) | `pfm:read` |
| Ver uma transação | [`GET /v1/spaces/{space_id}/transactions/{transaction_id}`](https://docs.visorfinance.app/api-reference/transactions/get-a-transaction) | `pfm:read` |
| Ver a visão geral de um espaço | [`GET /v1/spaces/{space_id}/overview`](https://docs.visorfinance.app/api-reference/overview/get-the-financial-overview) | `pfm:read` |
| Listar os cartões de crédito de um espaço | [`GET /v1/spaces/{space_id}/cards`](https://docs.visorfinance.app/api-reference/cards/list-credit-cards) | `pfm:read` |
| Listar as faturas de um cartão | [`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` |
| Listar assinaturas | [`GET /v1/spaces/{space_id}/subscriptions`](https://docs.visorfinance.app/api-reference/recurring-expenses/list-subscriptions) | `pfm:read` |
| Listar contas fixas | [`GET /v1/spaces/{space_id}/fixed-bills`](https://docs.visorfinance.app/api-reference/recurring-expenses/list-fixed-bills) | `pfm:read` |
| Listar parcelamentos | [`GET /v1/spaces/{space_id}/installment-plans`](https://docs.visorfinance.app/api-reference/installments/list-installment-plans) | `pfm:read` |
| Listar metas | [`GET /v1/spaces/{space_id}/goals`](https://docs.visorfinance.app/api-reference/goals/list-goals) | `pfm:read` |
| Listar investimentos | [`GET /v1/spaces/{space_id}/investments`](https://docs.visorfinance.app/api-reference/investments/list-investments) | `pfm:read` |
| Listar conexões Open Finance | [`GET /v1/spaces/{space_id}/connections`](https://docs.visorfinance.app/api-reference/connections/list-open-finance-connections) | `pfm:read` |
| Ver seu perfil | [`GET /v1/me`](https://docs.visorfinance.app/api-reference/user/show-the-current-user) | `pfm:read` |
| Listar suas notificações, página por página | [`GET /v1/notifications`](https://docs.visorfinance.app/api-reference/notifications/list-notifications) | `pfm:read` |
| Registrar uma transação | [`POST /v1/spaces/{space_id}/transactions`](https://docs.visorfinance.app/api-reference/transactions/create-a-transaction) | `pfm:transactions:write` |
| Editar uma transação | [`PATCH /v1/spaces/{space_id}/transactions/{transaction_id}`](https://docs.visorfinance.app/api-reference/transactions/edit-a-transaction) | `pfm:transactions:write` |
| Excluir uma transação | [`DELETE /v1/spaces/{space_id}/transactions/{transaction_id}`](https://docs.visorfinance.app/api-reference/transactions/delete-a-transaction) | `pfm:transactions:write` |

Novas operações entram aqui quando forem lançadas. A documentação mostra só o que já está disponível.

> [!NOTE]
>
> Os guias estão em português. A referência da API, com os campos e os códigos de cada operação, está em inglês.

## URL base

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

Todas as requisições e respostas usam JSON sobre HTTPS.

## Quem pode usar

* Você precisa de um plano **Pro** ou **Premium** ativo. Período de teste, período de carência e acesso patrocinado por um escritório de assessoria também valem.
* A API pessoal está sendo liberada aos poucos. Se o card **API pessoal** não aparece em [Configurações > Apps Conectados](https://dashboard.visorfinance.app/settings/connected_apps), ela ainda não está disponível para a sua conta.

> [card] [Primeiros passos](https://docs.visorfinance.app/pt-BR/quickstart.md)
>
> Crie um token e faça sua primeira requisição em poucos minutos.

> [card] [Espaços e dados de referência](https://docs.visorfinance.app/pt-BR/reference-data.md)
>
> Encontre os IDs dos seus espaços, contas, categorias e tags.

> [card] [Transações](https://docs.visorfinance.app/pt-BR/transactions.md)
>
> Exporte seu histórico, registre gastos e edite ou exclua transações.

## Linha de comando

Prefere o terminal? A [CLI `visor`](https://docs.visorfinance.app/pt-BR/cli) roda cada operação desta documentação sem você montar requisições HTTP, e se instala com `brew install visor-finance/tap/visor`.

## API pessoal ou MCP?

A API pessoal é para o código que você escreve e roda. Para conectar um assistente de IA, como Claude, ChatGPT, Codex ou Cursor, use o [servidor MCP do Visor](https://help.visorfinance.app/pt-BR/articles/1755006-como-conectar-ao-servidor-mcp-do-visor). O MCP entra com OAuth, está disponível no Pro e no Premium e não usa tokens da API pessoal.


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