Python wrapper for the SimilarWeb API.
Available at PyPi, the recommended installation method is with pip:
$ pip install similarweb
Create a client object for the API you'd like to use:
- Traffic:
traffic_client = TrafficClient("your_api_key") - Content:
content_client = ContentClient("your_api_key") - Sources:
sources_client = SourcesClient("your_api_key") - Mobile:
mobile_client = MobileClient("your_api_key")
Let's set up the traffic client object and some variables we'll be using throughout:
>>> from similarweb import TrafficClient
>>> traffic_client = TrafficClient("my_api_key")
>>> url = "example.com" # <~ no "www." or "http://"
>>> gr = "monthly" # <~ or "weekly" or "daily"
>>> start_month = "11-2014" # <~ M-YYYY
>>> end_month = "12-2014" # <~ M-YYYY
>>> md = False # or True if you want main domain ONLY
Get the number of estimated visits for the requested domain with visits:
>>> traffic_client.visits(url, gr, start_month, end_month, md)
{"2014-11-01": 123456789, "2014-12-01": 123456788}
Get the global rank, country rank, traffic geography, traffic reach and traffic sources distribution with traffic:
>>> traffic_client.traffic(url)
{
"GlobalRank": 2,
"CountryCode": 840,
"CountryRank": 1,
"TopCountryShares": {
"840": 0.4321,
"356": 0.3210,
# ... many more country code-share pairs
"876": 6.8674e-7,
"10": 0
},
"TrafficReach": {
"01/08/2014": 0.1234,
"08/08/2014": 0.1233,
# ... many more date-reach pairs
"23/01/2015": 0.1232,
"30/01/2015": 0.1231
},
"TrafficShares": {
"Search": 0.1043,
"Social": 0.0302,
"Mail": 0.0041,
"Paid Referrals": 0.0016,
"Direct": 0.6771,
"Referrals": 0.1826
},
"Date": "01/2015"
}
Get the average pageviews for the requested domains with page_views:
>>> traffic_client.page_views(url, gr, start_month, end_month, md)
{"2014-11-01": 14.1234, "2014-12-01": 14.1233}
Get the average visit duration at the requested domain with visit_duration:
>>> traffic_client.visit_duration(url, gr, start_month, end_month, md)
{"2014-11-01": 987.654321, "2014-12-01": 987.654320}
Get the average bounce rate for the requested domain with bounce_rate:
>>> traffic_client.bounce_rate(url, gr, start_month, end_month, md)
{"2014-11-01": 0.1234, "2014-12-01": 0.1233}
Let's set up the content client object and some variables we'll be using throughout:
>>> from similarweb import ContentClient
>>> content_client = ContentClient("my_api_key")
>>> url = "example.com" # <~ no "www" or "http://"
Get sites similar to the requested domain and their respective similarity scores with similar_sites:
>>> content_client.similar_sites(url)
{"example2.com": 0.9988776655,
"example3.com": 0.987654321,
# many other similar sites and their similarity scores...
"exampleN.com": 0.2109876543}
Get sites and their affinity scores frequently visited by users of the requested domain with also_visited:
>>> content_client.also_visited(url)
{"example2.com": 0.00123456,
"example3.com": 0.00012345,
# many other frequently-visited sites and their frequency scores...
"exampleN.com": 0.00001234}
Get tags and their scores for the requested domain with tags:
>>> content_client.tags(url)
{"shrimp": 0.987654321,
"white wine": 0.987654320,
# many other tags and their scores...
"dilly": 0.098765432}
Get the category for the requested domain with category:
>>> content_client.category(url)
{"Category": "Shrimp/White Wine"}
Get the category and rank for the requested domain with category_rank:
>>> content_client.category_rank(url)
{"Category": "Shrimp/White Wine",
"CategoryRank": 1}
Let's set up the sources client object and some variables we'll be using throughout:
>>> from similarweb import SourcesClient
>>> sources_client = SourcesClient("my_api_key")
>>> url = "example.com" # <~ no "www." or "http://"
>>> page = 1 # <~ increase to 2, 3, 4... for more results
>>> gr = "monthly" # <~ or "weekly" or "daily"
>>> start_month = "11-2014" # <~ M-YYYY
>>> end_month = "12-2014" # <~ M-YYYY
>>> md = False # or True if you want main domain ONLY
Get the leading social referral sites for the url with social_referrals:
>>> sources_client.social_referrals(url)
{"SocialSources":
[
{"Source": "Facebook",
"Value": 0.54321},
{"Source": "Reddit",
"Value": 0.43210},
# etc...
]
"StartDate": "12/2014",
"EndDate": "02/2015"
}
Get the organic search keywords for the url with organic_search_keywords:
>>> sources_client.organic_search_keywords(url, start_month, end_month, md, page)
{"Data":
[
{"SearchTerm": "example",
"Visits": 0.4321,
"Change": 0.1057},
{"SearchTerm": "demo",
"Visits": 0.1234,
"Change": -0.0856},
# etc...
]
"ResultsCount": 10,
"TotalCount": 12345,
"Next": "http://api.similarweb.com/Site/example.com/v1/orgsearch?start=11-2014&end=12-2014&md=false&UserKey=my_api_key&page=2"
}
Get the paid search keywords for the url with paid_search_keywords:
>>> sources_client.paid_search_keywords(url, start_month, end_month, md, page)
{"Data":
[
{"SearchTerm": "example",
"Visits": 0.0034,
"Change": -0.0812},
{"SearchTerm": "demo",
"Visits": 0.0026,
"Change": 0.0452},
# etc...
]
"ResultsCount": 10,
"TotalCount": 164,
"Next": "http://api.similarweb.com/Site/example.com/v1/paidsearch?start=11-2014&end=12-2014&md=false&UserKey=my_api_key&page=2"
}
Get the leading destination sites for the url with destinations:
>>> sources_client.destinations(url)
{"Sites":
[
"cooldemosite.com",
"otherexample.com",
"shrimp.com",
# etc...
],
"StartDate": "12/2014",
"EndDate": "02/2015"
}
Get the organic keyword competitors for the url with organic_keyword_competitors:
>>> sources_client.organic_keyword_competitors(url, start_month, end_month, md, page)
{"Data":
[
{"Domain": "versusexample.com",
"Score": 0.1176},
{"Domain": "anothercompetitor.com",
"Score": 0.0945},
# etc...
]
"ResultsCount": 10,
"TotalCount": 1391,
"Next": "http://api.similarweb.com/Site/example.com/v1/orgkwcompetitor?start=11-2014&end=12-2014&md=false&UserKey=my_api_key&page=2"
}
Get the paid keyword competitors for the url with paid_keyword_competitors:
>>> sources_client.paid_keyword_competitors(url, start_month, end_month, md, page)
{"Data":
[
{"Domain": "wehateexample.com",
"Score": 0.0791},
{"Domain": "yeahthoseguysaretheworst.com",
"Score": 0.04611},
# etc...
]
"ResultsCount": 10,
"TotalCount": 476,
"Next": "http://api.similarweb.com/Site/example.com/v1/paidkwcompetitor?start=11-2014&end=12-2014&md=false&UserKey=my_api_key&page=2"
}
Let's set up the mobile client object and some variables we'll be using throughout:
>>> from similarweb import MobileClient
>>> mobile_client = MobileClient("my_api_key")
>>> app_id = "com.examplestudios.example" # <~ or "123456789"-format for apple
>>> store = "google" # <~ or "apple"
>>> url = "example.com" # <~ no "www." or "http://"
Get the app details (a Google example) with app_details:
>>> mobile_client.app_details(app_id, store)
{
"Title": "Example App",
"Cover": "http://example.com/cover",
"Author": "Example Studios",
"Price": "Free",
"Main Category": "Communication",
"MainCategoryId": "communication",
"Rating": 4.22
}
Get the app details with app_details for an Apple app:
>>> mobile_client.app_details("123456789", "apple")
{
"Title": "Example App",
"Cover": "http://example.com/cover",
"Author": "Example Studios",
"Price": "Free",
"Main Category": "Communication",
"MainCategoryId": "communication",
"Rating": 4.09
}
Get the Google Play Store app installs (as a range) with google_app_installs:
>>> mobile_client.google_app_installs(app_id)
{
"InstallsMin": 100000,
"InstallsMax": 500000
}
Get the apps related to a certain site (a Google example) with site_related_apps:
>>> mobile_client.site_related_apps("google.com", "google")
{
"com.google.android.youtube": "YouTube",
"com.google.android.apps.maps": "Maps",
"com.google.android.gms": "Google Play Series",
# ... etc.
}
Get the apps related to a certain site with site_related_apps for Apple:
>>> mobile_client.site_related_apps("apple.com", "apple")
{
"284417350": "Remote",
"364709193": "iBooks",
"376101648": "Find My iPhone",
# ... etc.
}