# ipscope Docs > ipscope answers where an IP address is, which network holds it, and whether it is a VPN, proxy, Tor exit or data centre. These docs cover the REST API, the downloadable databases (MMDB, CSV, Parquet) and the planned server SDKs. The complete documentation in one file: https://ipscope.io/docs/llms-full.txt ## Getting Started: Start here - [Quickstart](https://ipscope.io/docs/getting-started/quickstart.md): Look up an IPv4 or IPv6 address over HTTP, with an official server SDK, or from a local MMDB file in under five minutes. - [Authentication](https://ipscope.io/docs/getting-started/authentication.md): How to pass your API key to the REST API and signed database download endpoints. - [Response format](https://ipscope.io/docs/getting-started/response-format.md): The canonical JSON envelope, the 6 intelligence blocks, nullability rules, and response headers. - [Errors](https://ipscope.io/docs/getting-started/errors.md): HTTP status codes, machine-readable error envelopes, and retry strategies. - [Rate limits & quotas](https://ipscope.io/docs/getting-started/rate-limits.md): Monthly plan quotas, burst concurrency, and zero-429 Prepaid Micro-USD Wallet overflow. ## Getting Started: Data model - [Field reference](https://ipscope.io/docs/getting-started/data/fields.md): Every field in an IPScope lookup response and downloadable database record: type, nullability, and meaning. - [Methodology & verification](https://ipscope.io/docs/getting-started/data/accuracy.md): How IPScope separates declared registry country from physical routing reality and calibrates confidence. - [Privacy & VPN detection](https://ipscope.io/docs/getting-started/data/privacy-detection.md): How to use security and security_extensions to distinguish VPNs, Tor exits, proxies, and cloud hosting. - [IPv6 coverage](https://ipscope.io/docs/getting-started/data/ipv6.md): Full dual-stack parity across IPv4 and IPv6 in the REST API and every database format. ## Getting Started: Operations - [Changelog](https://ipscope.io/docs/getting-started/changelog.md): Release history for the IPScope REST API, official server SDKs, and downloadable databases. - [Corrections & support](https://ipscope.io/docs/getting-started/support.md): How to submit an IP geolocation or VPN correction and how to reach the IPScope engineering team. ## API Reference: REST API Service - [REST API Reference](https://ipscope.io/docs/api-reference.md): Complete reference for the IPScope v1 REST API service: single & batch IP lookups, proxy-aware caller detection, CIDR prefix inspection, dataset metadata, feedback submission, and signed MMDB artifact distribution. ## API Reference: Lookup & Telemetry - [Single IP lookup](https://ipscope.io/docs/api-reference/endpoints/ip.md): Resolve a single IPv4 or IPv6 address against the active Radix/LPM snapshot with live BGP/RIPEstat enrichment-on-miss. - [Caller IP lookup](https://ipscope.io/docs/api-reference/endpoints/me.md): Look up the connecting visitor’s public IPv4 or IPv6 address without an API key, with proxy-aware Cloudflare edge header resolution. - [Batch lookup (up to 100 IPs)](https://ipscope.io/docs/api-reference/endpoints/batch.md): Resolve 1 to 100 IPv4 and IPv6 addresses in a single POST request pinned to a consistent dataset snapshot. - [Network CIDR lookup](https://ipscope.io/docs/api-reference/endpoints/asn.md): Inspect canonical routing prefix intelligence by split CIDR (/v1/networks/:prefix/:length) or URL-encoded CIDR (/v1/networks/:cidr). - [Datasets, feedback & status](https://ipscope.io/docs/api-reference/endpoints/meta.md): Inspect active and historical dataset snapshots (/v1/metadata/datasets), submit network corrections (/v1/feedback), and probe service health (/v1/status). ## API Reference: MMDB & Scopes - [Field families & MMDB distribution API](https://ipscope.io/docs/api-reference/filtering-fields.md): How API key licensedFamilies project lookup responses, plus the complete /v1/mmdb/* endpoints for custom quotes, release manifests, SHA256SUMS, and signed artifact downloads. ## Databases: Overview - [Database editions & SKUs](https://ipscope.io/docs/databases.md): Seven ready-made IPv4 & IPv6 database editions in MMDB, CSV and Parquet formats, plus a custom builder. - [Custom database builder](https://ipscope.io/docs/databases/custom.md): Compile a bespoke MMDB, CSV, or Parquet database containing only the intelligence families your application uses. ## Databases: Formats & delivery - [MMDB, CSV & Parquet](https://ipscope.io/docs/databases/formats.md): How the three database file formats are structured and which one to pick for your workload. - [Downloading & checksums](https://ipscope.io/docs/databases/downloading.md): Fetch database snapshots via HMAC-signed URLs, GCS V4 streaming redirects, ETag caching, and SHA-256 verification. - [Automated zero-downtime updates](https://ipscope.io/docs/databases/updating.md): Atomically replace MMDB files on live production servers without dropping a single lookup. - [Reading MMDB in code](https://ipscope.io/docs/databases/reading-mmdb.md): Open IPScope .mmdb files with standard MaxMind DB readers in Python, Node.js, Go, Rust, Java, .NET, Ruby and PHP. ## Databases: Terms - [Licensing & attribution](https://ipscope.io/docs/databases/licensing.md): Per-server internal deployment licensing, strict non-sharing and non-resale terms, and CC BY 4.0 terms for IPScope Lite. ## SDKs: Overview - [Official Server SDKs](https://ipscope.io/docs/sdks.md): Eight production-ready server-side client libraries for Python, Node.js, Go, Rust, Java, .NET, Ruby and PHP. ## SDKs: Server-side libraries - [Python SDK](https://ipscope.io/docs/sdks/python.md): Official IPScope server-side client for Python 3.10+ (asyncio & sync) (ipscope). - [Node.js SDK](https://ipscope.io/docs/sdks/node.md): Official IPScope server-side client for Node.js 18+, Bun, Deno & Edge Workers (@ipscope/sdk-node). - [Go SDK](https://ipscope.io/docs/sdks/go.md): Official IPScope server-side client for Go 1.22+ (github.com/ipscope-io/ipscope-go). - [Rust SDK](https://ipscope.io/docs/sdks/rust.md): Official IPScope server-side client for Rust 1.75+ (2021 edition, Tokio async & blocking) (ipscope). - [Java SDK](https://ipscope.io/docs/sdks/java.md): Official IPScope server-side client for Java 17+ (Java 21 Virtual Threads ready) (io.ipscope:ipscope-sdk). - [.NET SDK](https://ipscope.io/docs/sdks/dotnet.md): Official IPScope server-side client for .NET 8.0+ (C# 12) (IpScope.Sdk). - [Ruby SDK](https://ipscope.io/docs/sdks/ruby.md): Official IPScope server-side client for Ruby 3.1+ (Puma, Sidekiq & Falcon Fiber-safe) (ipscope). - [PHP SDK](https://ipscope.io/docs/sdks/php.md): Official IPScope server-side client for PHP 8.2+ (PHP-FPM, FrankenPHP, RoadRunner & Swoole) (ipscope/ipscope-php).