v1

latestSwagger 2.02026-07-132830204.5 KB

WWW

URL Info

Parse, analyze and retrieve content from the supplied URL

get/url-info

Query parameters

urlstring required

The URL to probe

fetch-contentboolean

If this URL responds with html, text, json or xml then return the response. This option is useful if you want to perform further processing on the URL content (e.g. with the HTML Extract or HTML Clean APIs)

ignore-certificate-errorsboolean

Ignore any TLS/SSL certificate errors and load the URL anyway

timeoutinteger

Timeout in seconds. Give up if still trying to load the URL after this number of seconds

retryinteger

If the request fails for any reason try again this many times

Response

http-status-messagestring required

The HTTP status message associated with the status code

server-regionstring required

The servers IP geo-location: full region name (if detectable)

queryobject required

A key-value map of the URL query parameters

server-namestring required

The name of the server software hosting this URL

url-portinteger required

The URL port

server-countrystring required

The servers IP geo-location: full country name

realboolean required

Is this URL actually serving real content

server-citystring required

The servers IP geo-location: full city name (if detectable)

url-pathstring required

The URL path

urlstring required

The fully qualified URL. This may be different to the URL requested if http-redirect is true

validboolean required

Is this a valid well-formed URL

server-hostnamestring required

The servers hostname (PTR record)

load-timenumber double required

The time taken to load the URL content in seconds

http-okboolean required

True if this URL responded with an HTTP OK (200) status

content-sizeinteger required

The size of the URL content in bytes

http-statusinteger required

The HTTP status code this URL responded with. An HTTP status of 0 indicates a network level issue

server-country-codestring required

The servers IP geo-location: ISO 2-letter country code

content-encodingstring required

The encoding format the URL uses

server-ipstring required

The IP address of the server hosting this URL

url-protocolstring required

The URL protocol, usually http or https

content-typestring required

The content-type this URL serves

http-redirectboolean required

True if this URL responded with an HTTP redirect

contentstring required

The actual content this URL responded with. Only set if the 'fetch-content' option was used

is-timeoutboolean required

True if a timeout occurred while loading the URL. You can set the timeout with the request parameter 'timeout'

titlestring required

The document title

language-codestring required

The ISO 2-letter language code of the page. Extracted from either the HTML document or via HTTP headers

is-errorboolean required

True if an error occurred while loading the URL. This includes network errors, TLS errors and timeouts

Example response

{
  "content": "",
  "content-encoding": "gzip",
  "content-size": 104334,
  "content-type": "text/html; charset=UTF-8",
  "http-ok": true,
  "http-redirect": false,
  "http-status": 200,
  "http-status-message": "OK",
  "is-error": false,
  "is-timeout": false,
  "language-code": "en",
  "load-time": 0.351411411,
  "query": {},
  "real": true,
  "server-city": "Kansas City",
  "server-country": "United States of America",
  "server-country-code": "US",
  "server-hostname": "139.243.244.35.bc.googleusercontent.com",
  "server-ip": "35.244.243.139",
  "server-name": "nginx",
  "server-region": "Missouri",
  "title": "Neutrino API: The general-purpose API",
  "url": "https://www.neutrinoapi.com/",
  "url-path": "/",
  "url-port": 443,
  "url-protocol": "https",
  "valid": true
}