Open ToolsView Desktop Assist

Developer API

RouterWiz API Docs

Use RouterWiz APIs for public IP awareness, DNS and DDNS checks, reachability tests, and router workflow helpers that move users toward login and port forwarding decisions.

API docs preview

RouterWiz APIs make tool results reusable outside the site.

Public IP, DNS, DDNS, port checks, public service checks, and RouterWiz workflow APIs are grouped into one practical reference.

  • Uses the same backend as the web tools.
  • Designed for dashboards and helper apps.
  • Each API includes request examples and response notes.
View Public IP API
RouterWiz API documentation visual

Related visual cues

Helpful visuals for this page

RouterWiz API documentation UI
Developer dashboard flow diagram
Public IP gateway comparison

Usage rules

  • Base URL: https://routerwiz.com
  • JSON endpoints return UTF-8 JSON and support CORS with Access-Control-Allow-Origin: *.
  • Some endpoints localize guidance fields when you send Accept-Language: ko-KR.
  • Port checks stay limited to the requester public IP path and do not accept arbitrary third-party targets.
  • Host, URL, ping, traceroute, and service checks only allow public targets, not private LAN addresses.

Quick start

  • Use GET /api/ip when you only need the requester public IP as plain text.
  • Use GET /api/ip/json when you want the same IP with ASN and location context.
  • Use POST /api/tools/public-service-check when you need one request to answer host resolution, TCP reachability, and HTTP or HTTPS response status.
  • Use POST /api/tools/port-forward-plan and POST /api/tools/router-login-route when you want RouterWiz-specific workflow help rather than generic network data.

Public IP and IP context

Start here when a setup page or diagnostic flow needs WAN-side identity before anything else.

GET

Public IP (plain text)

/api/ip

Return the requester public IP as plain text.

curl https://routerwiz.com/api/ip
  • Best for tiny widgets, setup pages, and shell scripts.
  • Returns only the current requester IP with no JSON wrapper.

GET

Public IP (JSON)

/api/ip/json

Return the requester public IP with ASN and location context.

curl https://routerwiz.com/api/ip/json
  • Includes IP version, country, continent, region, city, latitude, longitude, ASN, and organization.
  • Backed by server-local IP data files instead of live third-party lookups.

POST

IP Lookup

/api/tools/ip-lookup

Read ASN, prefix, registry, and provider information for a public IP.

curl -X POST https://routerwiz.com/api/tools/ip-lookup \
  -H "Content-Type: application/json" \
  -d '{"ip":"8.8.8.8"}'
  • Useful before NAT, DDNS, ISP, or hosting assumptions.
  • Returns organization, prefix, registry, country, and ASN list.

POST

IP Location

/api/tools/ip-location

Read location context for a public IP.

curl -X POST https://routerwiz.com/api/tools/ip-location \
  -H "Content-Type: application/json" \
  -d '{"ip":"8.8.8.8"}'
  • Returns country, region, city, timezone, coordinates, ASN, and organization when available.
  • Useful for WAN context and operator sanity checks.

DNS and DDNS

Use these APIs when remote access depends on a hostname instead of a raw public IP.

POST

DNS Lookup

/api/tools/dns-lookup

Resolve A, AAAA, or CNAME records for a hostname.

curl -X POST https://routerwiz.com/api/tools/dns-lookup \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com","recordType":"A"}'
  • Useful before DDNS, public service, or TLS checks.
  • Returns normalized record values and next-action hints.

POST

DNS Propagation

/api/tools/dns-propagation

Compare public resolver answers for the same hostname.

curl -X POST https://routerwiz.com/api/tools/dns-propagation \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com","recordType":"A"}'
  • Compares local resolver, Google Public DNS, and Cloudflare DNS.
  • Useful for DDNS and propagation lag diagnosis.

POST

Reverse DNS

/api/tools/reverse-dns

Read PTR hostnames for a public IP.

curl -X POST https://routerwiz.com/api/tools/reverse-dns \
  -H "Content-Type: application/json" \
  -d '{"ip":"8.8.8.8"}'
  • Useful for WAN naming context and provider comparison.

POST

DDNS Match

/api/tools/ddns-match

Compare the current public IP path with direct DNS answers and resolver propagation for a DDNS hostname.

curl -X POST https://routerwiz.com/api/tools/ddns-match \
  -H "Content-Type: application/json" \
  -d '{"hostname":"example.ddns.net","recordType":"A"}'
  • Returns public IP, direct DNS answer, propagation comparison, and a match verdict.
  • Useful before spending more time on port forwarding rules.

Reachability and web response checks

These APIs answer whether the public path is open and whether the web-facing service responds on top of that path.

POST

Port Check

/api/tools/port-check

Check whether a TCP port appears open on the requester public IP.

curl -X POST https://routerwiz.com/api/tools/port-check \
  -H "Content-Type: application/json" \
  -d '{"port":25565,"protocol":"tcp"}'
  • Does not accept arbitrary target IPs.
  • Returns open, closed, timeout, refused, or error plus next-action hints.

POST

Public Service Check

/api/tools/public-service-check

Resolve a public host, test the TCP port, and optionally confirm an HTTP or HTTPS response.

curl -X POST https://routerwiz.com/api/tools/public-service-check \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com","port":443,"protocol":"tcp","scheme":"https"}'
  • Useful for home servers, NAS, DDNS hostnames, and public web endpoints.
  • Combines resolved IP, TCP result, HTTP/HTTPS attempt, and next actions in one response.

POST

Ping

/api/tools/ping

Run a public-target ICMP reachability check.

curl -X POST https://routerwiz.com/api/tools/ping \
  -H "Content-Type: application/json" \
  -d '{"host":"example.com"}'
  • Useful for path clues, not application-level proof.

POST

Traceroute

/api/tools/traceroute

Walk the early public route hop by hop.

curl -X POST https://routerwiz.com/api/tools/traceroute \
  -H "Content-Type: application/json" \
  -d '{"host":"example.com"}'
  • Useful when you need path context beyond a single ping result.

POST

HTTP Headers

/api/tools/http-headers

Inspect public response headers, redirects, and status code.

curl -X POST https://routerwiz.com/api/tools/http-headers \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}'
  • Useful after a public service looks reachable but still behaves strangely.

POST

SSL Check

/api/tools/ssl-check

Check TLS certificate validity, issuer, and protocol details.

curl -X POST https://routerwiz.com/api/tools/ssl-check \
  -H "Content-Type: application/json" \
  -d '{"host":"example.com","port":443}'
  • Useful right after HTTPS reachability is confirmed.

Router workflow helpers

These endpoints are more RouterWiz-specific and help callers build router setup flows instead of generic network lookups.

POST

Port Forward Plan

/api/tools/port-forward-plan

Generate router-ready values for a common use case such as Minecraft, RDP, CCTV, or NAS.

curl -X POST https://routerwiz.com/api/tools/port-forward-plan \
  -H "Content-Type: application/json" \
  -d '{"useCase":"minecraft","routerBrand":"iptime","internalIp":"192.168.0.34"}'
  • Returns service name, protocol, ports, menu path, security notes, and next actions.

POST

Router Login Route

/api/tools/router-login-route

Suggest the likely login order and next route when ISP gear and a personal router may both be involved.

curl -X POST https://routerwiz.com/api/tools/router-login-route \
  -H "Content-Type: application/json" \
  -d '{"routerBrand":"kt","gateway":"172.30.1.254","platform":"windows","connectionState":"yes"}'
  • Returns route targets, checklist, sticker hints, warnings, and next actions.
  • Useful for guided login and Browser Assist handoff flows.