iptuapi - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

dist/index.d.mts

@@ -14,2 +14,4 @@ /**
  */
+/** Cidades suportadas pela API */
+type Cidade = 'sao_paulo' | 'belo_horizonte';
 interface ConsultaEnderecoResult {
@@ -26,2 +28,22 @@ sql: string;
 }
+/** Resultado da consulta multi-cidade */
+interface ConsultaIPTUResult {
+    sql: string;
+    ano: number;
+    logradouro: string;
+    numero: number | null;
+    complemento: string | null;
+    bairro: string | null;
+    cep: string;
+    area_terreno: number | null;
+    area_construida: number | null;
+    valor_terreno: number | null;
+    valor_construcao: number | null;
+    valor_venal: number;
+    finalidade: string | null;
+    tipo_construcao: string | null;
+    ano_construcao: number | null;
+    cidade: string;
+    fonte: string;
+}
 interface ConsultaSQLResult {
@@ -93,2 +115,18 @@ sql: string;
     /**
+     * Busca dados de IPTU por endereço para qualquer cidade suportada
+     * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
+     * @param logradouro - Nome da rua/avenida
+     * @param numero - Número do imóvel (opcional)
+     * @param ano - Ano de referência (default: 2024)
+     * @param limit - Limite de resultados (default: 20)
+     */
+    consultaIPTU(cidade: Cidade, logradouro: string, numero?: number, ano?: number, limit?: number): Promise<ConsultaIPTUResult[]>;
+    /**
+     * Busca dados de IPTU pelo identificador único do imóvel
+     * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
+     * @param identificador - Número SQL (SP) ou Índice Cadastral (BH)
+     * @param ano - Ano de referência (opcional)
+     */
+    consultaIPTUSQL(cidade: Cidade, identificador: string, ano?: number): Promise<ConsultaIPTUResult[]>;
+    /**
      * Estima o valor de mercado do imóvel (Pro+)
@@ -99,2 +137,2 @@ */
 
-export { AuthenticationError, type ConsultaEnderecoResult, type ConsultaSQLResult, ForbiddenError, IPTUAPIError, IPTUClient, type IPTUClientOptions, NotFoundError, RateLimitError, type ValuationParams, type ValuationResult, IPTUClient as default };
+export { AuthenticationError, type Cidade, type ConsultaEnderecoResult, type ConsultaIPTUResult, type ConsultaSQLResult, ForbiddenError, IPTUAPIError, IPTUClient, type IPTUClientOptions, NotFoundError, RateLimitError, type ValuationParams, type ValuationResult, IPTUClient as default };

dist/index.d.ts

@@ -14,2 +14,4 @@ /**
  */
+/** Cidades suportadas pela API */
+type Cidade = 'sao_paulo' | 'belo_horizonte';
 interface ConsultaEnderecoResult {
@@ -26,2 +28,22 @@ sql: string;
 }
+/** Resultado da consulta multi-cidade */
+interface ConsultaIPTUResult {
+    sql: string;
+    ano: number;
+    logradouro: string;
+    numero: number | null;
+    complemento: string | null;
+    bairro: string | null;
+    cep: string;
+    area_terreno: number | null;
+    area_construida: number | null;
+    valor_terreno: number | null;
+    valor_construcao: number | null;
+    valor_venal: number;
+    finalidade: string | null;
+    tipo_construcao: string | null;
+    ano_construcao: number | null;
+    cidade: string;
+    fonte: string;
+}
 interface ConsultaSQLResult {
@@ -93,2 +115,18 @@ sql: string;
     /**
+     * Busca dados de IPTU por endereço para qualquer cidade suportada
+     * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
+     * @param logradouro - Nome da rua/avenida
+     * @param numero - Número do imóvel (opcional)
+     * @param ano - Ano de referência (default: 2024)
+     * @param limit - Limite de resultados (default: 20)
+     */
+    consultaIPTU(cidade: Cidade, logradouro: string, numero?: number, ano?: number, limit?: number): Promise<ConsultaIPTUResult[]>;
+    /**
+     * Busca dados de IPTU pelo identificador único do imóvel
+     * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
+     * @param identificador - Número SQL (SP) ou Índice Cadastral (BH)
+     * @param ano - Ano de referência (opcional)
+     */
+    consultaIPTUSQL(cidade: Cidade, identificador: string, ano?: number): Promise<ConsultaIPTUResult[]>;
+    /**
      * Estima o valor de mercado do imóvel (Pro+)
@@ -99,2 +137,2 @@ */
 
-export { AuthenticationError, type ConsultaEnderecoResult, type ConsultaSQLResult, ForbiddenError, IPTUAPIError, IPTUClient, type IPTUClientOptions, NotFoundError, RateLimitError, type ValuationParams, type ValuationResult, IPTUClient as default };
+export { AuthenticationError, type Cidade, type ConsultaEnderecoResult, type ConsultaIPTUResult, type ConsultaSQLResult, ForbiddenError, IPTUAPIError, IPTUClient, type IPTUClientOptions, NotFoundError, RateLimitError, type ValuationParams, type ValuationResult, IPTUClient as default };

dist/index.js

@@ -136,2 +136,42 @@ "use strict";
   /**
+   * Busca dados de IPTU por endereço para qualquer cidade suportada
+   * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
+   * @param logradouro - Nome da rua/avenida
+   * @param numero - Número do imóvel (opcional)
+   * @param ano - Ano de referência (default: 2024)
+   * @param limit - Limite de resultados (default: 20)
+   */
+  async consultaIPTU(cidade, logradouro, numero, ano = 2024, limit = 20) {
+    const params = {
+      logradouro,
+      ano: ano.toString(),
+      limit: limit.toString()
+    };
+    if (numero !== void 0) {
+      params.numero = numero.toString();
+    }
+    return this.request(
+      "GET",
+      `/dados/iptu/${cidade}/endereco`,
+      params
+    );
+  }
+  /**
+   * Busca dados de IPTU pelo identificador único do imóvel
+   * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
+   * @param identificador - Número SQL (SP) ou Índice Cadastral (BH)
+   * @param ano - Ano de referência (opcional)
+   */
+  async consultaIPTUSQL(cidade, identificador, ano) {
+    const params = {};
+    if (ano !== void 0) {
+      params.ano = ano.toString();
+    }
+    return this.request(
+      "GET",
+      `/dados/iptu/${cidade}/sql/${encodeURIComponent(identificador)}`,
+      params
+    );
+  }
+  /**
    * Estima o valor de mercado do imóvel (Pro+)
@@ -138,0 +178,0 @@ */

dist/index.mjs

@@ -106,2 +106,42 @@ // src/index.ts
   /**
+   * Busca dados de IPTU por endereço para qualquer cidade suportada
+   * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
+   * @param logradouro - Nome da rua/avenida
+   * @param numero - Número do imóvel (opcional)
+   * @param ano - Ano de referência (default: 2024)
+   * @param limit - Limite de resultados (default: 20)
+   */
+  async consultaIPTU(cidade, logradouro, numero, ano = 2024, limit = 20) {
+    const params = {
+      logradouro,
+      ano: ano.toString(),
+      limit: limit.toString()
+    };
+    if (numero !== void 0) {
+      params.numero = numero.toString();
+    }
+    return this.request(
+      "GET",
+      `/dados/iptu/${cidade}/endereco`,
+      params
+    );
+  }
+  /**
+   * Busca dados de IPTU pelo identificador único do imóvel
+   * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
+   * @param identificador - Número SQL (SP) ou Índice Cadastral (BH)
+   * @param ano - Ano de referência (opcional)
+   */
+  async consultaIPTUSQL(cidade, identificador, ano) {
+    const params = {};
+    if (ano !== void 0) {
+      params.ano = ano.toString();
+    }
+    return this.request(
+      "GET",
+      `/dados/iptu/${cidade}/sql/${encodeURIComponent(identificador)}`,
+      params
+    );
+  }
+  /**
    * Estima o valor de mercado do imóvel (Pro+)
@@ -108,0 +148,0 @@ */

package.json

 {
   "name": "iptuapi",
-  "version": "1.0.0",
-  "description": "SDK oficial para a IPTU API - Dados de IPTU de São Paulo",
+  "version": "1.1.0",
+  "description": "SDK oficial para a IPTU API - Dados de IPTU de São Paulo e Belo Horizonte",
   "main": "dist/index.js",
@@ -19,2 +19,3 @@ "module": "dist/index.mjs",
     "são paulo",
+    "belo horizonte",
     "imóveis",
@@ -21,0 +22,0 @@ "dados",

No alert changes

Improved metrics

Total package byte prevSize

21378

35.24%

Lines of code

495

31.65%

No dependency changes