ChainFolioAI API

openapi: 3.1.0
info:
  title: ChainFolioAI API
  version: '2026-11-03'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-03: 25 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; ChainFolioAI has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 23
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-03'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://chainfolioai.com/developers
paths:
  /api/v1:
    get:
      operationId: get_api_v1
      tags:
      - Api
      summary: Índice de descoberta — lista os endpoints.
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1Response'
      x-evidence:
        kind: documentation
  /api/v1/btc-blocks:
    get:
      operationId: get_api_v1_btc_blocks
      tags:
      - Api
      summary: Blocos Bitcoin recentes (altura, nº de transações, taxa mediana, pool, timestamp) e taxas recomendadas da mempool.
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1BtcBlocksResponse'
      x-evidence:
        kind: documentation
  /api/v1/chat:
    post:
      operationId: post_api_v1_chat
      tags:
      - Api
      summary: POST /api/v1/chat
      x-source: https://chainfolioai.com/developers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ChatRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://chainfolioai.com/api/v1/chat  -H "Authorization: Bearer $CFA_KEY"  -H "Content-Type: application/json"  -d
          ''{"message":"Quanto vale o meu portefólio e como variou esta semana?"}'' Resposta Copiar { "reply": "Na última fotografia (hoje, 09:12)
          o portefólio «Principal» valia 12 340 €; em 7 dias variou +2,1 % (+254 €), sem contar o capital que entrou. O BTC está agora a … € (+1,3 '
  /api/v1/defi:
    get:
      operationId: get_api_v1_defi
      tags:
      - Api
      summary: 'Posições de lending lidas dos contratos: depositado, emprestado e líquido.'
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1DefiResponse'
      x-evidence:
        kind: documentation
  /api/v1/derivatives:
    get:
      operationId: get_api_v1_derivatives
      tags:
      - Api
      summary: 'Derivados de um símbolo: open interest, long/short, funding, CVD, taker, put/call e score.'
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: symbol
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1DerivativesResponse'
      x-evidence:
        kind: documentation
  /api/v1/fear-greed:
    get:
      operationId: get_api_v1_fear_greed
      tags:
      - Api
      summary: Índice Fear & Greed — valor atual (0–100) e últimos 8 dias.
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1FearGreedResponse'
      x-evidence:
        kind: documentation
  /api/v1/fire:
    get:
      operationId: get_api_v1_fire
      tags:
      - Api
      summary: Anos até à independência financeira (regra dos 4%).
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: monthlyExpenses
        in: query
        required: false
        schema:
          type: number
      - name: monthlyInvestment
        in: query
        required: false
        schema:
          type: number
      - name: annualReturn
        in: query
        required: false
        schema:
          type: number
      - name: inflation
        in: query
        required: false
        schema:
          type: number
      - name: currentAge
        in: query
        required: false
        schema:
          type: integer
      - name: currentPortfolio
        in: query
        required: false
        schema:
          type: number
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1FireResponse'
      x-evidence:
        kind: documentation
  /api/v1/global:
    get:
      operationId: get_api_v1_global
      tags:
      - Api
      summary: Capitalização total do mercado, variação 24 h e dominância BTC/ETH.
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1GlobalResponse'
      x-evidence:
        kind: documentation
  /api/v1/global/api/v1/global:
    get:
      operationId: get_api_v1_global_api_v1_global
      tags:
      - Api
      summary: GET /api/v1/global/api/v1/global
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -s https://chainfolioai.com/api/v1/global/api/v1/global · /api/v1/tax-countries · /api/v1 Autenticação Gera uma chave em
          Conta → API & MCP (só aparece uma vez). Envia-a no cabeçalho de cada pedido: Copiar Authorization: Bearer cfa_live_… Base: https://chainfolioai.com/api/v1
          Formato da chave: cfa_live_ + 40 hex · 60 /min Máximo de 5 chaves ativas por conta; revoga as antigas na Conta. Usa a A'
  /api/v1/known-whales:
    get:
      operationId: get_api_v1_known_whales
      tags:
      - Api
      summary: Baleias conhecidas pré-carregadas (exchanges, fundos, figuras públicas, governos).
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1KnownWhalesResponse'
      x-evidence:
        kind: documentation
  /api/v1/market:
    get:
      operationId: get_api_v1_market
      tags:
      - Api
      summary: Top criptoativos por capitalização.
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1MarketResponse'
      x-evidence:
        kind: documentation
  /api/v1/metrics:
    get:
      operationId: get_api_v1_metrics
      tags:
      - Api
      summary: 'Métricas do portefólio a partir do histórico: ROI, CAGR, Sharpe, volatilidade, quedas e VaR 95%.'
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1MetricsResponse'
      x-evidence:
        kind: documentation
  /api/v1/news:
    get:
      operationId: get_api_v1_news
      tags:
      - Api
      summary: Últimas notícias de cripto (CoinDesk, CoinTelegraph).
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1NewsResponse'
      x-evidence:
        kind: documentation
  /api/v1/nfts:
    get:
      operationId: get_api_v1_nfts
      tags:
      - Api
      summary: NFTs das carteiras EVM numa rede.
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: chain
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1NftsResponse'
      x-evidence:
        kind: documentation
  /api/v1/pnl:
    get:
      operationId: get_api_v1_pnl
      tags:
      - Api
      summary: 'Evolução do portefólio em euros: total atual e variação a 24 h, 7 d, 30 d e desde o início.'
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1PnlResponse'
      x-evidence:
        kind: documentation
  /api/v1/portfolio:
    get:
      operationId: get_api_v1_portfolio
      tags:
      - Api
      summary: 'Último snapshot do portefólio: saldos por rede, CEX, DeFi e ativos manuais (endereços pseudonimizados).'
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1PortfolioResponse'
      x-evidence:
        kind: documentation
  /api/v1/price:
    get:
      operationId: get_api_v1_price
      tags:
      - Api
      summary: Preço, capitalização, volume e variação (24h/7d) de um criptoativo pelo símbolo.
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: symbol
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1PriceResponse'
      x-evidence:
        kind: documentation
  /api/v1/price-on:
    get:
      operationId: get_api_v1_price_on
      tags:
      - Api
      summary: Preço de fecho de um ativo numa data (UTC).
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: symbol
        in: query
        required: false
        schema:
          type: string
      - name: date
        in: query
        required: false
        schema:
          type: string
        description: YYYY-MM-DD
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1PriceOnResponse'
      x-evidence:
        kind: documentation
  /api/v1/realized-gains:
    get:
      operationId: get_api_v1_realized_gains
      tags:
      - Api
      summary: 'Mais-valias realizadas (FIFO) em euros, com taxas e gás deduzidos: total, por ativo e por ano.'
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: year
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1RealizedGainsResponse'
      x-evidence:
        kind: documentation
  /api/v1/score:
    get:
      operationId: get_api_v1_score
      tags:
      - Api
      summary: Pontuação 0–100 do portefólio, tal como aparece na app.
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ScoreResponse'
      x-evidence:
        kind: documentation
  /api/v1/tax-countries:
    get:
      operationId: get_api_v1_tax_countries
      tags:
      - Api
      summary: Regimes fiscais publicados por país (taxas, prazo, isenção e lei).
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1TaxCountriesResponse'
      x-evidence:
        kind: documentation
  /api/v1/tax-estimate:
    get:
      operationId: get_api_v1_tax_estimate
      tags:
      - Api
      summary: Estimativa de imposto sobre mais-valias num país, na moeda desse país, com o método de custo do país e, onde a lei deixa, as perdas
        de anos anteriores.
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: country
        in: query
        required: false
        schema:
          type: string
      - name: year
        in: query
        required: false
        schema:
          type: integer
      - name: alternative
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1TaxEstimateResponse'
      x-evidence:
        kind: documentation
  /api/v1/trades:
    get:
      operationId: get_api_v1_trades
      tags:
      - Api
      summary: Transações registadas (compras, vendas e taxas), da mais recente para a mais antiga.
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: asset
        in: query
        required: false
        schema:
          type: string
      - name: year
        in: query
        required: false
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1TradesResponse'
      x-evidence:
        kind: documentation
  /api/v1/wallets:
    get:
      operationId: get_api_v1_wallets
      tags:
      - Api
      summary: Carteiras e endereços ligados à conta (pseudonimizados).
      x-source: https://chainfolioai.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1WalletsResponse'
      x-evidence:
        kind: documentation
  /api/v1/whales:
    get:
      operationId: get_api_v1_whales
      tags:
      - Api
      summary: Movimentos on-chain recentes dos endereços dados.
      x-source: https://chainfolioai.com/developers
      parameters:
      - name: watchlist
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1WhalesResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV1Response:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        documentation:
          type: string
        endpoints:
          type: array
    GetApiV1BtcBlocksResponse:
      type: object
      properties:
        blocks:
          type: array
        fees:
          type: object
        timestamp:
          type: integer
    PostApiV1ChatRequest:
      type: object
      properties:
        message:
          type: string
    GetApiV1DefiResponse:
      type: object
      properties:
        currency:
          type: string
        totalNetUsd:
          type: number
        totalSuppliedUsd:
          type: number
        totalBorrowedUsd:
          type: number
        wallets:
          type: array
        walletsRead:
          type: integer
        walletsSkipped:
          type: integer
    GetApiV1DerivativesResponse:
      type: object
      properties:
        symbol:
          type: string
        score:
          type: integer
        rsi:
          type: number
        components:
          type: object
    GetApiV1FearGreedResponse:
      type: object
      properties:
        now:
          type: object
        history:
          type: array
    GetApiV1FireResponse:
      type: object
      properties:
        fireTarget:
          type: number
        realReturnPct:
          type: number
        yearsToFire:
          type: integer
        retirementAge:
          type: integer
        retirementYear:
          type: integer
        note:
          type: string
    GetApiV1GlobalResponse:
      type: object
      properties:
        totalMarketCapUsd:
          type: number
        marketCapChange24h:
          type: number
        btcDominance:
          type: number
        ethDominance:
          type: number
        source:
          type: string
    GetApiV1KnownWhalesResponse:
      type: object
      properties:
        whales:
          type: array
        count:
          type: integer
    GetApiV1MarketResponse:
      type: object
      properties:
        coins:
          type: array
        count:
          type: integer
        source:
          type: string
        timestamp:
          type: integer
    GetApiV1MetricsResponse:
      type: object
      properties:
        currency:
          type: string
        metrics:
          type: object
    GetApiV1NewsResponse:
      type: object
      properties:
        news:
          type: array
        count:
          type: integer
    GetApiV1NftsResponse:
      type: object
      properties:
        chain:
          type: string
        totalNfts:
          type: integer
        wallets:
          type: array
    GetApiV1PnlResponse:
      type: object
      properties:
        currency:
          type: string
        totalEur:
          type: number
        updatedAt:
          type: string
        changes:
          type: array
        snapshotsUsed:
          type: integer
    GetApiV1PortfolioResponse:
      type: object
      properties:
        updatedAt:
          type: string
        snapshotCount:
          type: integer
        portfolio:
          type: object
    GetApiV1PriceResponse:
      type: object
      properties:
        symbol:
          type: string
        name:
          type: string
        priceUsd:
          type: number
        marketCap:
          type: number
        volume24h:
          type: number
        change24h:
          type: number
        change7d:
          type: number
        rank:
          type: integer
    GetApiV1PriceOnResponse:
      type: object
      properties:
        symbol:
          type: string
        date:
          type: string
        usd:
          type: number
    GetApiV1RealizedGainsResponse:
      type: object
      properties:
        currency:
          type: string
        method:
          type: string
        year:
          type: integer
        realizedPnlEur:
          type: number
        feesEur:
          type: number
        byAsset:
          type: array
        byYear:
          type: array
        unmatched:
          type: object
    GetApiV1ScoreResponse:
      type: object
      properties:
        score:
          type: integer
        max:
          type: integer
        asOf:
          type: string
        parts:
          type: array
    GetApiV1TaxCountriesResponse:
      type: object
      properties:
        total:
          type: integer
        countries:
          type: array
    GetApiV1TaxEstimateResponse:
      type: object
      properties:
        country:
          type: string
        currency:
          type: string
        costMethod:
          type: string
        assumptions:
          type: object
        rates:
          type: object
        sales:
          type: integer
        totalGain:
          type: number
        taxableGain:
          type: number
        exemptGain:
          type: number
        estimatedTax:
          type: number
    GetApiV1TradesResponse:
      type: object
      properties:
        total:
          type: integer
        returned:
          type: integer
        trades:
          type: array
    GetApiV1WalletsResponse:
      type: object
      properties:
        updatedAt:
          type: string
        accounts:
          type: array
        wallets:
          type: object
        note:
          type: string
    GetApiV1WhalesResponse:
      type: object
      properties:
        movements:
          type: array
        scanned:
          type: integer
        timestamp:
          type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api