@databolsa/sdk 1.0.1 → 1.0.3

package/README.md

@@ -1,5 +1,10 @@
 # @databolsa/sdk
 
+[![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

package/dist/schema.d.ts

@@ -61,7 +61,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Documentos e comunicados (IPE/CVM) */
+        /**
+         * Documentos e comunicados (IPE/CVM)
+         * @description Fatos relevantes, comunicados e documentos protocolados na CVM (IPE) da companhia (por código CVM). Filtre por `category` e por período (`from`/`to`); paginação por cursor.
+         */
         get: operations["listCompanyDocuments"];
         put?: never;
         post?: never;
@@ -200,7 +203,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Filtra ações por múltiplos critérios fundamentalistas */
+        /**
+         * Filtra ações por múltiplos critérios fundamentalistas
+         * @description Filtra o universo de ações por faixas de indicadores (pl_min/pl_max, pvp_min/pvp_max, dy_min, roe_min, ev_ebitda_max, div_liq_ebitda_max), setor e segmento; ordena por `sort`. Paginação por cursor (use meta.next_cursor). Retorna ticker, nome, setor e os indicadores principais por papel.
+         */
         get: operations["screenStocks"];
         put?: never;
         post?: never;
@@ -217,7 +223,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Universo de FIIs filtrável por segmento e tijolo/papel */
+        /**
+         * Universo de FIIs filtrável por segmento e tijolo/papel
+         * @description Lista o universo real de FIIs (mart_fii__profile), filtrável por segmento e por tijolo/papel; ordena por `sort`. Paginação por cursor (meta.next_cursor). Retorna ticker, nome, segmento e indicadores (dy, pvp, vacância…).
+         */
         get: operations["screenFiis"];
         put?: never;
         post?: never;
@@ -268,7 +277,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Expectativas Focus (consenso por indicador) */
+        /**
+         * Expectativas Focus (consenso por indicador)
+         * @description Consenso do Boletim Focus (BCB) para ipca, selic, pib ou cambio. Informe `reference` (ano) para uma série limpa; sem ele, mistura todos os anos de referência.
+         */
         get: operations["getMarketExpectations"];
         put?: never;
         post?: never;
@@ -319,7 +331,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Índices disponíveis (IBOV, IFIX, ...) */
+        /**
+         * Índices disponíveis (IBOV, IFIX, ...)
+         * @description Catálogo dos índices da B3 cobertos (IBOV, IFIX, IBXX/IBrX-100, SMLL, IDIV, ICON…) com código e nome.
+         */
         get: operations["listIndices"];
         put?: never;
         post?: never;
@@ -353,7 +368,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Composição teórica do índice (carteira) — dados ao vivo pendentes */
+        /** Composição teórica do índice (carteira teórica vigente) */
         get: operations["getIndexComposition"];
         put?: never;
         post?: never;
@@ -387,7 +402,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Observações de uma série (com acumulados opcionais) */
+        /**
+         * Observações de uma série (com acumulados opcionais)
+         * @description Série temporal (data, valor) de uma fonte macro (BCB SGS, IBGE SIDRA, FRED…). `source`+`series_id` identificam a série; `accumulated=12m` acumula variações. Ex.: bcb_sgs/432 = Selic meta.
+         */
         get: operations["getSeries"];
         put?: never;
         post?: never;
@@ -421,7 +439,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Indicadores do FII (snapshot) */
+        /**
+         * Indicadores do FII (snapshot)
+         * @description Snapshot dos indicadores do FII: dividend yield (mês e 12m), P/VP, vacância, patrimônio líquido, valor patrimonial por cota (vp_cota) e nº de cotistas. Para a série temporal use o histórico.
+         */
         get: operations["getFiiIndicators"];
         put?: never;
         post?: never;

package/package.json

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