Summary API

The Summary API allows to fetch a summary of data we have in regards to an asset. An asset can be an IP address, a domain or a hostname (FQDN). You can just pass the asset value and not a full ONYPHE Query Language search.

Furthermore, the summary will be composed of data fetched in the last 30-days only, you cannot query historical data with that endpoint. Also, it will return only the last 10 or 100 results per category, depending on your license, we have from all categories of information that have a match in regards to your asset.

The 3 available endpoints are:

/summary/ip/{IP}: you have to give a valid IPv4 or IPv6 address (example: 8.8.8.8);
/summary/domain/{DOMAIN}: you have to give a valid domain (example: google.com);
/summary/hostname/{HOSTNAME}: you have to give a valid hostname (example: www.google.com).

Using curl

You can use curl in the following way to call the Summary API:

curl -H 'Content-Type: application/json' -H 'Authorization: bearer YOUR_APIKEY' -XGET 'https://www.onyphe.io/api/v2/summary/domain/google.com'

Output:

{
  "count": 160,
  "error": 0,
  "max_page": 1,
  "myip": "<redacted>",
  "page": 1,
  "page_size": 160,
  "results": [
    {
      "@category": "ctl",
      "@timestamp": "2023-03-16T02:10:14.000Z",
      [..]
  ],
  "status": "ok",
  "text": "Success",
  "took": 0.773,
  "total": 431928
}

Using curl against Unrated API endpoint

If you want to query against the Unrated API endpoint, you have to pass the API key as an HTTP parameter as the Authorization header will be used to store Basic authentication credentials based on your login email address and your API key as a password:

LOGIN=`echo -n YOUR_LOGIN_EMAIL | sed 's/@/_/g'`
PASS=YOUR_APIKEY
BASIC=`echo -n $LOGIN:$PASS | base64 -w 0`
curl -H 'Content-Type: application/json' -H "Authorization: basic $BASIC" -XGET 'https://www.onyphe.io/unrated/api/v2/summary/domain/google.com?k=YOUR_APIKEY'