.NET SDK · ipscope Docs

# Install

Install

dotnet add package IpScope.Sdk

# Quickstart: single, batch & prefix lookups

Pass your API key explicitly or set IPSCOPE_KEY in your environment. Every lookup returns the canonical response schema with geo, network, connection, security and security_extensions.

.NET

using IpScope.Sdk;

using var client = new IpScopeClient(new IpScopeClientOptions
{
    ApiKey = Environment.GetEnvironmentVariable("IPSCOPE_KEY"),
    MaxCacheEntries = 2048,
});

// 1. Single IPv4 or IPv6 lookup
var info = await client.LookupIpAsync("198.51.100.7");
Console.WriteLine($"{info.Ip} {info.Geo.CountryCode} AS{info.Network.Asn} VPN={info.Security.IsVpn}");

// 2. Batch lookup (up to 100 IPs; deduplicated & cached)
var batch = await client.LookupBatchAsync(new[] { "198.51.100.7", "1.1.1.1" });
Console.WriteLine($"Total resolved: {batch.Count}");

// 3. Memory-bounded IAsyncEnumerable streaming for 10,000+ IPs
await foreach (var chunk in client.LookupBatchStreamAsync(largeIpList))
{
    foreach (var record in chunk.Results)
    {
        // Constant O(chunk) memory overhead
    }
}

// 4. Network CIDR prefix lookup
var prefix = await client.LookupNetworkAsync("198.51.100.0/24");
Console.WriteLine($"{prefix.QueriedCidr} -> AS{prefix.Record?.Asn} ({prefix.Record?.Organization})");

Responses

application/json

1. Single IPv4/IPv6 lookup response (GET /v1/ip/{ip})

{
  "ip": "198.51.100.7",
  "ip_version": 4,
  "matched_network": "198.51.100.0/24",
  "geo": {
    "country_code": "US",
    "declared_country_code": "US",
    "physical_country_code": "US",
    "is_virtual_location": false,
    "location_type": "physical",
    "confidence": 0.94,
    "subdivision": "Virginia",
    "city": "Ashburn",
    "postal_code": "20147",
    "latitude": 39.0438,
    "longitude": -77.4874,
    "accuracy_radius_km": 10,
    "timezone": "America/New_York"
  },
  "network": {
    "asn": 64501,
    "organization": "Example Cloud LLC"
  },
  "connection": {
    "connection_type": "hosting",
    "is_hosting": true,
    "is_residential": false,
    "is_mobile": false,
    "is_business": false
  },
  "security": {
    "is_vpn": true,
    "is_hosting": true,
    "is_tor_exit": false,
    "is_proxy": false,
    "anonymizer_type": "vpn",
    "confidence": 0.96,
    "reason_codes": [
      "vpn_handshake_confirmed",
      "datacenter_asn_range"
    ]
  },
  "security_extensions": {
    "abuse_velocity_score": 18,
    "is_known_scanner": false,
    "observation_recency_hours": 12,
    "anonymizer_reason": "vpn_handshake_confirmed",
    "threat_level": "medium",
    "abuse_velocity": "low",
    "confidence": 0.96
  },
  "dataset_version": "2026-10-27T00:00:00Z.crawl-1793088000000",
  "updated_at": "2026-10-27T00:00:00Z"
}

application/json

4. Network CIDR prefix lookup response (GET /v1/networks/{prefix}/{length})

{
  "queried_cidr": "198.51.100.0/24",
  "family": 4,
  "dataset_version": "2026-10-27T00:00:00Z.crawl-1793088000000",
  "record": {
    "prefix": "198.51.100.0/24",
    "family": 4,
    "asn": 64501,
    "organization": "Example Cloud LLC",
    "countryCode": "US",
    "city": "Ashburn",
    "locationType": "physical",
    "isVpn": true,
    "isHosting": true,
    "isTorExit": false,
    "isProxy": false,
    "anonymizerType": "vpn"
  }
}

# Architecture & runtime guarantees

Zero external NuGet dependencies: uses System.Text.Json source-friendly serialization and SocketsHttpHandler connection pooling.
Native IAsyncEnumerable<BatchLookupResponse> via LookupBatchStreamAsync for backpressure-aware streaming.
Thread-safe O(1) LRU cache and IHttpClientFactory dependency injection compatibility.

# Reading local MMDB files

If you subscribe to a downloadable database, our .mmdb snapshots open directly in standard MaxMind DB readers with sub-microsecond in-memory lookups:

.NET (MMDB)

using MaxMind.Db;
using System.Net;

using var reader = new Reader("/var/lib/ipscope/ipscope-complete.mmdb");
var record = reader.Find<Dictionary<string, object>>(IPAddress.Parse("198.51.100.7"));

# Plain HTTP fallback

Need to call the REST API without installing a package? Use .NET’s standard HTTP client directly:

.NET (HTTP)

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", $"Bearer {Environment.GetEnvironmentVariable("IPSCOPE_KEY")}");
var json = await http.GetStringAsync("https://api.ipscope.io/v1/ip/198.51.100.7");