@apiverve/zipdemographics 1.1.13 → 1.2.0

package/README.md

@@ -139,22 +139,13 @@ async function makeRequest() {
       "medianHomeValue": 2875000,
       "medianRent": 3250,
       "totalUnits": 10234,
-      "occupiedUnits": 8976,
-      "vacantUnits": 1258,
-      "ownerOccupied": 5678,
-      "renterOccupied": 3298,
       "homeOwnershipRate": 63.2
     },
     "education": {
-      "collegeEducatedPct": 72.4,
-      "bachelors": 4523,
-      "masters": 2341,
-      "professional": 1234,
-      "doctorate": 567
+      "collegeEducatedPct": 72.4
     },
     "employment": {
       "laborForce": 11234,
-      "unemployed": 423,
       "unemploymentRate": 3.8
     },
     "race": {
@@ -162,18 +153,16 @@ async function makeRequest() {
         "count": 16892,
         "percent": 77.7
       },
-      "black": {
-        "count": 542,
-        "percent": 2.5
-      },
       "asian": {
         "count": 2345,
         "percent": 10.8
-      },
-      "hispanic": {
-        "count": 1423,
-        "percent": 6.5
       }
+    },
+    "formatted": {
+      "medianHouseholdIncome": "$153,891",
+      "perCapitaIncome": "$98,234",
+      "medianHomeValue": "$2,875,000",
+      "medianRent": "$3,250"
     }
   }
 }

package/index.d.ts

@@ -4,73 +4,82 @@ declare module '@apiverve/zipdemographics' {
     secure?: boolean;
   }
 
+  /**
+   * Describes fields the current plan does not unlock. Locked fields arrive as null
+   * in `data`; `locked_fields` names them, using dot paths for nested fields.
+   * Absent when the plan unlocks everything.
+   */
+  export interface PremiumInfo {
+    message: string;
+    upgrade_url: string;
+    locked_fields: string[];
+  }
+
   export interface zipdemographicsResponse {
     status: string;
     error: string | null;
     data: ZIPDemographicsData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface ZIPDemographicsData {
-      zip:        string;
-      name:       string;
-      acsYear:    number;
+      zip:        null | string;
+      name:       null | string;
+      acsYear:    number | null;
       population: Population;
       income:     Income;
       housing:    Housing;
       education:  Education;
       employment: Employment;
       race:       Race;
+      formatted:  Formatted;
   }
   
   interface Education {
-      collegeEducatedPct: number;
-      bachelors:          number;
-      masters:            number;
-      professional:       number;
-      doctorate:          number;
+      collegeEducatedPct: number | null;
   }
   
   interface Employment {
-      laborForce:       number;
-      unemployed:       number;
-      unemploymentRate: number;
+      laborForce:       number | null;
+      unemploymentRate: number | null;
+  }
+  
+  interface Formatted {
+      medianHouseholdIncome: null | string;
+      perCapitaIncome:       null | string;
+      medianHomeValue:       null | string;
+      medianRent:            null | string;
   }
   
   interface Housing {
-      medianHomeValue:   number;
-      medianRent:        number;
-      totalUnits:        number;
-      occupiedUnits:     number;
-      vacantUnits:       number;
-      ownerOccupied:     number;
-      renterOccupied:    number;
-      homeOwnershipRate: number;
+      medianHomeValue:   number | null;
+      medianRent:        number | null;
+      totalUnits:        number | null;
+      homeOwnershipRate: number | null;
   }
   
   interface Income {
-      medianHousehold: number;
-      perCapita:       number;
+      medianHousehold: number | null;
+      perCapita:       number | null;
   }
   
   interface Population {
-      total:     number;
-      male:      number;
-      female:    number;
-      medianAge: number;
+      total:     number | null;
+      male:      number | null;
+      female:    number | null;
+      medianAge: number | null;
   }
   
   interface Race {
-      white:    Asian;
-      black:    Asian;
-      asian:    Asian;
-      hispanic: Asian;
+      white: Asian;
+      asian: Asian;
   }
   
   interface Asian {
-      count:   number;
-      percent: number;
+      count:   number | null;
+      percent: number | null;
   }
 
   export default class zipdemographicsWrapper {

package/index.js

@@ -13,16 +13,10 @@ class zipdemographicsWrapper {
             throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
         }
 
-        // Validate API key format (GUID or alphanumeric with hyphens)
-        const apiKeyPattern = /^[a-zA-Z0-9-]+$/;
+        // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
+        const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
         if (!apiKeyPattern.test(api_key)) {
-            throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens. Get your API key at: https://apiverve.com');
-        }
-
-        // Check minimum length (GUIDs are typically 36 chars with hyphens, or 32 without)
-        const trimmedKey = api_key.replace(/-/g, '');
-        if (trimmedKey.length < 32) {
-            throw new Error('Invalid API key. API key appears to be too short. Get your API key at: https://apiverve.com');
+            throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
         }
 
         if (typeof secure !== 'boolean') {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/zipdemographics",
-  "version": "1.1.13",
+  "version": "1.2.0",
   "description": "ZIP Demographics provides detailed demographic data for any US ZIP code including population, income, education, housing, employment, and racial composition from the US Census American Community Survey.",
   "main": "index.js",
   "types": "index.d.ts",
   "sideEffects": false,
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "index.js",
@@ -23,7 +23,7 @@
     "directory": "npm"
   },
   "keywords": [
-    ""
+    "zip code demographics", "census data", "population by zip", "income by zip", "demographics api"
   ],
   "author": {
     "name": "APIVerve",
@@ -41,8 +41,7 @@
     "dotenv": "^16.4.7"
   },
   "dependencies": {
-    "node-fetch": "^3.3.2",
-    "promise": "^8.3.0",
-    "axios": "1.13.2"
+    "axios": "1.13.2",
+    "form-data": "^4.0.1"
   }
 }