@databolsa/sdk 1.0.4 → 1.0.6

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, Query, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
+import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, DocumentSearchResponse, PortfolioResponse, Query, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
 /** Filtros do screener de ações — derivados de `GET /v1/screener/stocks`. */
 export type ScreenStocksParams = Query<"screenStocks">;
 /**
@@ -187,6 +187,18 @@ export interface DataBolsaClient {
     search(q: string, params?: {
         limit?: number;
     }): Promise<SearchResult[]>;
+    /**
+     * Sua carteira consolidada: patrimônio, posições, preço médio, P&L, alocação.
+     * Escopada ao dono da chave de API (a mesma da conta) — passe sua chave por usuário.
+     */
+    getPortfolio(): Promise<PortfolioResponse>;
+    /** Seu perfil de investidor (suitability). `profile` é nulo se ainda não definido. */
+    getSuitability(): Promise<SuitabilityResponse>;
+    /**
+     * Busca semântica no texto de documentos CVM/B3 (fatos relevantes, releases,
+     * balanços, relatórios de FII, atas). Filtre por papel/categoria/ano quando souber.
+     */
+    searchDocuments(q: string, params?: SearchDocumentsParams): Promise<DocumentSearchResponse>;
 }
 export declare class NotInPreviewError extends Error {
     readonly entity: string;

package/dist/http-client.d.ts

@@ -1,5 +1,5 @@
 import { type DataBolsaClient, type LiveQuotesParams, type ScreenFiisParams, type ScreenFundsParams, type ScreenStocksParams } from "./client";
-import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
+import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentSearchResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, PortfolioResponse, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
 /**
  * Cliente HTTP da Serving API do DataBolsa. Os métodos públicos espelham os
  * operationIds do OpenAPI e retornam tipos gerados.
@@ -161,4 +161,7 @@ export declare class HttpClient implements DataBolsaClient {
     search(q: string, params?: {
         limit?: number;
     }): Promise<SearchResult[]>;
+    getPortfolio(): Promise<PortfolioResponse>;
+    getSuitability(): Promise<SuitabilityResponse>;
+    searchDocuments(q: string, params?: SearchDocumentsParams): Promise<DocumentSearchResponse>;
 }

package/dist/index.js

@@ -356,6 +356,22 @@ class HttpClient {
   search(q, params) {
     return this.request("/search", { q, limit: params?.limit });
   }
+  getPortfolio() {
+    return this.request("/portfolio");
+  }
+  getSuitability() {
+    return this.request("/suitability");
+  }
+  searchDocuments(q, params) {
+    return this.request("/documents/search", {
+      q,
+      tickers: Array.isArray(params?.tickers) ? params?.tickers.join(",") : params?.tickers,
+      category: params?.category,
+      year: params?.year,
+      tables_only: params?.tablesOnly === true ? "true" : undefined,
+      limit: params?.limit
+    });
+  }
 }
 function enc(segment) {
   return encodeURIComponent(segment);

package/dist/schema.d.ts

@@ -947,6 +947,66 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/portfolio": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Sua carteira (consolidada)
+         * @description Retorna a carteira consolidada do dono da chave de API: patrimônio, total investido, P&L realizado e não-realizado, variação do dia, composição por classe, maiores posições e quebra por carteira. Exige uma chave de API por usuário (crie em https://databolsa.com/conta).
+         */
+        get: operations["getPortfolio"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/suitability": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Seu perfil de investidor
+         * @description Retorna o perfil de investidor (suitability) do dono da chave: nível (Conservador/Moderado/Arrojado), a posição na régua 0–100 (não é uma nota) e as respostas do questionário. `profile` é nulo se o usuário ainda não definiu o perfil.
+         */
+        get: operations["getSuitability"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/documents/search": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Busca semântica em documentos
+         * @description Busca semântica no TEXTO de documentos CVM/B3 (fatos relevantes, releases de resultado, balanços, relatórios gerenciais de FII, atas de assembleia). Ideal para perguntas qualitativas que os dados estruturados não respondem. Filtre por papel, categoria e ano quando souber.
+         */
+        get: operations["searchDocuments"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -1245,6 +1305,15 @@ export interface components {
             sell_rate: number | null;
             buy_price: number | null;
             sell_price: number | null;
+            is_negotiable: boolean | null;
+            /** @enum {string|null} */
+            coupon: "unique" | "semiannual" | "monthly" | null;
+            min_investment: number | null;
+            live_buy_rate: number | null;
+            live_sell_rate: number | null;
+            live_buy_price: number | null;
+            live_sell_price: number | null;
+            priced_at: string | null;
         };
         IndexMeta: {
             code: string;
@@ -1521,6 +1590,72 @@ export interface components {
             rows: number;
             duration_s: number | null;
         };
+        PortfolioHolding: {
+            symbol: string;
+            assetType: string;
+            qty: number;
+            weightPct?: number | null;
+            marketValue?: number | null;
+            unrealizedPct?: number | null;
+        };
+        PortfolioByCarteira: {
+            name: string;
+            patrimonio: number;
+            unrealizedPct: number;
+            assets: number;
+        };
+        /** @description Carteira consolidada do usuário (mesmo resumo que o agente de IA usa). */
+        PortfolioContext: {
+            hasPortfolio: boolean;
+            carteiras: number;
+            patrimonio: number;
+            invested: number;
+            unrealizedPL: number;
+            unrealizedPct: number;
+            realizedPL: number;
+            dayChangeBrl: number;
+            kindMix: string;
+            anyUnpriced: boolean;
+            topHoldings: components["schemas"]["PortfolioHolding"][];
+            byCarteira: components["schemas"]["PortfolioByCarteira"][];
+        };
+        SuitabilityProfile: {
+            /** @enum {string} */
+            level: "Conservador" | "Moderado" | "Arrojado";
+            /** @description Posição na régua 0–100 (Conservador→Arrojado), não uma nota. */
+            score: number;
+            answers: {
+                q: string;
+                a: string;
+            }[];
+            updatedAt: string;
+        };
+        SuitabilityEnvelope: {
+            profile: components["schemas"]["SuitabilityProfile"] | null;
+        };
+        DocumentChunk: {
+            text: string;
+            /** @description Entorno costurado (context-expansion), quando disponível. */
+            text_expanded?: string;
+            ticker?: string | null;
+            company_name?: string | null;
+            doc_category?: string | null;
+            doc_type?: string | null;
+            reference_date?: string | null;
+            page_start?: number | null;
+            download_url?: string | null;
+            heading_path?: string | null;
+            is_table?: boolean | null;
+            /** @description Similaridade (1 - distância cosseno). */
+            score?: number;
+        };
+        DocumentSearchResponse: {
+            query: string;
+            count: number;
+            chunks: components["schemas"]["DocumentChunk"][];
+            /** @description Bloco pronto p/ prompt, com citação por trecho. */
+            context: string;
+        };
     };
     responses: never;
     parameters: never;
@@ -3523,4 +3658,104 @@ export interface operations {
             };
         };
     };
+    getPortfolio: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Carteira consolidada do usuário. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PortfolioContext"];
+                };
+            };
+            /** @description Erro (RFC 9457 application/problem+json) */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": Record<string, never>;
+                };
+            };
+        };
+    };
+    getSuitability: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Perfil de investidor do usuário (ou nulo). */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuitabilityEnvelope"];
+                };
+            };
+            /** @description Erro (RFC 9457 application/problem+json) */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": Record<string, never>;
+                };
+            };
+        };
+    };
+    searchDocuments: {
+        parameters: {
+            query: {
+                /** @description Termo/pergunta em linguagem natural. */
+                q: string;
+                /** @description Filtra por papéis (CSV), ex.: PETR4,PRIO3. */
+                tickers?: string;
+                /** @description Categoria do documento, ex.: Fato Relevante. */
+                category?: string;
+                /** @description Ano de referência do documento (AAAA). */
+                year?: number;
+                /** @description Restringe a trechos de tabela (fatos numéricos). */
+                tables_only?: boolean;
+                /** @description Máximo de trechos (1–25, default 8). */
+                limit?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Trechos relevantes + bloco de contexto com citação. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DocumentSearchResponse"];
+                };
+            };
+            /** @description Erro (RFC 9457 application/problem+json) */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": Record<string, never>;
+                };
+            };
+        };
+    };
 }

package/dist/types.d.ts

@@ -59,6 +59,10 @@ export type InvestorFlowMonthly = Schemas["InvestorFlowMonthly"];
 export type PublicOffering = Schemas["PublicOffering"];
 export type LiveQuote = Schemas["LiveQuote"];
 export type IntradayPoint = Schemas["IntradayPoint"];
+export type PortfolioContext = Schemas["PortfolioContext"];
+export type PortfolioHolding = Schemas["PortfolioHolding"];
+export type SuitabilityProfile = Schemas["SuitabilityProfile"];
+export type DocumentChunk = Schemas["DocumentChunk"];
 export type HealthResponse = Ok<"getHealth">;
 export type IngestHealthResponse = Ok<"getIngestHealth">;
 export type ScreenStocksResponse = Ok<"screenStocks">;
@@ -99,6 +103,22 @@ export type InvestorFlowMonthlyResponse = Ok<"listInvestorFlowMonthly">;
 export type OfferingsResponse = Ok<"listOfferings">;
 export type LiveQuotesResponse = Ok<"getLiveQuotes">;
 export type IntradaySeriesResponse = Ok<"getStockIntraday">;
+export type PortfolioResponse = Ok<"getPortfolio">;
+export type SuitabilityResponse = Ok<"getSuitability">;
+export type DocumentSearchResponse = Ok<"searchDocuments">;
+/** Filtros da busca semântica de documentos — `GET /v1/documents/search`. */
+export interface SearchDocumentsParams {
+    /** Papéis a filtrar; array serializado em CSV pelo HttpClient. */
+    tickers?: string[] | string;
+    /** Categoria do documento, ex.: "Fato Relevante". */
+    category?: string;
+    /** Ano de referência (AAAA). */
+    year?: number;
+    /** Restringe a trechos de tabela (fatos numéricos). */
+    tablesOnly?: boolean;
+    /** Máximo de trechos (1–25, default 8). */
+    limit?: number;
+}
 /**
  * Agrupamento client-side de `from`/`to` (datas ISO) — não é um schema do
  * contrato; os endpoints os recebem como query params soltos. Único tipo

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@databolsa/sdk",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "license": "Apache-2.0",
   "type": "module",
   "description": "SDK TypeScript tipado para a Serving API pública do DataBolsa, gerado a partir do contrato OpenAPI.",