IPsee API

Here you can see how to use IPsee API (REST) service directly.
Please firstly check About page for informations about this service.

General considerations

  • This REST API return responses in JSON format
  • 'host' parameter can always be an IP addresse or a domain name
  • If an error occur, 'error' value is set to 1, and error message is filled in 'debug' field. 'result' value can then be uncertain

  • API/IP

    Give client public IP addresse.
    Example: api/ip

    Test /api/ip
    {
      "api": "ip",
      "host": "127.0.0.1",
      "port": "",
      "error": 0,
      "debug": "",
      "result": "127.0.0.1"
    }
    

    API/PING

    Run an ICMP PING test (return true or false).
    Example: api/ping?host=example.com

    Test /api/ping
    {
      "api": "ping",
      "host": "example.com",
      "port": "",
      "error": 0,
      "debug": "",
      "result": true
    }
    

    API/DNS

    Resolve IP adresses or domain name (reverse)
    Example: api/dns?host=example.com

    Test /api/dns
    {
      "api": "dns",
      "host": "example.com",
      "port": "",
      "error": 0,
      "debug": "",
      "result": "93.184.216.34"
    }
    

    API/WHOIS

    Get WHOIS informations from public registries.
    Example: api/whois?host=example.com

    Test /api/whois
    {
      "api": "whois",
      "host": "example.com",
      "port": "",
      "error": 0,
      "debug": "",
      "result": [
        "domain:       EXAMPLE.COM",
        "organisation: Internet Assigned Numbers Authority",
        "created:      1992-01-01",
        "source:       IANA",
        ...
      ]
    }
    

    API/GEOIP

    Localize an IP addresse or domain name.
    Example: api/geoip?host=example.com

    Test /api/geoip
    {
      "api": "geoip",
      "host": "example.com",
      "port": "",
      "error": 0,
      "debug": "",
      "result": {
        "country": "US",
        "region": "MA",
        "city": "Norwell"
      }
    }
    

    API/PORT

    Check TCP host port.
    Example: api/port?host=example.com&port=80

    Test /api/port
    {
      "api": "port",
      "host": "example.com",
      "port": "80",
      "error": 0,
      "debug": "",
      "result": "OK"
    }