urlscan.py

# Code by github user vector-sec
# https://github.com/vector-sec

from __future__ import print_function
import requests,json

class UrlScan:

    def __init__(self,apikey="",url="",useragent=None,referer=None,public=True):
        assert len(apikey) > 0, "API key must be defined"
        assert len(url) > 0, "Url must be defined"
        assert type(public) == type(True), "Public must be a boolean"
        self.apikey = apikey
        self.url = url
        self.useragent = useragent
        self.referer = referer
        self.public = public
        self.scanid = None

    def submit(self):
        header = {'API-Key':self.apikey}
        req = {"url":self.url}
        if self.useragent is not None:
            req['useragent'] = self.useragent
        if self.public:
            req['public'] = "on"
        if self.referer is not None:
            req['referer'] = self.referer
        s = requests.post("https://urlscan.io/api/v1/scan/",data=req,headers=header)
        if s.status_code == 200:
            self.scanid = json.loads(s.text)['uuid']
        else:
            raise Exception('Non-200 respond: %s - %s' % s.status_code,s.text)

    def checkStatus(self):
        header = {'API-Key':self.apikey}
        if self.scanid is None:
            raise Exception("Scan has not been submitted yet, call submit() first")
        r = requests.get("https://urlscan.io/api/v1/result/%s/" % self.scanid,headers=header)
        if r.status_code == 404:
            raise Exception("Scan has not completed yet")

    def getDom(self):
        self.checkStatus()
        header = {'API-Key':self.apikey}
        dom = requests.get("https://urlscan.io/dom/%s/" % self.scanid,headers=header)
        if dom.status_code == 200:
            return dom.text
        else:
            raise Exception('Non-200 respond: %s - %s' % dom.status_code,dom.text)

    def getScreenshot(self):
        self.checkStatus()
        header = {'API-Key':self.apikey}
        screen = requests.get("https://urlscan.io/screenshots/%s.png" % self.scanid,headers=header)
        if screen.status_code == 200:
            return screen.content
        else:
            raise Exception('Non-200 respond: %s - %s' % screen.status_code,screen.text)

    # I added getReport and getJson method to vector-sec's code

    # def getReport(self):
    #     self.checkStatus()
    #     header = {'API-Key':self.apikey}
    #     result = requests.get("https://urlscan.io/result/%s/" % self.scanid,headers=header)
    #     if result.status_code == 200:
    #         return result.text
    #     else:
    #         raise Exception('Non-200 respond: %s - %s' % result.status_code,result.text)

    def getJson(self):
        self.checkStatus()
        header = {'API-Key':self.apikey}
        json = requests.get("https://urlscan.io/api/v1/result/%s/" % self.scanid,headers=header)
        if json.status_code == 200:
            return json.json()
        else:
            raise Exception('Non-200 respond: %s - %s' % json.status_code,json.text)

    def __repr__(self):
        return "<UrlScan(url='%s', useragent='%s', referer='%s', public='%s', scanid='%s'>" % (self.url,self.useragent,self.referer,self.public,self.scanid)