Api Features

API Features


Learn how to implement Zehnet's API into your website or Apps.
API Features

API Features


Brands are relying heavily on sentiment analysis in order to measure return on investment of their marketing efforts.

Zehnet.com introduces the ability to companies and developers to analyze a website on cultural and sentimental perspectives before release.

Our solution assist your marketing and design team to prevent misunderstandings by providing a detailed analysis ranging from color choices to the positivity of your text.

Our API also assists with On-Page SEO, user privacy analysis and report, security and, text analysis.

Getting start


Get a Zehnet account


To use Zehnet API, you need a Zehnet account. If you already have an account, the you're all set. You may also want to create a separate account for testing purposes.


Request an OAuth 2.0 client ID


Follow these steps to request an OAuth 2.0 client ID for the Zehnet API.

  1. Go to the Zehnet API Dashboard
  2. Select the API subscription manager.
  3. Copy the API Key from your owned package list. Each package holds its own API Key.
  4. Optionally, under callback URL, enter the authorized redirect URL to notify your application whenever your domain is analysed.
  5. Request a token via the `token` endpoint using your API key.
  6. Request the desired action using the token. The list of available endpoints are listed below.

API features


Zehnet API requests should be made to the following URL following the specified request method for each endpoint option.

https://zehnet.com/v1/endpoint

Available endpoints


All endpoints require the domain to be registered and processed.


token


Returns the Bearer token used for endpoint requests.

POST

Body: x-www-urlencoded Header: Accept: application/json Parameter: api_key
Response type: JSON
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWJfdXVpZCI6ImRlZjM4MGZiLTA4YmItNDZlOS1iNjRiLTllNzhiNWVmNzgzYiIsImFjY291bnRfdXVpZCI6IjJiMThiYzczLWI5ZTEtNGEwOC1iZmZhLTRiNjU2MDg4YWFmMCIsInRva2VuX3V1aWQiOiI1Y2YyM2JjMi02ODU5LTRiM2QtOTA2MS00OTU3OWUxMjlmYWMifQ.TwjQk-aVhGiLIDsiKw_IwRQAgvTPeY8bOCFAcRGBLnI",
"expire": "2020-09-05 06:00"
}

screenshot


Returns the full-page screenshot in desktop and mobile versions for the requested domain.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token} Parameter: domain

Notice that, the &uri= parameter is optional.

?domain=www.reg-domain.com&uri=contact-us

Response type: JSON
{
    "desktop": "data:image/png;base64,iVBORw0KGgoA...",
    "mobile": "data:image/png;base64,iVBORw0KGgoAA..."
}

colorsentiment


Returns the color sentiment analysis report for the requested domain.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token} Parameter: domain

Notice that, the &uri= parameter is optional.

?domain=www.reg-domain.com&uri=contact-us

Response type: JSON
{
    "analysis": [
        {
            "hex": "#7c7b7a",
            "name": "grey",
            "cultures": {
                "westernAmerican": [
                    "pollution",
                    "decay",
                    "boredom",
                    "respect",
                    "elegance",
                    "humility"
                ],
                "westernEuropean": [],
                "southAmerican": [],
                "russia": [],
                "india": [],
                "northAfrica": [],
                "southAfrica": [],
                "muslim": [],
                "asia": [
                    "travel",
                    "helpful people"
                ],
                "chinese": [],
                "japanese": [
                    "staid",
                    "intelligence",
                    "reliability",
                    "old age",
                    "conservative",
                    "modesty"
                ],
                "nativeAmericans": [
                    "honouring",
                    "friendship"
                ]
            }
        },
        ...
    ],
    "palette": [
        "#556271",
        "#1d2524",
        ...
    ]
}

textsentiment


Returns the text sentiment analisis report for the requested domain.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token} Parameter: domain

Notice that, the &uri= parameter is optional.

?domain=www.reg-domain.com&uri=contact-us

Response type: JSON
{
    "analysis": {
        "score": 20,
        "comparative": 0.00909090909090909,
        "calculation": [
            {
                "drop": -1
            },
            {
                "help": 2
            },
            ...
        ],
        "tokens": [
            "we",
            "use",,
            ...
        ],
        "words": [
            "drop",
            "help",,
            ...
        ],
        "positive": [
            "help",
            ...
        ],
        "negative": [
            "drop",
            ...
        ]
    }
}

seoreport


Returns the seo report for the requested domain.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token} Parameter: domain

Notice that, the &uri= parameter is optional.

?domain=www.reg-domain.com&uri=contact-us

Response type: JSON
{
    "analysis": {
        "issues": {
            "errors": {
                "duplicateTitlePages": {
                    "score": 100,
                    "weight": 1,
                    "impact": 0,
                    "list": []
                },
                "duplicateDescPages": {
                    "score": 100,
                    "weight": 1,
                    "impact": 0,
                    "list": []
                }
            },
            "warnings": {},
            "notices": {}
        },
        "pages": [
            {
                "url": "...",
                "title": "...s",
                "headers": {
                    "h1": [
                        "mydomain"
                    ],
                    "h2": [
                        "Active FiltersClear All",
                        ...
                    ],
                    "h3": [
                        "Home",
                        ...
                    ],
                    "h4": [],
                    "h5": [],
                    "h6": []
                },
                "description": "...",
                "author": "mydomain.com",
                "canonical": "...",
                "keywords": "...",
                "issues": {
                    "errors": {
                        ...
                    },
                    "warnings": {
                        ...
                    },
                    "notices": {
                        "redirects": {
                            ...
                        },
                        "third-party-summary": {
                            ...
                        },
                        "uses-http2": {
                            ...
                        },
                        "uses-passive-event-listeners": {
                            ...
                        },
                        "no-document-write": {
                            ...
                        },
                        "is-on-https": {
                            ...
                        },
                        "notification-on-start": {
                            ...
                        },
                        "no-vulnerable-libraries": {
                            ...
                        },
                        "image-size-responsive": {
                            ...
                        },
                        "charset": {
                            ...
                        },
                        "appcache-manifest": {
                            ...
                        },
                        "js-libraries": {
                            ...
                        },
                        "deprecations": {
                            ...
                        },
                        "works-offline": {
                            ...
                        },
                        "offline-start-url": {
                            ...
                        },
                        "service-worker": {
                            ...
                        },
                        "installable-manifest": {
                            ...
                        },
                        "redirects-http": {
                            ...
                        },
                        "splash-screen": {
                            ...
                        },
                        "themed-omnibox": {
                            ...
                        },
                        "without-javascript": {
                            ...
                        },
                        "apple-touch-icon": {
                            ...
                        },
                        "maskable-icon": {
                            ...
                        },
                        "aria-hidden-body": {
                            ...
                        },
                        "bypass": {
                            ...
                        },
                        "color-contrast": {
                            ...
                        },
                        "duplicate-id-aria": {
                            ...
                        },
                        "link-name": {
                            ...
                        }
                },
                "scores": {
                    "performance": {
                        ...
                    },
                    "accessibility": {
                        ...
                    },
                    "best-practices": {
                        ...
                    },
                    "seo": {
                        ...
                    },
                    "pwa": {
                        ...
                    }
                },
                "metrics": {
                    "first-contentful-paint": {
                        ...
                    },
                    "first-meaningful-paint": {
                        ...
                    },
                    "largest-contentful-paint": {
                        ...
                    },
                    "load-fast-enough-for-pwa": {
                        ...
                    },
                    "speed-index": {
                        ...
                    },
                    "estimated-input-latency": {
                        ...
                    },
                    "time-to-first-byte": {
                        ...
                    },
                    "server-response-time": {
                        ...
                    },
                    "first-cpu-idle": {
                        ...
                    },
                    "interactive": {
                        ...
                    },
                    "mainthread-work-breakdown": {
                        ...
                    },
                    "bootup-time": {
                        ...
                    },
                    "max-potential-fid": {
                        ...
                    },
                    "total-blocking-time": {
                        ...
                    },
                    "cumulative-layout-shift": {
                        ...
                    },
                    "summary": {
                        ...
                    }
                },
                "h1": "mydomain",
                "lighthousedata": {
                    ...
                    },
                    "lighthouseVersion": "6.1.0",
                    "fetchTime": "",
                    "requestedUrl": "",
                    "finalUrl": "",
                    "runWarnings": [
                        ...
                    ],
                    "audits": {
                        "is-on-https": {
                            ...
                        },
                        "redirects-http": {
                            ...
                        },
                        "service-worker": {
                            ...
                        },
                        "works-offline": {
                            ...
                        },
                        "viewport": {
                            ...
                        },
                        "without-javascript": {
                            ...
                        },
                        "first-contentful-paint": {
                            ...
                        },
                        "largest-contentful-paint": {
                            ...
                        },
                        "first-meaningful-paint": {
                            ...
                        },
                        "load-fast-enough-for-pwa": {
                            ...
                        },
                        "speed-index": {
                            ...
                        },
                        "screenshot-thumbnails": {
                            ...
                        },
                        "final-screenshot": {
                            ...
                        },
                        "estimated-input-latency": {
                            ...
                        },
                        "total-blocking-time": {
                            ...
                        },
                        "max-potential-fid": {
                            ...
                        },
                        "cumulative-layout-shift": {
                            ...
                        },
                        "errors-in-console": {
                            ...
                        },
                        "server-response-time": {
                            ...
                        },
                        "first-cpu-idle": {
                            ...
                        },
                        "interactive": {
                            ...
                        },
                        "user-timings": {
                            ...
                        },
                        "critical-request-chains": {
                            ...
                        },
                        "redirects": {
                            ...
                        },
                        "installable-manifest": {
                            ...
                        },
                        "apple-touch-icon": {
                            ...
                        },
                        "splash-screen": {
                            ...
                        },
                        "themed-omnibox": {
                            ...
                        },
                        "maskable-icon": {
                            ...
                        },
                        "content-width": {
                            ...
                        },
                        "image-aspect-ratio": {
                            ...
                        },
                        "image-size-responsive": {
                            ...
                        },
                        "deprecations": {
                            ...
                        },
                        "mainthread-work-breakdown": {
                            ...
                        },
                        "bootup-time": {
                            ...
                        },
                        "uses-rel-preload": {
                            ...
                        },
                        "uses-rel-preconnect": {
                            ...
                        },
                        "font-display": {
                            ...
                        },
                        "diagnostics": {
                            ...
                        },
                        "network-requests": {
                            ...
                        },
                        "network-rtt": {
                            ...
                        },
                        "network-server-latency": {
                            ...
                        },
                        "main-thread-tasks": {
                            ...
                        },
                        "metrics": {
                            ...
                        },
                        "offline-start-url": {
                            ...
                        },
                        "performance-budget": {
                            ...
                        },
                        "timing-budget": {
                            ...
                        },
                        "resource-summary": {
                            ...
                        },
                        "third-party-summary": {
                            ...
                        },
                        "largest-contentful-paint-element": {
                            ...
                        },
                        "layout-shift-elements": {
                            ...
                        },
                        "long-tasks": {
                            ...
                        },
                        "pwa-cross-browser": {
                            ...
                        },
                        "pwa-page-transitions": {
                            ...
                        },
                        "pwa-each-page-has-url": {
                            ...
                        },
                        "accesskeys": {
                            ...
                        },
                        "aria-allowed-attr": {
                            ...
                        },
                        "aria-hidden-body": {
                            ...
                        },
                        "aria-hidden-focus": {
                            ...
                        },
                        "aria-input-field-name": {
                            ...
                        },
                        "aria-required-attr": {
                            ...
                        },
                        "aria-required-children": {
                            ...
                        },
                        "aria-required-parent": {
                            ...
                        },
                        "aria-roles": {
                            ...
                        },
                        "aria-toggle-field-name": {
                            ...
                        },
                        "aria-valid-attr-value": {
                            ...
                        },
                        "aria-valid-attr": {
                            ...
                        },
                        "button-name": {
                            ...
                        },
                        "bypass": {
                            ...
                        },
                        "color-contrast": {
                            ...
                        },
                        "definition-list": {
                            ...
                        },
                        "dlitem": {
                            ...
                        },
                        "document-title": {
                            ...
                        },
                        "duplicate-id-active": {
                            ...
                        },
                        "duplicate-id-aria": {
                            ...
                        },
                        "form-field-multiple-labels": {
                            ...
                        },
                        "frame-title": {
                            ...
                        },
                        "heading-order": {
                            ...
                        },
                        "html-has-lang": {
                            ...
                        },
                        "html-lang-valid": {
                            ...
                        },
                        "image-alt": {
                            ...
                        },
                        "input-image-alt": {
                            ...
                        },
                        "label": {
                            ...
                        },
                        "layout-table": {
                            ...
                        },
                        "link-name": {
                            ...
                        },
                        "list": {
                            ...
                        },
                        "listitem": {
                            ...
                        },
                        "meta-refresh": {
                            ...
                        },
                        "meta-viewport": {
                            ...
                        },
                        "object-alt": {
                            ...
                        },
                        "tabindex": {
                            ...
                        },
                        "td-headers-attr": {
                            ...
                        },
                        "th-has-data-cells": {
                            ...
                        },
                        "valid-lang": {
                            ...
                        },
                        "video-caption": {
                            ...
                        },
                        "video-description": {
                            ...
                        },
                        "custom-controls-labels": {
                            ...
                        },
                        "custom-controls-roles": {
                            ...
                        },
                        "focus-traps": {
                            ...
                        },
                        "focusable-controls": {
                            ...
                        },
                        "interactive-element-affordance": {
                            ...
                        },
                        "logical-tab-order": {
                            ...
                        },
                        "managed-focus": {
                            ...
                        },
                        "offscreen-content-hidden": {
                            ...
                        },
                        "use-landmarks": {
                            ...
                        },
                        "visual-order-follows-dom": {
                            ...
                        },
                        "uses-long-cache-ttl": {
                            ...
                        },
                        "total-byte-weight": {
                            ...
                        },
                        "offscreen-images": {
                            ...
                        },
                        "render-blocking-resources": {
                            ...
                        },
                        "unminified-css": {
                            ...
                        },
                        "unminified-javascript": {
                            ...
                        },
                        "unused-css-rules": {
                            ...
                        },
                        "unused-javascript": {
                            ...
                        },
                        "uses-webp-images": {
                            ...
                        },
                        "uses-optimized-images": {
                            ...
                        },
                        "uses-text-compression": {
                            ...
                        },
                        "uses-responsive-images": {
                            ...
                        },
                        "efficient-animated-content": {
                            ...
                        },
                        "appcache-manifest": {
                            ...
                        },
                        "doctype": {
                            ...
                        },
                        "charset": {
                            ...
                        },
                        "dom-size": {
                            ...
                        },
                        "external-anchors-use-rel-noopener": {
                            ...
                        },
                        "geolocation-on-start": {
                            ...
                        },
                        "no-document-write": {
                            ...
                        },
                        "no-vulnerable-libraries": {
                            ...
                        },
                        "js-libraries": {
                            ...
                        },
                        "notification-on-start": {
                            ...
                        },
                        "password-inputs-can-be-pasted-into": {
                            ...
                        },
                        "uses-http2": {
                            ...
                        },
                        "uses-passive-event-listeners": {
                            ...
                        },
                        "meta-description": {
                            ...
                        },
                        "http-status-code": {
                            ...
                        },
                        "font-size": {
                            ...
                        },
                        "link-text": {
                            ...
                        },
                        "crawlable-anchors": {
                            ...
                        },
                        "is-crawlable": {
                            ...
                        },
                        "robots-txt": {
                            ...
                        },
                        "tap-targets": {
                            ...
                        },
                        "hreflang": {
                            ...
                        },
                        "plugins": {
                            ...
                        },
                        "canonical": {
                            ...
                        },
                        "structured-data": {
                            ...
                        }
                    },
                    "configSettings": {
                        ...
                    },
                    "categories": {
                        "performance": {
                            ...
                        },
                        "accessibility": {
                            ...
                        },
                        "best-practices": {
                            ...
                        },
                        "seo": {
                            ...
                        },
                        "pwa": {
                            ...
                        }
                    },
                    "categoryGroups": {
                        "metrics": {
                            ...
                        },
                        "load-opportunities": {
                            ...
                        },
                        "budgets": {
                            ...
                        },
                        "diagnostics": {
                            ...
                        },
                        "pwa-fast-reliable": {
                            ...
                        },
                        "pwa-installable": {
                            ...
                        },
                        "pwa-optimized": {
                            ...
                        },
                        "a11y-best-practices": {
                            ...
                        },
                        "a11y-color-contrast": {
                            ...
                        },
                        "a11y-names-labels": {
                            ...
                        },
                        "a11y-navigation": {
                            ...
                        },
                        ...
                    },
                    "timing": {
                        ...
                    },
                    "i18n": {
                        ...
                    },
                    "stackPacks": []
                },
                "body": {
                    ...
                },
                "isMobileFriendly": true
            }
        ]
    }
}

cookies


Returns the cookie analysis report for the requested domain.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token} Parameter: domain

Notice that, the &uri= parameter is optional.

?domain=www.reg-domain.com&uri=contact-us

Response type: JSON
{
    "analysis": [
        {
            "cookie": "cookie-name",
            "value": "cookie-value",
            "domain": ".www.mydomain.com",
            "expires": 1753168297,
            "httpOnly": false,
            "secure": true,
            "session": false,
            "description": "There cookie description when applicable or available."
        },
        ...
    ]
}

securityreport


Returns server's security report for the requested domain.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token} Parameter: domain

Notice that, the &uri= parameter is optional.

?domain=www.reg-domain.com&uri=contact-us

Response type: JSON
{
    "analysis": {
        "host": "https://www.sample-domain.com/wholesale-mobile-phones-c-11056.html?brand=520&from=nav",
        "port": 443,
        "protocol": "http",
        "isPublic": false,
        "status": "READY",
        "startTime": 1595488347719,
        "testTime": 1595488483025,
        "engineVersion": "2.1.5",
        "criteriaVersion": "2009q",
        "endpoints": [
            {
                "ipAddress": "69.192.242.130",
                "serverName": "a69-192-242-130.deploy.static.akamaitechnologies.com",
                "statusMessage": "Ready",
                "grade": "A",
                "gradeTrustIgnored": "A",
                "hasWarnings": false,
                "isExceptional": false,
                "progress": 100,
                "duration": 135216,
                "delegation": 2,
                "details": {
                    "hostStartTime": 1595488347719,
                    "certChains": [
                        {
                            "id": "70e768ce2e94c56053a7d3b7d031b5c46f8aa86a060d8d16cc762c9ea9584db0",
                            "certIds": [
                                "318bffff0d217f128652dcca8c699d16b0b970138b477fcec8be4a540f8ed795",
                                "154c433c491929c5ef686e838e323664a00e6a0d822ccc958fb4dab03e49a08f"
                            ],
                            "trustPaths": [
                                {
                                    "certIds": [
                                        "318bffff0d217f128652dcca8c699d16b0b970138b477fcec8be4a540f8ed795",
                                        "154c433c491929c5ef686e838e323664a00e6a0d822ccc958fb4dab03e49a08f",
                                        "4348a0e9444c78cb265e058d5e8944b4d84f9662bd26db257f8934a443c70161"
                                    ],
                                    "trust": [
                                        {
                                            "rootStore": "Mozilla",
                                            "isTrusted": true
                                        }
                                    ]
                                },
                                ...
                            ],
                            "issues": 0,
                            "noSni": false
                        }
                    ],
                    "protocols": [
                        {
                            "id": 771,
                            "name": "TLS",
                            "version": "1.2"
                        },
                        ...
                    ],
                    "suites": [
                        {
                            "protocol": 771,
                            "list": [
                                {
                                    "id": 49200,
                                    "name": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
                                    "cipherStrength": 256,
                                    "kxType": "ECDH",
                                    "kxStrength": 3072,
                                    "namedGroupBits": 256,
                                    "namedGroupId": 23,
                                    "namedGroupName": "secp256r1"
                                },
                                ...
                            ],
                            "preference": true,
                            "chaCha20Preference": true
                        },
                        {
                            "protocol": 772,
                            "list": [
                                {
                                    "id": 4866,
                                    "name": "TLS_AES_256_GCM_SHA384",
                                    "cipherStrength": 256,
                                    "kxType": "ECDH",
                                    "kxStrength": 3072,
                                    "namedGroupBits": 256,
                                    "namedGroupId": 29,
                                    "namedGroupName": "x25519"
                                },
                                ...
                            ],
                            "preference": true,
                            "chaCha20Preference": true
                        }
                    ],
                    "namedGroups": {
                        "list": [
                            {
                                "id": 23,
                                "name": "secp256r1",
                                "bits": 256,
                                "namedGroupType": "EC"
                            },
                            ...
                        ],
                        "preference": true
                    },
                    "serverSignature": "nginx",
                    "prefixDelegation": true,
                    "nonPrefixDelegation": false,
                    "vulnBeast": false,
                    "renegSupport": 2,
                    "sessionResumption": 2,
                    "compressionMethods": 0,
                    "supportsNpn": true,
                    "npnProtocols": "http/1.1 http/1.0",
                    "supportsAlpn": true,
                    "alpnProtocols": "h2 h2-14 http/1.1",
                    "sessionTickets": 1,
                    "ocspStapling": true,
                    "staplingRevocationStatus": 2,
                    "sniRequired": false,
                    "httpStatusCode": 200,
                    "supportsRc4": false,
                    "rc4WithModern": false,
                    "rc4Only": false,
                    "forwardSecrecy": 4,
                    "supportsAead": true,
                    "protocolIntolerance": 0,
                    "miscIntolerance": 0,
                    "sims": {
                        "results": [
                            {
                                "client": {
                                    "id": 100,
                                    "name": "IE",
                                    "platform": "XP",
                                    "version": "6",
                                    "isReference": false
                                },
                                "errorCode": 1,
                                "errorMessage": "Protocol mismatch (not simulated)",
                                "attempts": 0
                            },
                            ...
                        ]
                    },
                    "heartbleed": false,
                    "heartbeat": false,
                    "openSslCcs": 1,
                    "openSSLLuckyMinus20": 1,
                    "ticketbleed": 1,
                    "bleichenbacher": 1,
                    "poodle": false,
                    "poodleTls": 1,
                    "fallbackScsv": true,
                    "freak": false,
                    "hasSct": 1,
                    "ecdhParameterReuse": false,
                    "logjam": false,
                    "chaCha20Preference": true,
                    "hstsPolicy": {
                        "LONG_MAX_AGE": 15552000,
                        "status": "absent",
                        "directives": {}
                    },
                    "hstsPreloads": [
                        {
                            "source": "Chrome",
                            "hostname": "www.sample-domain.com",
                            "status": "absent",
                            "sourceTime": 1595487242065
                        },
                        ...
                    ],
                    "hpkpPolicy": {
                        "status": "absent",
                        "pins": [],
                        "matchedPins": [],
                        "directives": []
                    },
                    "hpkpRoPolicy": {
                        "status": "absent",
                        "pins": [],
                        "matchedPins": [],
                        "directives": []
                    },
                    "staticPkpPolicy": {
                        "status": "absent",
                        "pins": [],
                        "matchedPins": [],
                        "forbiddenPins": [],
                        "matchedForbiddenPins": []
                    },
                    "httpTransactions": [
                        {
                            "requestUrl": "https://www.sample-domain.com/",
                            "statusCode": 200,
                            "requestLine": "GET / HTTP/1.1",
                            "responseLine": "HTTP/1.1 200 OK",
                            "responseHeadersRaw": [
                                "Server: nginx",
                                "Content-Type: text/html; charset=utf-8",
                                "P3P: CP=\"NOI ADM DEV PSAi COM NAV OUR OTRo STP IND DEM\"",
                                "Pragma: public",
                                "X-Akamai-Transformed: 9 - 0 pmb=mTOE,1",
                                "Cache-Control: max-age=78358",
                                "Expires: Fri, 24 Jul 2020 04:58:31 GMT",
                                "Date: Thu, 23 Jul 2020 07:12:33 GMT",
                                "Transfer-Encoding:  chunked",
                                "Connection: close",
                                "Connection: Transfer-Encoding",
                                "Set-Cookie: akaas_WWWABTe...",
                                "Set-Cookie: bm_sz=8BE062F...",
                                "Set-Cookie: _abck=BB248D8..."
                            ],
                            "responseHeaders": [
                                {
                                    "name": "Server",
                                    "value": "nginx"
                                },
                                ...
                            ],
                            "fragileServer": false
                        }
                    ],
                    "drownHosts": [
                        {
                            "ip": "255.255.255.255",
                            "export": true,
                            "port": 443,
                            "special": true,
                            "sslv2": true,
                            "status": "handshake_failure"
                        },
                        ...
                    ],
                    "drownErrors": false,
                    "drownVulnerable": false,
                    "implementsTLS13MandatoryCS": true,
                    "zeroRTTEnabled": 0,
                    "zombiePoodle": 1,
                    "goldenDoodle": 1,
                    "supportsCBC": true,
                    "zeroLengthPaddingOracle": 1,
                    "sleepingPoodle": 1
                }
            }
        ],
        "certs": [
            {
                "id": "318bffff0d217f128652dcca8c699d16b0b970138b477fcec8be4a540f8ed795",
                "subject": "CN=*.sample-domain.com, OU=IT, O=\"Guangzhou sample-domain Technology Co., Ltd.\", L=Guangzhou, ST=Guangdong Province, C=CN",
                "serialNumber": "08d5ab91ac2a43f7cdc63a3fa4aca208",
                "commonNames": [
                    "*.sample-domain.com"
                ],
                "altNames": [
                    "*.sample-domain.com",
                    "sample-domain.com"
                ],
                "notBefore": 1590019200000,
                "notAfter": 1629460800000,
                "issuerSubject": "CN=DigiCert SHA2 Secure Server CA, O=DigiCert Inc, C=US",
                "sigAlg": "SHA256withRSA",
                "revocationInfo": 3,
                "crlURIs": [
                    "http://crl3.digicert.com/ssca-sha2-g6.crl"
                ],
                "ocspURIs": [
                    "http://ocsp.digicert.com"
                ],
                "revocationStatus": 2,
                "crlRevocationStatus": 2,
                "ocspRevocationStatus": 2,
                "dnsCaa": false,
                "mustStaple": false,
                "sgc": 0,
                "issues": 0,
                "sct": true,
                "sha1Hash": "66e5fc7258f130f5cefe08f71d24db25e5234c23",
                "sha256Hash": "318bffff0d217f128652dcca8c699d16b0b970138b477fcec8be4a540f8ed795",
                "pinSha256": "dlPHyLsdUbbIv91x1NAuZ/EHft+2NQTm3CnQ/l1JGkY=",
                "keyAlg": "RSA",
                "keySize": 2048,
                "keyStrength": 2048,
                "keyKnownDebianInsecure": false,
                "raw": "-----BEGIN CERTIFICATE-----\nMIIGVzCCBT+gAwI==\r\n-----END CERTIFICATE-----\n"
            },
            ...
        ]
    }
}

subscriptions


Returns the list of owned subscriptions for the requested domain.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token}
Response type: JSON
[
    {
        "subscriptionId": "bd22fe20-7cad-428e-a218-866c95816ac5",
        "subscriptionDate": "2020-07-18 10:16:44",
        "subscriptionExpires": "2021-07-18 00:00:00",
        "name": "Basic",
        "maxApiCallsPerMonth": 300,
        "enableScreenshot": 1,
        "enableColorAnalysis": 1,
        "enableTextAnalysis": 1,
        "enableSeoAnalysis": 1,
        "enableSecurityAnalysis": 1,
        "enableCookieAnalysis": 1,
        "maxTotalDomain": 4,
        "maxTotalUri": 20
    }
]

domainlist


Returns the list of registered domains and URIs sorted by package.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token}
Response type: JSON
[
    {
        "domainId": "0a4e4b5c-2aaf-492a-85a6-5bba9e3b7865",
        "protocol": "https",
        "domain": "www.sample-domain.com",
        "uri": "contact-us",
        "registrationDate": "2020-07-23 08:02:16",
        "packageName": "Basic"
    },
    ...
]

registerdomain


Register a new domain for a subscription.

PUT

Body: x-www-form-urlencoded Header: Accept: application/json Bearer: {token} Body: protocol and domain
Response type: JSON
{
    "id": "85ca2dab-ebb1-4f58-aab4-219f1411c1a1",
    "protocol": "https",
    "domain": "mynewdomain.com",
    "uri": "/"
}

registeruri


Register a new URI for a domain.

PUT

Body: x-www-form-urlencoded Header: Accept: application/json Bearer: {token} Body: protocol, domainid and uri
Response type: JSON
{
    "id": "682e83f7-4272-48c7-949b-4307f50c8cae",
    "protocol": "https",
    "domain": "sample-domain.com",
    "uri": "contact-us?example=sample&exp2=sample/test"
}

analysislist


Get the list of dates in which your subscription entries were analyzed.

GET

Content-Type: Accept: application/json Header: Accept: application/json Bearer: {token}
Response type: JSON
[
    {
        "processDate": "2020-09-03 15:31:19",
        "protocol": "https",
        "domain": "sample-domain.com",
        "uri": "/"
    },
    ...
]

postcodelocation


Returns longitude and latitude for a PostCode/ZIP Code. Currently supports only USA, UK and Brazil codes.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token} Parameter: postcode

Notice that, %20 is used to define spaces on URL.

?postcode=SO50%205LN

Response type: JSON
{
    "postcode": "SO50 5LN",
    "alpha2code": "UK",
    "city": "Eastleigh",
    "latitude": 50.9697,
    "longitude": -1.36025
}

countrydetails


Returns country information such as top domains, approx. population, language, flag, timezones, etc. Query by alpha2code.

GET

Header: Content-type: application/json Header: Accept: application/json Bearer: {token} Parameter: country
?country=DE

Response type: JSON
{
    "country_name": "Germany",
    "native_name": "Deutschland",
    "top_level_domain": "[\".de\"]",
    "alpha2code": "DE",
    "alpha3code": "DEU",
    "numeric_code": 276,
    "currencies": "[\"EUR\"]",
    "calling_codes": "[\"49\"]",
    "capital": "Berlin",
    "alternative_spelling": "[\"DE\",\"Federal Republic of Germany\",\"Bundesrepublik Deutschland\"]",
    "region": "Europe",
    "subregion": "Western Europe",
    "languages": "[\"German\"]",
    "languages_iso": "[\"de\"]",
    "translations":"{\"de\":\"Deutschland\",\"es\":\"Alemania\",\"fr\":\"Allemagne\",\"it\":\"Germania\",\"ja\":\"\ド\イ\ツ\",\"nl\":\"Duitsland\",\"hr\":\"Njema\čka\"}",
    "population": 81083600,
    "latlng": "51,9",
    "demonym": "German",
    "border_countries_iso": "[\"AUT\",\"BEL\",\"CZE\",\"DNK\",\"FRA\",\"LUX\",\"NLD\",\"POL\",\"CHE\"]",
    "area": 357114,
    "gini": "28.3",
    "timezones": "[\"UTC+01:00\"]",
    "flag_svg_base64": "data:image/svg+xml;base64,PD94bWwgdmV..."
}

Support


We are always improving the quality and usability of our tools. Let us know if you require assistence with our API.


Contact us