iptuapi

IPTU API - JavaScript/TypeScript SDK

SDK oficial para integração com a IPTU API.

Instalação

npm install iptuapi
# ou
yarn add iptuapi
# ou
pnpm add iptuapi

Uso Rápido

import { IPTUClient } from 'iptuapi';

const client = new IPTUClient('sua_api_key');

// Consulta por endereço
const resultado = await client.consultaEndereco('Avenida Paulista', '1000');
console.log(resultado);

// Consulta por SQL (Starter+)
const dados = await client.consultaSQL('100-01-001-001');

// Avaliação de mercado (Pro+)
const avaliacao = await client.valuationEstimate({
  area_terreno: 250,
  area_construida: 180,
  bairro: 'Pinheiros',
  zona: 'ZM',
  tipo_uso: 'Residencial',
  tipo_padrao: 'Médio',
  ano_construcao: 2010,
});
console.log(`Valor estimado: R$ ${avaliacao.valor_estimado.toLocaleString()}`);

Tratamento de Erros

import { IPTUClient, NotFoundError, RateLimitError } from 'iptuapi';

const client = new IPTUClient('sua_api_key');

try {
  const resultado = await client.consultaEndereco('Rua Inexistente');
} catch (error) {
  if (error instanceof NotFoundError) {
    console.log('Imóvel não encontrado');
  } else if (error instanceof RateLimitError) {
    console.log('Limite de requisições excedido');
  }
}

Tipos TypeScript

O SDK inclui tipos TypeScript completos:

import type {
  ConsultaEnderecoResult,
  ConsultaSQLResult,
  ValuationParams,
  ValuationResult,
} from 'iptuapi';

Documentação

Acesse a documentação completa em iptuapi.com.br/docs