iptuapi 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +43 -4
  2. package/dist/index.d.mts +12 -6
  3. package/dist/index.d.ts +12 -6
  4. package/dist/index.js +5 -5
  5. package/dist/index.mjs +5 -5
  6. package/package.json +3 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # IPTU API - JavaScript/TypeScript SDK
2
2
 
3
- SDK oficial para integração com a IPTU API.
3
+ SDK oficial para integração com a IPTU API - Dados de IPTU de São Paulo e Belo Horizonte.
4
4
 
5
5
  ## Instalação
6
6
 
@@ -12,6 +12,13 @@ yarn add iptuapi
12
12
  pnpm add iptuapi
13
13
  ```
14
14
 
15
+ ## Cidades Suportadas
16
+
17
+ | Cidade | Código | Identificador |
18
+ |--------|--------|---------------|
19
+ | São Paulo | `sao_paulo` | Número SQL |
20
+ | Belo Horizonte | `belo_horizonte` | Índice Cadastral |
21
+
15
22
  ## Uso Rápido
16
23
 
17
24
  ```typescript
@@ -19,14 +26,44 @@ import { IPTUClient } from 'iptuapi';
19
26
 
20
27
  const client = new IPTUClient('sua_api_key');
21
28
 
22
- // Consulta por endereço
29
+ // Consulta por endereço (São Paulo - endpoint legado)
23
30
  const resultado = await client.consultaEndereco('Avenida Paulista', '1000');
24
31
  console.log(resultado);
25
32
 
26
33
  // Consulta por SQL (Starter+)
27
34
  const dados = await client.consultaSQL('100-01-001-001');
35
+ ```
28
36
 
29
- // Avaliação de mercado (Pro+)
37
+ ## Consulta Multi-Cidade (Novo!)
38
+
39
+ ```typescript
40
+ import { IPTUClient, Cidade } from 'iptuapi';
41
+
42
+ const client = new IPTUClient('sua_api_key');
43
+
44
+ // São Paulo - busca por endereço
45
+ const resultadosSP = await client.consultaIPTU('sao_paulo', 'Avenida Paulista', 1000, 2024);
46
+ for (const imovel of resultadosSP) {
47
+ console.log(`SQL: ${imovel.sql}, Valor Venal: R$ ${imovel.valor_venal.toLocaleString()}`);
48
+ }
49
+
50
+ // Belo Horizonte - busca por endereço
51
+ const resultadosBH = await client.consultaIPTU('belo_horizonte', 'Afonso Pena', undefined, 2024);
52
+ for (const imovel of resultadosBH) {
53
+ console.log(`Índice: ${imovel.sql}, Valor Venal: R$ ${imovel.valor_venal.toLocaleString()}`);
54
+ }
55
+
56
+ // Busca por identificador único
57
+ // São Paulo (SQL)
58
+ const dadosSP = await client.consultaIPTUSQL('sao_paulo', '00904801381');
59
+
60
+ // Belo Horizonte (Índice Cadastral)
61
+ const dadosBH = await client.consultaIPTUSQL('belo_horizonte', '007028 005 0086');
62
+ ```
63
+
64
+ ## Avaliação de Mercado (Pro+)
65
+
66
+ ```typescript
30
67
  const avaliacao = await client.valuationEstimate({
31
68
  area_terreno: 250,
32
69
  area_construida: 180,
@@ -47,7 +84,7 @@ import { IPTUClient, NotFoundError, RateLimitError } from 'iptuapi';
47
84
  const client = new IPTUClient('sua_api_key');
48
85
 
49
86
  try {
50
- const resultado = await client.consultaEndereco('Rua Inexistente');
87
+ const resultado = await client.consultaIPTU('sao_paulo', 'Rua Inexistente');
51
88
  } catch (error) {
52
89
  if (error instanceof NotFoundError) {
53
90
  console.log('Imóvel não encontrado');
@@ -63,7 +100,9 @@ O SDK inclui tipos TypeScript completos:
63
100
 
64
101
  ```typescript
65
102
  import type {
103
+ Cidade,
66
104
  ConsultaEnderecoResult,
105
+ ConsultaIPTUResult,
67
106
  ConsultaSQLResult,
68
107
  ValuationParams,
69
108
  ValuationResult,
package/dist/index.d.mts CHANGED
@@ -12,7 +12,7 @@
12
12
  * ```
13
13
  */
14
14
  /** Cidades suportadas pela API */
15
- type Cidade = 'sao_paulo' | 'belo_horizonte';
15
+ type Cidade = 'sao_paulo' | 'belo_horizonte' | 'recife';
16
16
  interface ConsultaEnderecoResult {
17
17
  sql: string;
18
18
  logradouro: string;
@@ -29,7 +29,7 @@ interface ConsultaIPTUResult {
29
29
  sql: string;
30
30
  ano: number;
31
31
  logradouro: string;
32
- numero: number | null;
32
+ numero: number | string | null;
33
33
  complemento: string | null;
34
34
  bairro: string | null;
35
35
  cep: string;
@@ -38,9 +38,15 @@ interface ConsultaIPTUResult {
38
38
  valor_terreno: number | null;
39
39
  valor_construcao: number | null;
40
40
  valor_venal: number;
41
+ valor_imovel?: number | null;
42
+ valor_iptu?: number | null;
41
43
  finalidade: string | null;
42
44
  tipo_construcao: string | null;
43
45
  ano_construcao: number | null;
46
+ pavimentos?: number | null;
47
+ fracao_ideal?: string | null;
48
+ latitude?: number | null;
49
+ longitude?: number | null;
44
50
  cidade: string;
45
51
  fonte: string;
46
52
  }
@@ -111,17 +117,17 @@ declare class IPTUClient {
111
117
  consultaSQL(sql: string): Promise<ConsultaSQLResult>;
112
118
  /**
113
119
  * Busca dados de IPTU por endereço para qualquer cidade suportada
114
- * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
120
+ * @param cidade - Cidade ("sao_paulo", "belo_horizonte" ou "recife")
115
121
  * @param logradouro - Nome da rua/avenida
116
122
  * @param numero - Número do imóvel (opcional)
117
- * @param ano - Ano de referência (default: 2024)
123
+ * @param ano - Ano de referência (default: 2025)
118
124
  * @param limit - Limite de resultados (default: 20)
119
125
  */
120
126
  consultaIPTU(cidade: Cidade, logradouro: string, numero?: number, ano?: number, limit?: number): Promise<ConsultaIPTUResult[]>;
121
127
  /**
122
128
  * Busca dados de IPTU pelo identificador único do imóvel
123
- * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
124
- * @param identificador - Número SQL (SP) ou Índice Cadastral (BH)
129
+ * @param cidade - Cidade ("sao_paulo", "belo_horizonte" ou "recife")
130
+ * @param identificador - Número SQL (SP), Índice Cadastral (BH) ou Contribuinte (Recife)
125
131
  * @param ano - Ano de referência (opcional)
126
132
  */
127
133
  consultaIPTUSQL(cidade: Cidade, identificador: string, ano?: number): Promise<ConsultaIPTUResult[]>;
package/dist/index.d.ts CHANGED
@@ -12,7 +12,7 @@
12
12
  * ```
13
13
  */
14
14
  /** Cidades suportadas pela API */
15
- type Cidade = 'sao_paulo' | 'belo_horizonte';
15
+ type Cidade = 'sao_paulo' | 'belo_horizonte' | 'recife';
16
16
  interface ConsultaEnderecoResult {
17
17
  sql: string;
18
18
  logradouro: string;
@@ -29,7 +29,7 @@ interface ConsultaIPTUResult {
29
29
  sql: string;
30
30
  ano: number;
31
31
  logradouro: string;
32
- numero: number | null;
32
+ numero: number | string | null;
33
33
  complemento: string | null;
34
34
  bairro: string | null;
35
35
  cep: string;
@@ -38,9 +38,15 @@ interface ConsultaIPTUResult {
38
38
  valor_terreno: number | null;
39
39
  valor_construcao: number | null;
40
40
  valor_venal: number;
41
+ valor_imovel?: number | null;
42
+ valor_iptu?: number | null;
41
43
  finalidade: string | null;
42
44
  tipo_construcao: string | null;
43
45
  ano_construcao: number | null;
46
+ pavimentos?: number | null;
47
+ fracao_ideal?: string | null;
48
+ latitude?: number | null;
49
+ longitude?: number | null;
44
50
  cidade: string;
45
51
  fonte: string;
46
52
  }
@@ -111,17 +117,17 @@ declare class IPTUClient {
111
117
  consultaSQL(sql: string): Promise<ConsultaSQLResult>;
112
118
  /**
113
119
  * Busca dados de IPTU por endereço para qualquer cidade suportada
114
- * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
120
+ * @param cidade - Cidade ("sao_paulo", "belo_horizonte" ou "recife")
115
121
  * @param logradouro - Nome da rua/avenida
116
122
  * @param numero - Número do imóvel (opcional)
117
- * @param ano - Ano de referência (default: 2024)
123
+ * @param ano - Ano de referência (default: 2025)
118
124
  * @param limit - Limite de resultados (default: 20)
119
125
  */
120
126
  consultaIPTU(cidade: Cidade, logradouro: string, numero?: number, ano?: number, limit?: number): Promise<ConsultaIPTUResult[]>;
121
127
  /**
122
128
  * Busca dados de IPTU pelo identificador único do imóvel
123
- * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
124
- * @param identificador - Número SQL (SP) ou Índice Cadastral (BH)
129
+ * @param cidade - Cidade ("sao_paulo", "belo_horizonte" ou "recife")
130
+ * @param identificador - Número SQL (SP), Índice Cadastral (BH) ou Contribuinte (Recife)
125
131
  * @param ano - Ano de referência (opcional)
126
132
  */
127
133
  consultaIPTUSQL(cidade: Cidade, identificador: string, ano?: number): Promise<ConsultaIPTUResult[]>;
package/dist/index.js CHANGED
@@ -134,13 +134,13 @@ var IPTUClient = class {
134
134
  }
135
135
  /**
136
136
  * Busca dados de IPTU por endereço para qualquer cidade suportada
137
- * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
137
+ * @param cidade - Cidade ("sao_paulo", "belo_horizonte" ou "recife")
138
138
  * @param logradouro - Nome da rua/avenida
139
139
  * @param numero - Número do imóvel (opcional)
140
- * @param ano - Ano de referência (default: 2024)
140
+ * @param ano - Ano de referência (default: 2025)
141
141
  * @param limit - Limite de resultados (default: 20)
142
142
  */
143
- async consultaIPTU(cidade, logradouro, numero, ano = 2024, limit = 20) {
143
+ async consultaIPTU(cidade, logradouro, numero, ano = 2025, limit = 20) {
144
144
  const params = {
145
145
  logradouro,
146
146
  ano: ano.toString(),
@@ -157,8 +157,8 @@ var IPTUClient = class {
157
157
  }
158
158
  /**
159
159
  * Busca dados de IPTU pelo identificador único do imóvel
160
- * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
161
- * @param identificador - Número SQL (SP) ou Índice Cadastral (BH)
160
+ * @param cidade - Cidade ("sao_paulo", "belo_horizonte" ou "recife")
161
+ * @param identificador - Número SQL (SP), Índice Cadastral (BH) ou Contribuinte (Recife)
162
162
  * @param ano - Ano de referência (opcional)
163
163
  */
164
164
  async consultaIPTUSQL(cidade, identificador, ano) {
package/dist/index.mjs CHANGED
@@ -104,13 +104,13 @@ var IPTUClient = class {
104
104
  }
105
105
  /**
106
106
  * Busca dados de IPTU por endereço para qualquer cidade suportada
107
- * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
107
+ * @param cidade - Cidade ("sao_paulo", "belo_horizonte" ou "recife")
108
108
  * @param logradouro - Nome da rua/avenida
109
109
  * @param numero - Número do imóvel (opcional)
110
- * @param ano - Ano de referência (default: 2024)
110
+ * @param ano - Ano de referência (default: 2025)
111
111
  * @param limit - Limite de resultados (default: 20)
112
112
  */
113
- async consultaIPTU(cidade, logradouro, numero, ano = 2024, limit = 20) {
113
+ async consultaIPTU(cidade, logradouro, numero, ano = 2025, limit = 20) {
114
114
  const params = {
115
115
  logradouro,
116
116
  ano: ano.toString(),
@@ -127,8 +127,8 @@ var IPTUClient = class {
127
127
  }
128
128
  /**
129
129
  * Busca dados de IPTU pelo identificador único do imóvel
130
- * @param cidade - Cidade ("sao_paulo" ou "belo_horizonte")
131
- * @param identificador - Número SQL (SP) ou Índice Cadastral (BH)
130
+ * @param cidade - Cidade ("sao_paulo", "belo_horizonte" ou "recife")
131
+ * @param identificador - Número SQL (SP), Índice Cadastral (BH) ou Contribuinte (Recife)
132
132
  * @param ano - Ano de referência (opcional)
133
133
  */
134
134
  async consultaIPTUSQL(cidade, identificador, ano) {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "iptuapi",
3
- "version": "1.1.0",
4
- "description": "SDK oficial para a IPTU API - Dados de IPTU de São Paulo e Belo Horizonte",
3
+ "version": "1.2.0",
4
+ "description": "SDK oficial para a IPTU API - Dados de IPTU de São Paulo, Belo Horizonte e Recife",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
7
7
  "types": "dist/index.d.ts",
@@ -17,6 +17,7 @@
17
17
  "api",
18
18
  "são paulo",
19
19
  "belo horizonte",
20
+ "recife",
20
21
  "imóveis",
21
22
  "dados",
22
23
  "typescript"