@apiverve/ipdemographics 1.1.14 → 1.2.0

package/README.md

@@ -60,7 +60,7 @@ Using the API is simple. All you have to do is make a request. The API will retu
 
 ```javascript
 var query = {
-  ip: "8.8.8.8"
+  ip: "173.172.81.20"
 };
 
 api.execute(query, function (error, data) {
@@ -80,7 +80,7 @@ You can also use promises to make requests. The API returns a promise that you c
 
 ```javascript
 var query = {
-  ip: "8.8.8.8"
+  ip: "173.172.81.20"
 };
 
 api.execute(query)
@@ -101,7 +101,7 @@ You can also use async/await to make requests. The API returns a promise that yo
 ```javascript
 async function makeRequest() {
     var query = {
-  ip: "8.8.8.8"
+  ip: "173.172.81.20"
 };
 
     try {
@@ -144,7 +144,12 @@ async function makeRequest() {
       "unemploymentRate": 3.2,
       "homeOwnershipRate": 45.6
     },
-    "acsYear": 2022
+    "acsYear": 2022,
+    "formatted": {
+      "medianHouseholdIncome": "$142,567",
+      "perCapitaIncome": "$78,234",
+      "medianHomeValue": "$1,875,000"
+    }
   }
 }
 ```

package/index.d.ts

@@ -4,42 +4,61 @@ declare module '@apiverve/ipdemographics' {
     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 ipdemographicsResponse {
     status: string;
     error: string | null;
     data: IPDemographicsData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface IPDemographicsData {
-      ip:           string;
+      ip:           null | string;
       location:     Location;
       demographics: Demographics;
-      acsYear:      number;
+      acsYear:      number | null;
+      formatted:    Formatted;
   }
   
   interface Demographics {
-      population:            number;
-      medianAge:             number;
-      medianHouseholdIncome: number;
-      perCapitaIncome:       number;
-      medianHomeValue:       number;
-      collegeEducatedPct:    number;
-      unemploymentRate:      number;
-      homeOwnershipRate:     number;
+      population:            number | null;
+      medianAge:             number | null;
+      medianHouseholdIncome: number | null;
+      perCapitaIncome:       number | null;
+      medianHomeValue:       number | null;
+      collegeEducatedPct:    number | null;
+      unemploymentRate:      number | null;
+      homeOwnershipRate:     number | null;
+  }
+  
+  interface Formatted {
+      medianHouseholdIncome: null | string;
+      perCapitaIncome:       null | string;
+      medianHomeValue:       null | string;
   }
   
   interface Location {
-      zip:         string;
-      city:        string;
-      state:       string;
-      stateCode:   string;
-      country:     string;
-      countryCode: string;
-      latitude:    number;
-      longitude:   number;
-      timezone:    string;
+      zip:         null | string;
+      city:        null | string;
+      state:       null | string;
+      stateCode:   null | string;
+      country:     null | string;
+      countryCode: null | string;
+      latitude:    number | null;
+      longitude:   number | null;
+      timezone:    null | string;
   }
 
   export default class ipdemographicsWrapper {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/ipdemographics",
-  "version": "1.1.14",
+  "version": "1.2.0",
   "description": "IP Demographics combines IP geolocation with Census demographic data to provide demographic information for any IP address. Get location, income, education, and housing data based on the IP's geographic location.",
   "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": [
-    ""
+    "ip demographics", "ip location demographics", "geolocation demographics", "ip to demographics", "visitor demographics"
   ],
   "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"
   }
 }