Skip to content

docs(readme): show X-Credits-Charged metadata and explain 429 as out of credits #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MudassarTariq merged 1 commit into from
Nov 4, 2026
Merged

docs(readme): show X-Credits-Charged metadata and explain 429 as out of credits #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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;
}
Expand Down