Repository navigation
docs(readme): show X-Credits-Charged metadata and explain 429 as out of credits - #23
Merged
MudassarTariq merged 1 commit intoNov 4, 2026
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Fixes two README examples that describe IPGeolocation.io as rate-limited.
Response Metadata example
firstHeaderValue("x-ratelimit-remaining"). The API never sends this header, so the line printsundefined.metadata.creditsChargedand the rawx-credits-chargedheader, which the API returns on every billed call.Error Handling example
RateLimitError(429) now logs "Out of API credits" witherror.apiMessageinstead of "Rate limit reached".RateLimitErrorso existing code keeps working.Checked
One
/v3/ipgeolookup with SDK 3.0.1 on Node 22 returns:The SDK source agrees:
creditsChargedis parsed fromX-Credits-Charged, and a 429 response maps toRateLimitError.Follow-up
Publish this README in the next npm release so the package README matches.