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

# List investments

> Returns the investments of a space, connected and manual, with the same holdings the Visor portfolio shows: a holding with a zero or negative balance is left out. `summary.total_value` adds the holdings that count toward net worth, converted to the display currency of the token's user. Requires the `pfm:read` scope.



## OpenAPI

````yaml /openapi.json get /v1/spaces/{space_id}/investments
openapi: 3.0.3
info:
  description: >-
    Personal REST API for Visor Pro and Premium users. Authenticate with a
    personal API token created in Visor Settings, sent as `Authorization: Bearer
    visor_pat_...`, or with an OAuth access token from the Visor CLI browser
    login.
  title: Visor Personal API
  version: 1.0.0
servers:
  - url: https://api.visorfinance.app
    variables: {}
security:
  - personal_api_token: []
  - visor_cli_oauth:
      - pfm:read
tags: []
paths:
  /v1/spaces/{space_id}/investments:
    get:
      tags:
        - Investments
      summary: List investments
      description: >-
        Returns the investments of a space, connected and manual, with the same
        holdings the Visor portfolio shows: a holding with a zero or negative
        balance is left out. `summary.total_value` adds the holdings that count
        toward net worth, converted to the display currency of the token's user.
        Requires the `pfm:read` scope.
      operationId: VisorWeb.Api.V1.InvestmentController.index
      parameters:
        - description: A space `id` from `GET /v1/spaces`
          in: path
          name: space_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - balance: '10450.32'
                    category: renda_fixa
                    contributes_to_net_worth: true
                    currency_code: BRL
                    id: 0b7f6d2e-8c1a-4f3b-9d5e-6a2c4b8e1f90
                    name: CDB Banco Inter 110% CDI
                    provider_name: Inter
                    source: connected
                    subtype: null
                    type: CDB
                    updated_at: '2026-10-19T08:15:00Z'
                summary:
                  count: 1
                  currency_code: BRL
                  total_value: '10450.32'
              schema:
                $ref: '#/components/schemas/InvestmentListResponse'
          description: Investments of the space
          headers:
            x-ratelimit-limit:
              description: Requests allowed for this token per minute
              schema:
                example: 60
                type: integer
              style: simple
            x-ratelimit-remaining:
              description: Requests left for this token in the current minute
              schema:
                example: 59
                type: integer
              style: simple
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '401':
          content:
            application/json:
              example:
                errors:
                  - code: INVALID_TOKEN
                    details: {}
                    message: The personal API token is not valid.
                    request_id: F8x2kQ9vXc1AAAAB
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Missing, invalid, expired, or revoked token
          headers:
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '403':
          content:
            application/json:
              example:
                errors:
                  - code: INSUFFICIENT_SCOPE
                    details:
                      required_scope: pfm:read
                    message: The personal API token does not grant this operation.
                    request_id: F8x2kQ9vXc1AAAAB
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Pro or Premium plan required, or insufficient scope
          headers:
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '404':
          content:
            application/json:
              example:
                errors:
                  - code: NOT_FOUND
                    details: {}
                    message: The resource does not exist.
                    request_id: F8x2kQ9vXc1AAAAB
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The space does not exist or the token's user cannot access it
          headers:
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The client does not accept JSON
          headers:
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '429':
          content:
            application/json:
              example:
                errors:
                  - code: RATE_LIMITED
                    details:
                      retry_after_seconds: 42
                    message: >-
                      Too many requests. Retry after the number of seconds in
                      Retry-After.
                    request_id: F8x2kQ9vXc1AAAAB
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Rate limit exceeded
          headers:
            retry-after:
              description: Seconds until the current window ends
              schema:
                example: 42
                type: integer
              style: simple
            x-ratelimit-limit:
              description: Requests allowed for this token per minute
              schema:
                example: 60
                type: integer
              style: simple
            x-ratelimit-remaining:
              description: Requests left for this token in the current minute
              schema:
                example: 59
                type: integer
              style: simple
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
      callbacks: {}
components:
  schemas:
    InvestmentListResponse:
      additionalProperties: false
      properties:
        data:
          items:
            $ref: '#/components/schemas/Investment'
          type: array
        summary:
          $ref: '#/components/schemas/InvestmentSummary'
      required:
        - data
        - summary
      title: InvestmentListResponse
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        errors:
          items:
            $ref: '#/components/schemas/Error'
          minItems: 1
          type: array
      required:
        - errors
      title: ErrorResponse
      type: object
    Investment:
      additionalProperties: false
      properties:
        balance:
          description: Current value in `currency_code`, as a decimal string
          example: '10450.32'
          format: decimal
          type: string
        category:
          description: >-
            The portfolio group Visor puts the investment in, such as
            `renda_fixa` or `fundos`
          example: renda_fixa
          type: string
        contributes_to_net_worth:
          description: >-
            False when the user left the investment out of net worth and of
            `summary.total_value`
          type: boolean
        currency_code:
          description: ISO 4217 code of `balance`
          example: BRL
          type: string
        id:
          format: uuid
          type: string
        name:
          type: string
        provider_name:
          description: The institution that holds the investment; null when unknown
          nullable: true
          type: string
        source:
          description: >-
            `connected` for a holding that syncs from Open Finance or B3;
            `manual` for one the user created
          enum:
            - connected
            - manual
          type: string
        subtype:
          description: The provider subtype, such as `STOCK`
          nullable: true
          type: string
        type:
          description: >-
            The investment type as the provider or the user set it, such as
            `CDB`, `ETF`, or `EQUITY`
          example: CDB
          nullable: true
          type: string
        updated_at:
          description: When Visor last changed the record, in ISO 8601 UTC
          format: date-time
          type: string
      required:
        - id
        - name
        - type
        - subtype
        - category
        - source
        - balance
        - currency_code
        - provider_name
        - contributes_to_net_worth
        - updated_at
      title: Investment
      type: object
    InvestmentSummary:
      additionalProperties: false
      properties:
        count:
          description: The number of investments in `data`
          type: integer
        currency_code:
          description: The display currency of the token's user, as an ISO 4217 code
          example: BRL
          type: string
        total_value:
          description: >-
            Sum of the investments with `contributes_to_net_worth` true,
            converted to `currency_code` with the latest exchange rate
          example: '10450.32'
          format: decimal
          type: string
      required:
        - total_value
        - currency_code
        - count
      title: InvestmentSummary
      type: object
    Error:
      additionalProperties: false
      properties:
        code:
          description: Stable machine-readable code
          example: INVALID_TOKEN
          type: string
        details:
          additionalProperties: true
          description: Code-specific context
          type: object
        message:
          description: English text for developers
          type: string
        request_id:
          description: The x-request-id response header of the request
          nullable: true
          type: string
      required:
        - code
        - message
        - details
        - request_id
      title: Error
      type: object
  securitySchemes:
    personal_api_token:
      bearerFormat: visor_pat_<public_id>_<secret>
      description: Personal API token created in Visor Settings
      scheme: bearer
      type: http
    visor_cli_oauth:
      description: >-
        OAuth 2.0 access token of the Visor CLI browser login (authorization
        code with PKCE). Only the first-party Visor CLI client can use it on
        this API.
      flows:
        authorizationCode:
          authorizationUrl: https://dashboard.visorfinance.app/oauth/authorize
          refreshUrl: https://dashboard.visorfinance.app/oauth/token
          scopes:
            pfm:read: Read financial data
            pfm:transactions:write: Create, edit, and delete transactions
            pix:payments:write: Start Pix payments that you confirm with biometrics at your bank
          tokenUrl: https://dashboard.visorfinance.app/oauth/token
      type: oauth2

````

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