Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ip2geo.dev/llms.txt

Use this file to discover all available pages before exploring further.

Our SDKs provide a type-safe way to use our conversion services directly through installable packages. In essence, they’re lightweight wrappers around our REST API — but with type safety, auto-completion, and an enhanced developer experience (DX).

​
Available SDKs

We offer official SDKs for the following languages:
LanguagePackage
TypeScript/JavaScript@ip2geo/sdk
Rubyip2geo
Pythonip2geo-sdk
PHPip2geo-dev/sdk

​
Why Use the SDK Instead of the REST API?

  • Type Safety: Get full TypeScript/Ruby/Python support to catch issues early and reduce runtime errors.
  • Simplified Integration: Includes pre-built functions for requests, authentication, and response handling — no need to manually set up HTTP calls.
  • Faster Development: Focus on your app’s logic while the SDK handles the boilerplate.
  • Better Documentation: Clear examples and typings make it easy to discover and use available methods.
  • Automatic Updates: The SDKs stay in sync with the API, giving you access to the latest endpoints and improvements.
The only reason not to use the SDK is if your environment doesn’t support npm, RubyGems, or PyPI, or if your use case requires direct REST API calls.

​
Installation

The TypeScript SDK works with all major JavaScript runtimes that support npm, including Node.js, Deno, Bun, and the browser (with public keys).
npm install @ip2geo/sdk@latest