[{"data":1,"prerenderedAt":509},["ShallowReactive",2],{"doc:\u002Fapi-reference":3},{"page":4,"toc":500},{"path":5,"title":6,"description":7,"blocks":8},"\u002Fapi-reference","REST API Reference","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.",[9,12,17,19,67,306,309,311,315,355,358,384,387,389,399,401,419,422,424,449,452,454,460,463],{"type":10,"text":11},"p","The IPScope REST API (`@ipscope\u002Fapi`) is a low-latency NestJS + Fastify service served over HTTPS (HTTP\u002F2 and HTTP\u002F3) from `https:\u002F\u002Fapi.ipscope.io`. Lookups resolve in sub-millisecond memory against an atomic Radix\u002FLPM routing snapshot, with automatic live BGP, RIPEstat, and RDAP `#geofeed` enrichment on cache misses.",{"type":13,"level":14,"text":15,"id":16},"heading",2,"Quick request & response explorer","quick-request-and-response-explorer",{"type":10,"text":18},"Select your preferred language tab below (`curl`, `Python`, `Node.js`, `Go`, `Rust`, `Java`, `.NET`, `Ruby`, `PHP`). Your selection is automatically remembered across every page in the documentation.",{"type":20,"samples":21},"code",[22,27,32,37,42,47,52,57,62],{"label":23,"lang":24,"code":25,"html":26},"curl","bash","curl -sS \"https:\u002F\u002Fapi.ipscope.io\u002Fv1\u002Fip\u002F198.51.100.7\" \\\n  -H \"Authorization: Bearer $IPSCOPE_KEY\"","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-function)\">curl\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string)\"> -sS\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"https:\u002F\u002Fapi.ipscope.io\u002Fv1\u002Fip\u002F198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> \\\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-string)\">  -H\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Authorization: Bearer $IPSCOPE_KEY\"\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":28,"lang":29,"code":30,"html":31},"Python","python","import asyncio, os\nfrom ipscope import AsyncIpScopeClient\n\nasync def main() -> None:\n    async with AsyncIpScopeClient(api_key=os.environ[\"IPSCOPE_KEY\"]) as client:\n        record = await client.lookup_ip(\"198.51.100.7\")\n        print(record[\"ip\"], record[\"geo\"][\"country_code\"], record[\"security\"][\"is_vpn\"])\n\nasyncio.run(main())","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">import\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> asyncio\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> os\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">from\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> ipscope \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">import\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> AsyncIpScopeClient\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">async\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> def\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> main\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">() \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">->\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> None\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    async\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> with\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> AsyncIpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">(api_key\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">os.environ[\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"IPSCOPE_KEY\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">])\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> as\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">        record \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> await\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">lookup_ip\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-function)\">        print\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">(record[\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"ip\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">], record[\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"geo\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">][\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"country_code\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">], record[\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"security\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">][\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"is_vpn\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">])\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">asyncio\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">run\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">main\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">())\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":33,"lang":34,"code":35,"html":36},"Node.js","ts","import { IpScopeClient } from '@ipscope\u002Fsdk-node';\n\nconst client = new IpScopeClient({ apiKey: process.env.IPSCOPE_KEY });\nconst record = await client.lookupIp('198.51.100.7');\nconsole.log(record.ip, record.geo?.country_code, record.security?.is_vpn);","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">import\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> { IpScopeClient } \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">from\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> '@ipscope\u002Fsdk-node'\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">const\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> =\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> new\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> IpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">({ apiKey\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> process\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">env\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">IPSCOPE_KEY\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> });\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">const\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> =\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> await\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">.lookupIp\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">'198.51.100.7'\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">);\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-constant)\">console\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">.log\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.ip\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">geo\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">?.country_code\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">security\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">?.is_vpn);\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":38,"lang":39,"code":40,"html":41},"Go","go","client := ipscope.NewClient(ipscope.Config{APIKey: os.Getenv(\"IPSCOPE_KEY\")})\ndefer client.Close()\n\nrecord, err := client.LookupIP(ctx, \"198.51.100.7\")\nif err != nil {\n\treturn err\n}\nfmt.Println(record.IP, record.Security.IsVPN)","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">client \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">:=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> ipscope.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">NewClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">ipscope\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">Config\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">{APIKey: os.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">Getenv\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"IPSCOPE_KEY\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">)})\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">defer\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">Close\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">()\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">record, err \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">:=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">LookupIP\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(ctx, \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">if\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> err \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">!=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> nil\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">\treturn\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> err\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">}\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">fmt.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">Println\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(record.IP, record.Security.IsVPN)\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":43,"lang":44,"code":45,"html":46},"Rust","rust","use ipscope::{AsyncIpScopeClient, ClientConfig};\n\nlet client = AsyncIpScopeClient::new(ClientConfig::new(std::env::var(\"IPSCOPE_KEY\")?))?;\nlet record = client.lookup_ip(\"198.51.100.7\").await?;\nprintln!(\"{} VPN={}\", record.ip, record.security.is_vpn);","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">use\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> ipscope\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">::\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">{\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">AsyncIpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">, \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">ClientConfig\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">};\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">let\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> AsyncIpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">::\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">new\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(ClientConfig\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">::\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">new\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(std\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">::\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">env\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">::\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">var\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"IPSCOPE_KEY\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">)\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">?\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">))\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">?\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">let\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> record \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">lookup_ip\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">)\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">.await?\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-function)\">println!\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"{} VPN={}\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">, record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">ip, record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">security\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">is_vpn);\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":48,"lang":49,"code":50,"html":51},"Java","java","import io.ipscope.sdk.IpScopeClient;\nimport io.ipscope.sdk.IpScopeConfig;\n\nIpScopeConfig config = IpScopeConfig.builder().apiKey(System.getenv(\"IPSCOPE_KEY\")).build();\ntry (IpScopeClient client = new IpScopeClient(config)) {\n    var record = client.lookupIp(\"198.51.100.7\");\n    System.out.println(record.ip() + \" \" + record.geo().countryCode());\n}","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">import\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> io\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">ipscope\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">sdk\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">IpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">import\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> io\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">ipscope\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">sdk\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">IpScopeConfig\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">IpScopeConfig\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> config \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> IpScopeConfig\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">builder\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">()\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">apiKey\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">System\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">getenv\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"IPSCOPE_KEY\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">))\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">build\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">();\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">try\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> (\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">IpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> new\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> IpScopeClient(config)\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">) {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    var\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> record \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">lookupIp\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">);\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-constant)\">    System\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">out\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">println\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">ip\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">() \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">+\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \" \"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> +\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">geo\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">()\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">countryCode\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">());\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">}\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":53,"lang":54,"code":55,"html":56},".NET","csharp","using IpScope.Sdk;\n\nusing var client = new IpScopeClient(new IpScopeClientOptions {\n    ApiKey = Environment.GetEnvironmentVariable(\"IPSCOPE_KEY\")\n});\nvar record = await client.LookupIpAsync(\"198.51.100.7\");\nConsole.WriteLine($\"{record.Ip} {record.Geo?.CountryCode} VPN={record.Security?.IsVpn}\");","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">using\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> IpScope\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">Sdk\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">using\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> var\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> new\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> IpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">new\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> IpScopeClientOptions\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">    ApiKey \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> Environment\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">GetEnvironmentVariable\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"IPSCOPE_KEY\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">});\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">var\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> record \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> await\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">LookupIpAsync\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">);\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-constant)\">Console\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">WriteLine\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">$\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">{\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">Ip\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">}\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> {\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">Geo\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">?\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">CountryCode\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">}\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> VPN=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">{\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">Security\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">?\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">IsVpn\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">}\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">);\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":58,"lang":59,"code":60,"html":61},"Ruby","ruby","require \"ipscope\"\n\nclient = IpScope::Client.new(api_key: ENV.fetch(\"IPSCOPE_KEY\"))\nrecord = client.lookup_ip(\"198.51.100.7\")\nputs \"#{record.ip} #{record.geo.country_code} VPN=#{record.security.is_vpn}\"","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">require\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"ipscope\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">client \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> IpScope\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">::\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">Client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">new\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">api_key:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> ENV\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">fetch\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"IPSCOPE_KEY\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">))\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">record \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">lookup_ip\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-function)\">puts\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">#{record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">ip\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">}\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> #{record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">geo\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">country_code\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">}\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> VPN=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">#{record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">security\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">is_vpn\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">}\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">\"\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":63,"lang":64,"code":65,"html":66},"PHP","php","\u003C?php\nuse IpScope\\Sdk\\IpScopeClient;\n\n$client = new IpScopeClient(apiKey: getenv('IPSCOPE_KEY') ?: '');\n$record = $client->lookupIp('198.51.100.7');\necho $record->ip . \" \" . $record->geo->countryCode . PHP_EOL;","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\"><?\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">php\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">use\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> IpScope\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">\\\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">Sdk\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">\\\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\">IpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">$client \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> new\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> IpScopeClient\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">apiKey\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\"> getenv\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">'IPSCOPE_KEY'\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">)\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> ?:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> ''\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">)\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">$record \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">=\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> $client\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">->\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-function)\">lookupIp\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">(\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\">'198.51.100.7'\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">)\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-function)\">echo\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> $record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">->\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">ip \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \" \"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\"> .\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> $record\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">->\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">geo\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">->\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">countryCode \u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-keyword)\">.\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> PHP_EOL\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\">;\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"type":68,"responses":69},"responses",[70,263,282,294],{"code":71,"name":72,"description":73,"schema":74,"example":250,"defaultOpen":79,"exampleHtml":262},"200","IpLookupResponse","Resolved IPv4\u002FIPv6 intelligence record projected to your key’s licensedFamilies.",[75,82,89,94,146,159,186,224,241,245],{"name":76,"type":77,"description":78,"required":79,"format":80,"example":81},"ip","string","Canonical normalized representation of the queried IPv4 or IPv6 address.",true,"ipv4 | ipv6","198.51.100.7",{"name":83,"type":84,"description":85,"required":79,"enum":86,"example":87},"ip_version","integer","Protocol family (`4` for IPv4, `6` for IPv6).",[87,88],4,6,{"name":90,"type":77,"description":91,"nullable":79,"format":92,"example":93},"matched_network","Longest-matching routed CIDR prefix in the active Radix\u002FLPM snapshot.","cidr","198.51.100.0\u002F24",{"name":95,"type":96,"description":97,"isRef":79,"children":98},"geo","GeoLocation","Country and city geolocation record (`geo_country` and `geo_city` families).",[99,103,106,109,114,123,129,133,137,141],{"name":100,"type":77,"description":101,"nullable":79,"example":102},"country_code","Effective ISO 3166-1 alpha-2 country code (`\"US\"`, `\"DE\"`, `\"TR\"`).","US",{"name":104,"type":77,"description":105,"nullable":79,"example":102},"declared_country_code","Country code registered in RIR WHOIS\u002FRDAP allocation records or RFC 8805 geofeed.",{"name":107,"type":77,"description":108,"nullable":79,"example":102},"physical_country_code","Country code where active BGP routing and latency triangulation place the infrastructure.",{"name":110,"type":111,"description":112,"required":79,"example":113},"is_virtual_location","boolean","`true` when `declared_country_code` differs from `physical_country_code` (cross-border routed or geofeed-relocated prefix).",false,{"name":115,"type":77,"description":116,"required":79,"enum":117,"example":118},"location_type","How the effective location was resolved by the lookup engine.",[118,119,120,121,122],"physical","declared","virtual","anycast","unknown",{"name":124,"type":125,"description":126,"nullable":79,"range":127,"example":128},"confidence","number","Calibrated geolocation confidence score.","0.0 … 1.0",0.94,{"name":130,"type":77,"description":131,"nullable":79,"example":132},"subdivision","First-level administrative region or state. Included when `geo_city` is licensed.","Virginia",{"name":134,"type":77,"description":135,"nullable":79,"example":136},"city","Resolved city name. Included when `geo_city` is licensed.","Ashburn",{"name":138,"type":84,"description":139,"nullable":79,"example":140},"accuracy_radius_km","Estimated accuracy radius in kilometres around the city centroid. Included when `geo_city` is licensed.",10,{"name":142,"type":77,"description":143,"nullable":79,"format":144,"example":145},"timezone","IANA time zone identifier. Included when `geo_city` is licensed.","iana-tz","America\u002FNew_York",{"name":147,"type":148,"description":149,"isRef":79,"children":150},"network","NetworkInfo","BGP origin autonomous system metadata (`network` family).",[151,155],{"name":152,"type":84,"description":153,"nullable":79,"example":154},"asn","Origin Autonomous System Number without the `AS` prefix.",64501,{"name":156,"type":77,"description":157,"nullable":79,"example":158},"organization","Canonical autonomous system or operator organization name.","Example Cloud LLC",{"name":160,"type":161,"description":162,"isRef":79,"children":163},"connection","ConnectionInfo","Access network classification (`connection` and `hosting` families).",[164,174,177,180,183],{"name":165,"type":77,"description":166,"required":79,"enum":167,"example":171},"connection_type","Primary access network classification.",[168,169,170,171,172,173,122],"residential","mobile","business","hosting","education","government",{"name":175,"type":111,"description":176,"required":79,"example":113},"is_residential","`true` for consumer FTTH, cable, and DSL broadband ISPs.",{"name":178,"type":111,"description":179,"required":79,"example":113},"is_mobile","`true` for cellular carrier gateways (4G\u002F5G CGNAT pools).",{"name":181,"type":111,"description":182,"required":79,"example":113},"is_business","`true` for enterprise leased lines and corporate autonomous systems.",{"name":184,"type":111,"description":185,"required":79,"example":79},"is_hosting","`true` for cloud providers, colocation facilities, and VPS networks.",{"name":187,"type":188,"description":189,"isRef":79,"children":190},"security","SecurityInfo","VPN, proxy, Tor, and hosting anonymizer classification (`anonymity` and `hosting` families).",[191,194,196,199,202,214,217],{"name":192,"type":111,"description":193,"required":79,"example":79},"is_vpn","`true` when the IP is an active commercial or self-hosted VPN exit node.",{"name":184,"type":111,"description":195,"required":79,"example":79},"`true` when routed by a datacenter, cloud, or hosting ASN.",{"name":197,"type":111,"description":198,"required":79,"example":113},"is_tor_exit","`true` when listed in the active Tor Project exit consensus.",{"name":200,"type":111,"description":201,"required":79,"example":113},"is_proxy","`true` for open HTTP\u002FSOCKS proxies and residential proxy relays.",{"name":203,"type":77,"description":204,"required":79,"enum":205,"example":206},"anonymizer_type","Primary anonymizer classification.",[206,207,208,209,210,211,212,213,122],"vpn","proxy","tor_exit","tor_relay","hosting_proxy","apple_private_relay","other_relay","none",{"name":124,"type":125,"description":215,"nullable":79,"range":127,"example":216},"Calibrated anonymity confidence score.",0.96,{"name":218,"type":219,"description":220,"required":79,"example":221},"reason_codes","string[]","Deterministic evidence codes explaining why the IP was flagged.",[222,223],"vpn_handshake_confirmed","datacenter_asn_range",{"name":225,"type":226,"description":227,"isRef":79,"children":228},"security_extensions","SecurityExtensions","Extended threat telemetry and scanner recency (`security_extensions` family).",[229,234,237],{"name":230,"type":125,"description":231,"nullable":79,"range":232,"example":233},"abuse_velocity_score","Normalized abuse velocity score from active honeypot and darknet observations.","0 … 100",18,{"name":235,"type":111,"description":236,"nullable":79,"example":113},"is_known_scanner","`true` when the IP has been observed performing internet-wide port or vulnerability scanning.",{"name":238,"type":84,"description":239,"nullable":79,"example":240},"observation_recency_hours","Hours elapsed since the most recent active security or anonymizer observation.",12,{"name":242,"type":77,"description":243,"required":79,"example":244},"dataset_version","Version identifier of the compiled IPScope dataset snapshot serving the response.","2026-10-27T00:00:00Z.crawl-1793088000000",{"name":246,"type":77,"description":247,"nullable":79,"format":248,"example":249},"updated_at","ISO 8601 UTC timestamp when the active dataset snapshot was published.","date-time","2026-10-27T00:00:00Z",{"ip":81,"ip_version":87,"matched_network":93,"geo":251,"network":255,"connection":256,"security":257,"security_extensions":259,"dataset_version":244,"updated_at":249},{"country_code":102,"declared_country_code":102,"physical_country_code":102,"is_virtual_location":113,"location_type":118,"confidence":128,"subdivision":132,"city":136,"postal_code":252,"latitude":253,"longitude":254,"accuracy_radius_km":140,"timezone":145},"20147",39.0438,-77.4874,{"asn":154,"organization":158},{"connection_type":171,"is_hosting":79,"is_residential":113,"is_mobile":113,"is_business":113},{"is_vpn":79,"is_hosting":79,"is_tor_exit":113,"is_proxy":113,"anonymizer_type":206,"confidence":216,"reason_codes":258},[222,223],{"abuse_velocity_score":233,"is_known_scanner":113,"observation_recency_hours":240,"anonymizer_reason":222,"threat_level":260,"abuse_velocity":261,"confidence":216},"medium","low","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">{\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"ip\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"ip_version\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 4\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"matched_network\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"198.51.100.0\u002F24\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"geo\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"country_code\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"US\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"declared_country_code\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"US\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"physical_country_code\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"US\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_virtual_location\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> false\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"location_type\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"physical\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"confidence\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 0.94\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"subdivision\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Virginia\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"city\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Ashburn\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"postal_code\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"20147\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"latitude\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 39.0438\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"longitude\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> -77.4874\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"accuracy_radius_km\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 10\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"timezone\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"America\u002FNew_York\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">  }\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"network\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"asn\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 64501\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"organization\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Example Cloud LLC\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">  }\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"connection\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"connection_type\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"hosting\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_hosting\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> true\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_residential\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> false\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_mobile\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> false\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_business\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> false\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">  }\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"security\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_vpn\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> true\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_hosting\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> true\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_tor_exit\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> false\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_proxy\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> false\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"anonymizer_type\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"vpn\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"confidence\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 0.96\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"reason_codes\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> [\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-string-expression)\">      \"vpn_handshake_confirmed\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-string-expression)\">      \"datacenter_asn_range\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">    ]\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">  }\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"security_extensions\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"abuse_velocity_score\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 18\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"is_known_scanner\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> false\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"observation_recency_hours\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 12\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"anonymizer_reason\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"vpn_handshake_confirmed\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"threat_level\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"medium\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"abuse_velocity\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"low\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">    \"confidence\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 0.96\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">  }\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"dataset_version\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"2026-10-27T00:00:00Z.crawl-1793088000000\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"updated_at\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"2026-10-27T00:00:00Z\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">}\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"code":264,"name":265,"description":266,"schema":267,"example":280,"exampleHtml":281},"401","ApiError","Missing, malformed, expired, or revoked API key \u002F Bearer token.",[268,272,276],{"name":269,"type":84,"description":270,"required":79,"example":271},"statusCode","HTTP status code returned by the API gateway.",401,{"name":273,"type":77,"description":274,"required":79,"example":275},"message","Human-readable diagnostic message describing the error condition.","Invalid or revoked API key",{"name":277,"type":77,"description":278,"required":79,"example":279},"error","Canonical HTTP error classification.","Unauthorized",{"statusCode":271,"message":275,"error":279},"\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">{\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"statusCode\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 401\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"message\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Invalid or revoked API key\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"error\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Unauthorized\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">}\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"code":283,"name":265,"description":284,"schema":285,"example":292,"exampleHtml":293},"402","Prepaid credit reservation exhausted (100 micro-USD per lookup).",[286,288,290],{"name":269,"type":84,"description":270,"required":79,"example":287},402,{"name":273,"type":77,"description":274,"required":79,"example":289},"Prepaid credit reservation exhausted. Please top up your wallet.",{"name":277,"type":77,"description":278,"required":79,"example":291},"Payment Required",{"statusCode":287,"message":289,"error":291},"\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">{\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"statusCode\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 402\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"message\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Prepaid credit reservation exhausted. Please top up your wallet.\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"error\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Payment Required\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">}\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"code":295,"name":265,"description":296,"schema":297,"example":304,"exampleHtml":305},"429","Per-user token bucket rate limit exceeded (rl:user:\u003CuserId>).",[298,300,302],{"name":269,"type":84,"description":270,"required":79,"example":299},429,{"name":273,"type":77,"description":274,"required":79,"example":301},"Rate limit exceeded (600 req\u002Fmin). Retry after 14s.",{"name":277,"type":77,"description":278,"required":79,"example":303},"Too Many Requests",{"statusCode":299,"message":301,"error":303},"\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">{\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"statusCode\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-constant)\"> 429\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"message\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Rate limit exceeded (600 req\u002Fmin). Retry after 14s.\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-keyword)\">  \"error\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-punctuation)\">:\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Too Many Requests\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-foreground)\">}\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"type":13,"level":14,"text":307,"id":308},"Service endpoints","service-endpoints",{"type":10,"text":310},"All endpoints are versioned under `\u002Fv1` and grouped into two controllers: **Lookup & Telemetry** (`LookupController`) and **MMDB & Artifact Distribution** (`MmdbController`).",{"type":13,"level":312,"text":313,"id":314},3,"Lookup & Telemetry (`LookupController`)","lookup-and-telemetry-lookupcontroller",{"type":316,"columns":317,"rows":323},"table",[318,319,320,321,322],"Method","Route","Scope \u002F Auth","Metering","Description",[324,330,335,341,345,348,352],[325,326,327,328,329],"`GET`","[`\u002Fv1\u002Fip\u002F{ip}`](\u002Fapi-reference\u002Fendpoints\u002Fip)","`lookup`","`1 credit`","Resolve any IPv4 or IPv6 address with live BGP\u002FRIPEstat enrichment-on-miss.",[325,331,332,333,334],"[`\u002Fv1\u002Fip\u002Fme`](\u002Fapi-reference\u002Fendpoints\u002Fme)","Public (`None`)","Free (`120\u002Fmin`)","Proxy-aware lookup of the connecting client’s public IP (alias: `\u002Fv1\u002Fpublic\u002Fip`).",[336,337,338,339,340],"`POST`","[`\u002Fv1\u002Fip\u002Fbatch`](\u002Fapi-reference\u002Fendpoints\u002Fbatch)","`batch`","`1 credit \u002F IP`","Resolve 1 to 100 IPv4\u002FIPv6 addresses pinned to a single consistent snapshot version.",[325,342,327,343,344],"[`\u002Fv1\u002Fnetworks\u002F{prefix}\u002F{length}`](\u002Fapi-reference\u002Fendpoints\u002Fasn)","Included","Inspect canonical prefix record by split CIDR or URL-encoded `\u002Fv1\u002Fnetworks\u002F{cidr}`.",[325,346,327,343,347],"[`\u002Fv1\u002Fmetadata\u002Fdatasets`](\u002Fapi-reference\u002Fendpoints\u002Fmeta)","List active and previous snapshot versions, SHA-256 digests, and prefix counts.",[336,349,327,350,351],"[`\u002Fv1\u002Ffeedback`](\u002Fapi-reference\u002Fendpoints\u002Fmeta)","Free","Submit a network operator or researcher geolocation\u002Fanonymizer correction report.",[325,353,332,350,354],"[`\u002Fv1\u002Fstatus`](\u002Fapi-reference\u002Fendpoints\u002Fmeta)","Unauthenticated liveness probe returning active and previous snapshot versions.",{"type":13,"level":312,"text":356,"id":357},"MMDB & Artifact Distribution (`MmdbController`)","mmdb-and-artifact-distribution-mmdbcontroller",{"type":316,"columns":359,"rows":361},[318,319,360,322],"Scope",[362,365,368,372,375,378,381],[325,363,327,364],"[`\u002Fv1\u002Fmmdb\u002Fproducts`](\u002Fapi-reference\u002Ffiltering-fields)","Catalog of supported formats (`mmdb`, `csv`, `parquet`), field families, cadences, and presets.",[336,366,327,367],"[`\u002Fv1\u002Fmmdb\u002Fquote`](\u002Fapi-reference\u002Ffiltering-fields)","Calculate a deterministic integer-minor-unit price quote and `profileSchemaHash`.",[325,369,370,371],"[`\u002Fv1\u002Fmmdb\u002Freleases`](\u002Fapi-reference\u002Ffiltering-fields)","`download`","List compiled release manifests, artifact sizes, and SHA-256 checksums.",[336,373,370,374],"[`\u002Fv1\u002Fmmdb\u002Freleases\u002F{id}\u002Fdownload-token`](\u002Fapi-reference\u002Ffiltering-fields)","Issue a short-lived signed download token for a specific release (`id` or `latest`) and format.",[325,376,370,377],"[`\u002Fv1\u002Fmmdb\u002Freleases\u002F{id}\u002Fchecksums`](\u002Fapi-reference\u002Ffiltering-fields)","Fetch JSON or `text\u002Fplain` `SHA256SUMS` verification manifest.",[325,379,370,380],"[`\u002Fv1\u002Fmmdb\u002Freleases\u002F{id}\u002Fdownload`](\u002Fapi-reference\u002Ffiltering-fields)","Stream `.mmdb`, `.csv.gz`, or `.parquet` with `ETag` (`304`), `Range` (`206`), or GCS V4 `302` redirect.",[325,382,370,383],"[`\u002Fv1\u002Fmmdb\u002Fsnapshots\u002Fdiff`](\u002Fapi-reference\u002Ffiltering-fields)","Compute a differential prefix update package between `from_version` and `to_version`.",{"type":13,"level":14,"text":385,"id":386},"Authentication & API key scopes","authentication-and-api-key-scopes",{"type":10,"text":388},"Authenticated endpoints are protected by `ApiKeyGuard`. Pass your API key in either the `Authorization: Bearer \u003Ckey>` header or the `x-api-key: \u003Ckey>` header. Keys are hashed with SHA-256 and verified in sub-millisecond memory against the hot key cache.",{"type":20,"samples":390},[391,395],{"label":392,"lang":24,"code":393,"html":394},"Authorization: Bearer (recommended)","curl -sS \"https:\u002F\u002Fapi.ipscope.io\u002Fv1\u002Fip\u002F198.51.100.7\" \\\n  -H \"Authorization: Bearer ips_live_••••••••\"","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-function)\">curl\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string)\"> -sS\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"https:\u002F\u002Fapi.ipscope.io\u002Fv1\u002Fip\u002F198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> \\\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-string)\">  -H\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"Authorization: Bearer ips_live_••••••••\"\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"label":396,"lang":24,"code":397,"html":398},"x-api-key header","curl -sS \"https:\u002F\u002Fapi.ipscope.io\u002Fv1\u002Fip\u002F198.51.100.7\" \\\n  -H \"x-api-key: ips_live_••••••••\"","\u003Cpre class=\"shiki ipscope\" style=\"background-color:var(--shiki-background);color:var(--shiki-foreground)\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-function)\">curl\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string)\"> -sS\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"https:\u002F\u002Fapi.ipscope.io\u002Fv1\u002Fip\u002F198.51.100.7\"\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-foreground)\"> \\\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"color:var(--shiki-token-string)\">  -H\u003C\u002Fspan>\u003Cspan style=\"color:var(--shiki-token-string-expression)\"> \"x-api-key: ips_live_••••••••\"\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>",{"type":10,"text":400},"Every API key is provisioned with explicit **permission scopes** (`ApiKeyScope`) and **licensed field families** (`licensedFamilies`). If a key lacks the required scope for a route, the API returns `403 Forbidden`.",{"type":316,"columns":402,"rows":405},[360,403,404],"Granted endpoints","Purpose",[406,409,412,415],[327,407,408],"`\u002Fv1\u002Fip\u002F:ip`, `\u002Fv1\u002Fnetworks\u002F*`, `\u002Fv1\u002Fmetadata\u002Fdatasets`, `\u002Fv1\u002Ffeedback`, `\u002Fv1\u002Fmmdb\u002Fproducts`, `\u002Fv1\u002Fmmdb\u002Fquote`","Real-time single IP and CIDR lookups, dataset metadata, and feedback.",[338,410,411],"`POST \u002Fv1\u002Fip\u002Fbatch`","High-throughput 100-IP batch enrichment requests.",[370,413,414],"`\u002Fv1\u002Fmmdb\u002Freleases*`, `\u002Fv1\u002Fmmdb\u002Fsnapshots\u002Fdiff`","Automated CI\u002FCD and server cron jobs pulling `.mmdb`, `.csv.gz`, and `.parquet` snapshots.",[416,417,418],"`admin`","Administrative control plane","Internal platform and snapshot management.",{"type":13,"level":14,"text":420,"id":421},"Per-user rate limiting & headers","per-user-rate-limiting-and-headers",{"type":10,"text":423},"Rate limits are enforced **per user account** (`rl:user:\u003CuserId>`), shared across all active API keys owned by that user. Creating multiple keys for microservice isolation never multiplies burst limits or bypasses account-level rate governance.",{"type":316,"columns":425,"rows":428},[426,427,322],"Response Header","Example Value",[429,433,437,441,445],[430,431,432],"`X-RateLimit-Scope`","`user`","Indicates rate limiting is enforced at the user account boundary across all keys.",[434,435,436],"`X-RateLimit-Limit`","`600`","Maximum requests permitted per 60-second window for your account tier.",[438,439,440],"`X-RateLimit-Remaining`","`594`","Remaining requests allowed in the current 60-second window.",[442,443,444],"`X-RateLimit-Reset`","`38`","Seconds remaining until the current rate-limit window resets.",[446,447,448],"`Retry-After`","`14`","Sent on `429 Too Many Requests`; number of seconds to wait before retrying.",{"type":13,"level":14,"text":450,"id":451},"Prepaid credit reservation & metering","prepaid-credit-reservation-and-metering",{"type":10,"text":453},"Metered endpoints (`GET \u002Fv1\u002Fip\u002F:ip` = `1` unit, `POST \u002Fv1\u002Fip\u002Fbatch` = `ips.length` units) debit from a low-latency Valkey credit reservation chunk backed by our PostgreSQL double-entry ledger (`100 micro-USD` per lookup = **$0.10 per 1,000 lookups**).",{"type":455,"items":456},"list",[457,458,459],"**Atomic pre-validation**: On `POST \u002Fv1\u002Fip\u002Fbatch`, every IP in `ips[]` is validated *before* credits are debited. Malformed requests (`400 Bad Request`) never consume credits.","**Explicit `402 Payment Required`**: When your monthly plan allowance and prepaid wallet reservation are exhausted, metered endpoints return `402 Payment Required` rather than silently accruing surprise post-paid overage bills.","**Unmetered operational endpoints**: `GET \u002Fv1\u002Fstatus`, `GET \u002Fv1\u002Fip\u002Fme`, `GET \u002Fv1\u002Fmetadata\u002Fdatasets`, and `POST \u002Fv1\u002Ffeedback` do not debit lookup credits.",{"type":13,"level":14,"text":461,"id":462},"Explore endpoint specifications","explore-endpoint-specifications",{"type":464,"columns":14,"cards":465},"cards",[466,472,478,484,488,494],{"title":467,"text":468,"href":469,"icon":470,"badge":471},"GET \u002Fv1\u002Fip\u002F{ip}","Single IPv4\u002FIPv6 lookup with live BGP\u002FRIPEstat enrichment-on-miss and licensed family projection.","\u002Fapi-reference\u002Fendpoints\u002Fip","terminal","scope: lookup",{"title":473,"text":474,"href":475,"icon":476,"badge":477},"GET \u002Fv1\u002Fip\u002Fme","Keyless visitor IP lookup with TRUST_PROXY Cloudflare edge header resolution (120 req\u002Fmin).","\u002Fapi-reference\u002Fendpoints\u002Fme","globe","Public",{"title":479,"text":480,"href":481,"icon":482,"badge":483},"POST \u002Fv1\u002Fip\u002Fbatch","Resolve up to 100 IPv4\u002FIPv6 addresses in a single request pinned to one snapshot version.","\u002Fapi-reference\u002Fendpoints\u002Fbatch","layers","scope: batch",{"title":485,"text":486,"href":487,"icon":20,"badge":471},"GET \u002Fv1\u002Fnetworks\u002F{prefix}\u002F{length}","Inspect canonical network prefix records by split CIDR or URL-encoded CIDR.","\u002Fapi-reference\u002Fendpoints\u002Fasn",{"title":489,"text":490,"href":491,"icon":492,"badge":493},"Datasets, Feedback & Status","GET \u002Fv1\u002Fmetadata\u002Fdatasets, POST \u002Fv1\u002Ffeedback, and GET \u002Fv1\u002Fstatus health checks.","\u002Fapi-reference\u002Fendpoints\u002Fmeta","shield","Metadata",{"title":495,"text":496,"href":497,"icon":498,"badge":499},"Field Families & MMDB API","Licensed field family projection and \u002Fv1\u002Fmmdb\u002F* release, quote, checksum, and download endpoints.","\u002Fapi-reference\u002Ffiltering-fields","database","scope: download",[501,502,503,504,505,506,507,508],{"id":16,"text":15,"level":14},{"id":308,"text":307,"level":14},{"id":314,"text":313,"level":312},{"id":357,"text":356,"level":312},{"id":386,"text":385,"level":14},{"id":421,"text":420,"level":14},{"id":451,"text":450,"level":14},{"id":462,"text":461,"level":14},1793226505459]