Developer Documentation

Comprehensive IP address and network reference for network engineers, security analysts, and developers. Covers IP geolocation, ASN lookup, ISP data, IP ranges, port references, protocol specifications, threat profiles, RFCs, interactive network tools, glossary, and in-depth guides. 15 languages supported.

Quick Start

curl -s "https://ipfyi.com/api/v1/rest/asns/"

API Endpoints

Method Endpoint Description
GET /api/v1/rest/asns/ Autonomous Systems
GET /api/v1/rest/cities/ Cities with IP data
GET /api/v1/rest/isps/ Internet Service Providers
GET /api/v1/rest/ip-ranges/ IP ranges
GET /api/v1/rest/glossary-categories/ Glossary categories
GET /api/v1/rest/glossary-terms/ Glossary terms
GET /api/v1/rest/threats/ Threat profiles
GET /api/v1/rest/faqs/ FAQs
GET /api/v1/rest/stats/ Site statistics
GET /api/v1/rest/search/?q={query} Search across all content

URL Patterns

Use these patterns to construct URLs programmatically:

/ip/{address}/ IP address detail (e.g. /ip/8.8.8.8/)
/countries/ Countries with internet stats (e.g. /countries/)
/country/{code}/ Country detail (e.g. /country/us/)
/asns/ Autonomous Systems (e.g. /asns/)
/asn/AS{number}/ ASN detail (e.g. /asn/AS15169/)
/cities/ Cities with IP data (e.g. /cities/)
/city/{slug}/ City detail (e.g. /city/san-francisco/)
/isps/ Internet Service Providers (e.g. /isps/)
/isp/{slug}/ ISP detail (e.g. /isp/google/)
/ip-ranges/ IP ranges (CIDR) (e.g. /ip-ranges/)
/ports/ Network ports (e.g. /ports/)
/port/{number}/ Port detail (e.g. /port/443/)
/protocols/ Network protocols (e.g. /protocols/)
/protocol/{slug}/ Protocol detail (e.g. /protocol/tcp/)
/threats/ Threat profiles (e.g. /threats/)
/threat/{slug}/ Threat detail (e.g. /threat/ddos/)
/rfcs/ RFC documents (e.g. /rfcs/)
/rfc/{number}/ RFC detail (e.g. /rfc/791/)
/scenarios/ Network scenarios (e.g. /scenarios/)
/timeline/ Internet timeline (e.g. /timeline/)
/worksheets/ Network worksheets (e.g. /worksheets/)
/glossary/ Networking glossary (e.g. /glossary/)
/guides/ In-depth guides (e.g. /guides/)
/tools/ Network tools (e.g. /tools/)
/tools/subnet-calculator/ Subnet calculator (e.g. /tools/subnet-calculator/)
/tools/ip-converter/ IP converter (e.g. /tools/ip-converter/)
/tools/whois-lookup/ WHOIS lookup (e.g. /tools/whois-lookup/)
/tools/dns-lookup/ DNS lookup (e.g. /tools/dns-lookup/)
/tools/ssl-checker/ SSL checker (e.g. /tools/ssl-checker/)
/comparisons/ Network comparisons (e.g. /comparisons/)
/search/ Search IPs, ASNs, glossary (e.g. /search/?q=google)

Response Format

All endpoints return JSON with pagination:

Example JSON response
{
  "count": 636,
  "next": "https://example.com/api/v1/items/?page=2",
  "previous": null,
  "results": [
    {"slug": "example", "name": "Example Item", "...": "..."}
  ]
}

OpenAPI Specification

Full API schema available as OpenAPI 3.1.0 JSON. Import into Swagger UI, Postman, or any OpenAPI-compatible tool.

SDK Packages

PyPI
pip install ipfyi

IP geolocation and ASN lookup API client

Embed Widget

Embed data cards on your site: https://widget.ipfyi.com
npm install ipfyi-embed

Format Support

  • Markdown endpoints: Append .md to any page URL for LLM-friendly markdown output.
  • Internationalization: Content available in 14 languages: ko, ja, zh-hans, es, fr, de, pt, ru, vi, tr, ar, hi, th, id.