Zum Hauptinhalt springen

Client SDKs

Official client libraries for the IQX Lookup API are available in 5 languages, plus a Spring Boot starter for Java applications.

Available SDKs

SDKPackageMin VersionDependencies
Javaes.neivi:iqx-lookup-javaJava 11+Gson
Spring Bootes.neivi:iqx-lookup-spring-boot-starterSpring Boot 3.xJava SDK
TypeScript@neivi/iqx-lookup-typescriptNode 18+None
Pythonneivi-iqx-lookupPython 3.9+None
Gogithub.com/Neivi-IT/iqx-lookup-goGo 1.21+None
Rustneivi-iqx-lookupRust 2021 editionreqwest, serde, thiserror

Common Patterns

All SDKs share the same design principles:

  • 12 validation and lookup methods: validateEmail, validatePhone, geolocateIp, geolocateMyIp, validateVat, parseUserAgent, validateIban, validateBic, lookupDns, checkSslCertificate, checkPasswordStrength, validateCreditCard
  • API key authentication via X-Api-Key header
  • Typed error handling with specific exceptions for 401, 403, 404, 429, and 503 responses
  • Rate limit info extracted from response headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
  • Configurable base URL and timeout with sensible defaults
  • Minimal dependencies — most SDKs use only the language's standard HTTP client

Default Configuration

SettingDefault
Base URLhttps://api.iqxlookup.neivi.es
Timeout10 seconds
User-Agentiqx-lookup-{lang}/0.2.1

Error Handling

All SDKs map HTTP error responses to typed exceptions:

HTTP StatusError TypeDescription
401UnauthorizedExceptionMissing X-Api-Key header
403ForbiddenExceptionInvalid or inactive API key
404NotFoundExceptionResource not found (e.g., unknown IP)
429RateLimitExceptionRate limit exceeded (includes retryAfter, limit, remaining, reset)
503ServiceUnavailableExceptionService not configured (e.g., GeoIP database missing)