@parcelkit/sdk
v0.1.0
Published
Official TypeScript SDK for the ParcelKit property data API.
Maintainers
Readme
@parcelkit/sdk
Official TypeScript SDK for the ParcelKit property data API. Normalized access to Texas county appraisal district records: properties, owners, neighbors, geocoding, and suggestions.
Install
npm install @parcelkit/sdkQuick start
import { ParcelKit } from "@parcelkit/sdk";
const pk = new ParcelKit({ apiKey: process.env.PARCELKIT_API_KEY! });
const property = await pk.property.search("2807 Twin Fountains Dr, Houston");
console.log(property.owner, property.appraisedValue);
const comps = await pk.property.neighbors({
address: "2807 Twin Fountains Dr, Houston",
county: "Harris",
});
console.log(comps.neighborsCount);Endpoints
| Resource | Methods |
| ------------- | ------------------------------------------------------------- |
| property | get, search, neighbors |
| owner | portfolio |
| geocode | lookup |
| suggest | (q) — autocomplete suggestions |
| counties | list, byState, detail |
| states | list |
| auth | validate, generate (admin) |
Configuration
new ParcelKit({
apiKey: "val_live_xxx", // required
baseUrl: "https://api.parcelkit.us", // default
timeoutMs: 15_000, // default 15s
fetch: globalThis.fetch, // injectable (Node 18+, undici, etc.)
});Errors
import { ParcelKitError, ParcelKitTimeoutError } from "@parcelkit/sdk";
try {
await pk.property.search("...");
} catch (err) {
if (err instanceof ParcelKitError) {
console.error(err.status, err.body);
} else if (err instanceof ParcelKitTimeoutError) {
console.error("timed out", err.timeoutMs);
}
}License
MIT
