From 96f0c053130e15ebabef059049cc45898927bc20 Mon Sep 17 00:00:00 2001 From: mateen993 Date: Wed, 4 Nov 2026 18:48:12 +0500 Subject: [PATCH] docs(readme): show X-Credits-Charged metadata and explain 429 as out of credits --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3f91f0b..a0afe48 100644 --- a/README.md +++ b/README.md @@ -445,9 +445,10 @@ const response = await client.lookupIpGeolocation({ ip: "8.8.8.8", }); -console.log(response.metadata.statusCode); +console.log(response.metadata.statusCode); // 200 console.log(response.metadata.durationMs); -console.log(response.metadata.firstHeaderValue("x-ratelimit-remaining")); +console.log(response.metadata.creditsCharged); // credits deducted for this call, from X-Credits-Charged +console.log(response.metadata.firstHeaderValue("x-credits-charged")); // the same value as a raw header string ``` ## JSON Helpers @@ -516,7 +517,8 @@ try { if (error instanceof UnauthorizedError) { console.error(error.apiMessage); } else if (error instanceof RateLimitError) { - console.error("Rate limit reached"); + // 429: credits used up for this period (or the overage limit reached), not a per-second limit + console.error("Out of API credits:", error.apiMessage); } else { throw error; }