@databolsa/sdk 1.0.2 → 1.0.4

package/README.md

@@ -3,6 +3,8 @@
 [![npm version](https://img.shields.io/npm/v/@databolsa/sdk?color=cb3837&logo=npm)](https://www.npmjs.com/package/@databolsa/sdk)
 [![license](https://img.shields.io/npm/l/@databolsa/sdk?color=2ea44f)](https://github.com/databolsahq/databolsa/blob/main/LICENSE)
 
+🌐 **[databolsa.com](https://databolsa.com)** — a plataforma ao vivo · [docs da API](https://databolsa.com/docs)
+
 SDK TypeScript tipado para a Serving API pública do DataBolsa.
 
 O DataBolsa oferece infraestrutura aberta e reprodutível de dados para o mercado
@@ -90,7 +92,7 @@ npx -y @databolsa/mcp
 
 - OpenAPI: https://api.databolsa.com/openapi.json
 - Fontes e cobertura: https://github.com/databolsahq/databolsa/blob/main/docs/sources.md
-- Metodologia dos indicadores: https://github.com/databolsahq/databolsa/blob/main/docs/indicators.md
+- Metodologia dos indicadores: https://databolsa.com/metodologia
 - Limitações conhecidas: https://github.com/databolsahq/databolsa/blob/main/docs/limitations.md
 
 ## Licença

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentsResponse, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, MacroGearsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, Query, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, TesouroBondsResponse, 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, Query, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
 /** Filtros do screener de ações — derivados de `GET /v1/screener/stocks`. */
 export type ScreenStocksParams = Query<"screenStocks">;
 /**
@@ -9,6 +9,16 @@ export type ScreenStocksParams = Query<"screenStocks">;
 export type ScreenFiisParams = Omit<Query<"screenFiis">, "paper"> & {
     paper?: boolean;
 };
+/** Filtros do screener de fundos — derivados de `GET /v1/screener/funds`. */
+export type ScreenFundsParams = Query<"screenFunds">;
+/**
+ * Params do lote de cotações ao vivo — `GET /v1/quotes/live`, com uma ergonomia:
+ * `tickers` aceita `string[]` (o contrato pede CSV; o HttpClient serializa). Forneça
+ * exatamente um de `tickers` ou `index`.
+ */
+export type LiveQuotesParams = Omit<Query<"getLiveQuotes">, "tickers"> & {
+    tickers?: string[] | string;
+};
 /**
  * Interface do cliente DataBolsa — métodos = operationIds do api/openapi.yaml.
  * O SDK público implementa esta interface com HttpClient; apps podem envolver
@@ -36,6 +46,17 @@ export interface DataBolsaClient {
     }): Promise<DocumentsResponse>;
     /** PENDÊNCIA DE CONTRATO — ver lib/api/types.ts (InsiderMove) */
     listInsiderMoves(ticker: string, params?: RangeParams): Promise<InsiderResponse>;
+    /** Fundos de investimento que detêm o ativo (visão reversa do CDA/CVM), da competência mais recente por default. */
+    listFundHolders(ticker: string, params?: {
+        cursor?: string;
+        limit?: number;
+        date?: string;
+    }): Promise<FundHoldersResponse>;
+    /** VWAP oficial (TradAvrgPric) e nº de negócios por pregão, do consolidado B3. */
+    listTradeStats(ticker: string, params?: RangeParams & {
+        limit?: number;
+        cursor?: string;
+    }): Promise<TradeStatsResponse>;
     /** Lista o universo real de FIIs (não o preview). */
     screenFiis(params?: ScreenFiisParams): Promise<FiiScreenResponse>;
     getFii(ticker: string): Promise<Fii>;
@@ -46,11 +67,73 @@ export interface DataBolsaClient {
     getFiiIndicatorHistory(ticker: string, name: string, params?: RangeParams): Promise<IndicatorHistoryResponse>;
     listFiiDistributions(ticker: string, params?: RangeParams): Promise<FiiDistributionsResponse>;
     listFiiReports(ticker: string, params?: RangeParams): Promise<FiiReportsResponse>;
+    /** Catálogo de ETFs listados na B3. */
+    listEtfs(params?: {
+        cursor?: string;
+        limit?: number;
+        search?: string;
+        segment?: string;
+    }): Promise<EtfListResponse>;
+    getEtf(ticker: string): Promise<EtfProfile>;
+    /** Ranqueia o universo de fundos por patrimônio, retorno ou nº de cotistas. */
+    screenFunds(params?: ScreenFundsParams): Promise<FundScreenerResponse>;
+    /** Catálogo de fundos de investimento (CVM 175). */
+    listFunds(params?: {
+        cursor?: string;
+        limit?: number;
+        search?: string;
+        classificacao?: string;
+    }): Promise<FundListResponse>;
+    /** Perfil de um fundo pelo CNPJ da classe. */
+    getFund(cnpj: string): Promise<FundProfile>;
+    /** Série diária de cota/PL/fluxo de um fundo. */
+    listFundQuotes(cnpj: string, params?: RangeParams & {
+        limit?: number;
+        cursor?: string;
+    }): Promise<FundQuotesResponse>;
+    /** Carteira (holdings) de um fundo — BLC_4 do CDA, competência mais recente por default. */
+    listFundHoldings(cnpj: string, params?: {
+        cursor?: string;
+        limit?: number;
+        date?: string;
+    }): Promise<FundHoldingsResponse>;
+    /** Fluxo diário por perfil de investidor (participação na B3). */
+    listInvestorFlow(params?: RangeParams & {
+        limit?: number;
+        cursor?: string;
+        investor_type?: string;
+    }): Promise<InvestorFlowResponse>;
+    /** Fechamento mensal por perfil de investidor × segmento de mercado. */
+    listInvestorFlowMonthly(params?: {
+        cursor?: string;
+        limit?: number;
+        month?: string;
+        investor_type?: string;
+        segment?: string;
+    }): Promise<InvestorFlowMonthlyResponse>;
+    /** Ofertas públicas de distribuição (IPO/follow-on, debêntures, cotas de fundos). */
+    listOfferings(params?: RangeParams & {
+        cursor?: string;
+        limit?: number;
+        search?: string;
+        regime?: "ICVM_400_476" | "RCVM_160";
+        tipo_ativo?: string;
+    }): Promise<OfferingsResponse>;
     listIndices(): Promise<IndexMeta[]>;
     listIndexQuotes(code: string, params?: RangeParams & {
         limit?: number;
     }): Promise<IndexQuotesResponse>;
     getIndexComposition(code: string): Promise<IndexCompositionResponse>;
+    /** Série intradiária (delay 15 min) de um índice; default = sessão mais recente. */
+    getIndexIntraday(code: string, params?: {
+        session?: string;
+    }): Promise<IntradaySeriesResponse>;
+    /** Lote de cotações ao vivo por `tickers` (CSV/array, máx 200) OU `index` (constituintes). */
+    getLiveQuotes(params: LiveQuotesParams): Promise<LiveQuotesResponse>;
+    /** Série intradiária (delay 15 min) de uma ação; default = sessão mais recente. */
+    getStockIntraday(ticker: string, params?: {
+        session?: string;
+    }): Promise<IntradaySeriesResponse>;
     getSeries(source: string, seriesId: string, params?: RangeParams & {
         accumulated?: "none" | "12m" | "ytd";
     }): Promise<SeriesResponse>;

package/dist/http-client.d.ts

@@ -1,5 +1,5 @@
-import { type DataBolsaClient, type ScreenFiisParams, type ScreenStocksParams } from "./client";
-import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentsResponse, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, MacroGearsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, TesouroBondsResponse, YieldCurveResponse } from "./types";
+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";
 /**
  * Cliente HTTP da Serving API do DataBolsa. Os métodos públicos espelham os
  * operationIds do OpenAPI e retornam tipos gerados.
@@ -42,6 +42,15 @@ export declare class HttpClient implements DataBolsaClient {
         category?: string;
     }): Promise<DocumentsResponse>;
     listInsiderMoves(ticker: string, params?: RangeParams): Promise<InsiderResponse>;
+    listFundHolders(ticker: string, params?: {
+        cursor?: string;
+        limit?: number;
+        date?: string;
+    }): Promise<FundHoldersResponse>;
+    listTradeStats(ticker: string, params?: RangeParams & {
+        limit?: number;
+        cursor?: string;
+    }): Promise<TradeStatsResponse>;
     screenFiis(params?: ScreenFiisParams): Promise<FiiScreenResponse>;
     getFii(ticker: string): Promise<Fii>;
     getFiiIndicators(ticker: string, params?: {
@@ -50,11 +59,61 @@ export declare class HttpClient implements DataBolsaClient {
     getFiiIndicatorHistory(ticker: string, name: string, params?: RangeParams): Promise<IndicatorHistoryResponse>;
     listFiiDistributions(ticker: string, params?: RangeParams): Promise<FiiDistributionsResponse>;
     listFiiReports(ticker: string, params?: RangeParams): Promise<FiiReportsResponse>;
+    listEtfs(params?: {
+        cursor?: string;
+        limit?: number;
+        search?: string;
+        segment?: string;
+    }): Promise<EtfListResponse>;
+    getEtf(ticker: string): Promise<EtfProfile>;
+    screenFunds(params?: ScreenFundsParams): Promise<FundScreenerResponse>;
+    listFunds(params?: {
+        cursor?: string;
+        limit?: number;
+        search?: string;
+        classificacao?: string;
+    }): Promise<FundListResponse>;
+    getFund(cnpj: string): Promise<FundProfile>;
+    listFundQuotes(cnpj: string, params?: RangeParams & {
+        limit?: number;
+        cursor?: string;
+    }): Promise<FundQuotesResponse>;
+    listFundHoldings(cnpj: string, params?: {
+        cursor?: string;
+        limit?: number;
+        date?: string;
+    }): Promise<FundHoldingsResponse>;
+    listInvestorFlow(params?: RangeParams & {
+        limit?: number;
+        cursor?: string;
+        investor_type?: string;
+    }): Promise<InvestorFlowResponse>;
+    listInvestorFlowMonthly(params?: {
+        cursor?: string;
+        limit?: number;
+        month?: string;
+        investor_type?: string;
+        segment?: string;
+    }): Promise<InvestorFlowMonthlyResponse>;
+    listOfferings(params?: RangeParams & {
+        cursor?: string;
+        limit?: number;
+        search?: string;
+        regime?: "ICVM_400_476" | "RCVM_160";
+        tipo_ativo?: string;
+    }): Promise<OfferingsResponse>;
     listIndices(): Promise<IndexMeta[]>;
     listIndexQuotes(code: string, params?: RangeParams & {
         limit?: number;
     }): Promise<IndexQuotesResponse>;
     getIndexComposition(code: string): Promise<IndexCompositionResponse>;
+    getIndexIntraday(code: string, params?: {
+        session?: string;
+    }): Promise<IntradaySeriesResponse>;
+    getLiveQuotes(params: LiveQuotesParams): Promise<LiveQuotesResponse>;
+    getStockIntraday(ticker: string, params?: {
+        session?: string;
+    }): Promise<IntradaySeriesResponse>;
     getSeries(source: string, seriesId: string, params?: RangeParams & {
         accumulated?: "none" | "12m" | "ytd";
     }): Promise<SeriesResponse>;

package/dist/index.d.ts

@@ -9,6 +9,6 @@
 export { HttpClient, HttpClient as DataBolsa } from "./http-client";
 export type { HttpClientOptions } from "./http-client";
 export { NotInPreviewError } from "./client";
-export type { DataBolsaClient, ScreenStocksParams, ScreenFiisParams } from "./client";
+export type { DataBolsaClient, ScreenStocksParams, ScreenFiisParams, ScreenFundsParams } from "./client";
 export type * from "./types";
 export type { paths, components, operations } from "./schema";

package/dist/index.js

@@ -124,6 +124,21 @@ class HttpClient {
       to: params?.to
     });
   }
+  listFundHolders(ticker, params) {
+    return this.request(`/stocks/${enc(ticker)}/fund-holders`, {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      date: params?.date
+    });
+  }
+  listTradeStats(ticker, params) {
+    return this.request(`/stocks/${enc(ticker)}/trade-stats`, {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      from: params?.from,
+      to: params?.to
+    });
+  }
   screenFiis(params) {
     return this.request("/screener/fiis", {
       segment: params?.segment,
@@ -158,6 +173,82 @@ class HttpClient {
       to: params?.to
     });
   }
+  listEtfs(params) {
+    return this.request("/etfs", {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      search: params?.search,
+      segment: params?.segment
+    });
+  }
+  getEtf(ticker) {
+    return this.request(`/etfs/${enc(ticker)}`);
+  }
+  screenFunds(params) {
+    return this.request("/screener/funds", {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      classificacao: params?.classificacao,
+      min_net_worth: params?.min_net_worth,
+      sort: params?.sort,
+      order: params?.order
+    });
+  }
+  listFunds(params) {
+    return this.request("/funds", {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      search: params?.search,
+      classificacao: params?.classificacao
+    });
+  }
+  getFund(cnpj) {
+    return this.request(`/funds/${enc(cnpj)}`);
+  }
+  listFundQuotes(cnpj, params) {
+    return this.request(`/funds/${enc(cnpj)}/quotes`, {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      from: params?.from,
+      to: params?.to
+    });
+  }
+  listFundHoldings(cnpj, params) {
+    return this.request(`/funds/${enc(cnpj)}/holdings`, {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      date: params?.date
+    });
+  }
+  listInvestorFlow(params) {
+    return this.request("/market/investor-flow", {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      from: params?.from,
+      to: params?.to,
+      investor_type: params?.investor_type
+    });
+  }
+  listInvestorFlowMonthly(params) {
+    return this.request("/market/investor-flow/monthly", {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      month: params?.month,
+      investor_type: params?.investor_type,
+      segment: params?.segment
+    });
+  }
+  listOfferings(params) {
+    return this.request("/offerings", {
+      cursor: params?.cursor,
+      limit: params?.limit,
+      search: params?.search,
+      regime: params?.regime,
+      tipo_ativo: params?.tipo_ativo,
+      from: params?.from,
+      to: params?.to
+    });
+  }
   listIndices() {
     return this.request("/indices");
   }
@@ -171,6 +262,22 @@ class HttpClient {
   getIndexComposition(code) {
     return this.request(`/indices/${enc(code)}/composition`);
   }
+  getIndexIntraday(code, params) {
+    return this.request(`/indices/${enc(code)}/intraday`, {
+      session: params?.session
+    });
+  }
+  getLiveQuotes(params) {
+    return this.request("/quotes/live", {
+      tickers: Array.isArray(params.tickers) ? params.tickers.join(",") : params.tickers,
+      index: params.index
+    });
+  }
+  getStockIntraday(ticker, params) {
+    return this.request(`/stocks/${enc(ticker)}/intraday`, {
+      session: params?.session
+    });
+  }
   getSeries(source, seriesId, params) {
     return this.request(`/series/${enc(source)}/${enc(seriesId)}`, {
       from: params?.from,