v1/search/summary

This API provides a security summary for a specified domain, including SPF, DMARC configurations, and network and site information.

Request URL

curl -i -X GET "https://api.securitysurface.com/v1/search/summary?domain=example.com" \
-H "apikey: your_api_key" \
-H "Content-Type: application/json"

Replace example.com with the domain you want to query, and your_api_key with your actual API key.

Request Parameters

Parameter Type Location Required Description
domain string query Yes The domain to query, e.g., example.com

Response Data 

{
    "status": "ss_success",
    "domain": "example.com",
    "summary": {
        "dmarc": {
            "raw": "v=DMARC1;p=reject;sp=reject;adkim=s;aspf=s",
            "data": [
                {
                    "tag": "p=reject",
                    "field": "Defines the policy for handling emails that fail DMARC checks",
                    "value": "Reject the email outright"
                },
                {
                    "tag": "sp=reject",
                    "field": "Defines the policy for handling emails from subdomains that fail DMARC checks",
                    "value": "Reject the email outright"
                },
                {
                    "tag": "adkim=s",
                    "field": "Alignment mode for DKIM validation",
                    "value": "Strict alignment"
                },
                {
                    "tag": "aspf=s",
                    "field": "Alignment mode for SPF validation",
                    "value": "Strict alignment"
                }
            ]
        },
        "spf": {
            "raw": "v=spf1 -all\r\n",
            "data": [
                {
                    "qualifier": "- (Fail)",
                    "mechanism": "all\r\n",
                    "argument": "-"
                }
            ]
        },
        "site": {
            "logo": "/html/images/none.png",
            "socialmedia": {},
            "title": "Example Domain",
            "language": "en",
            "description": "",
            "latitude": "37.78035",
            "longitude": "-122.39059"
        },
        "network": {
            "domain": "example.com",
            "ipv4": "104.18.26.120",
            "ipv4_autonomous_systems": "AS13335",
            "ipv6": "2606:4700::6812:1a78",
            "ipv6_autonomous_systems": "AS13335",
            "country_name": "United States of America",
            "state_prov": "California",
            "city": "San Francisco",
            "isp": "Cloudflare, Inc.",
            "organization": "Cloudflare, Inc.",
            "asn": "AS13335",
            "ns": [
                "elliott.ns.cloudflare.com",
                "hera.ns.cloudflare.com"
            ],
            "nameserver": "RESERVED-Internet Assigned Numbers Authority",
            "domain_registrar": "whois.iana.org",
            "registrar_url": "http://res-dom.iana.org"
        }
    }
}

Response Fields

The response contains the following fields:

Field Type Description
status string Response status, e.g., "ss_success"
domain string The queried domain name
summary object Summary information containing DMARC, SPF, site, and network details
summary.dmarc object DMARC configuration with raw record and parsed data
summary.spf object SPF configuration with raw record and parsed mechanisms
summary.site object Website information including logo, title, language, description, and location coordinates
summary.network object Network information including IP addresses, ASN, geographic location, ISP, nameservers, and registrar details