{
    "info": {
        "author": "Ryan Liao",
        "author_email": "pirsquare.ryan@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Web Environment",
            "Intended Audience :: Developers",
            "Operating System :: OS Independent",
            "Programming Language :: Python"
        ],
        "description": "# SimilarWeb-Python\r\n[![Build Status](https://travis-ci.org/audiencepi/SimilarWeb-Python.svg?branch=master)](https://travis-ci.org/audiencepi/SimilarWeb-Python)\r\nPython wrapper for [SimilarWeb API](https://developer.similarweb.com/estimated_visits_api) .\r\n\r\n## Supported API\r\n- [Traffic API](https://developer.similarweb.com/estimated_visits_api)\r\n- [Rank and Reach API](https://developer.similarweb.com/rank_reach)\r\n- [Engagement API](https://developer.similarweb.com/websites_traffic_and_engagement_pro_api)\r\n- [Similar Websites API](https://developer.similarweb.com/similar_websites_api)\r\n- [Also Visited API](https://developer.similarweb.com/also_visited_api)\r\n- [Website Tags API](https://developer.similarweb.com/website_tags_api)\r\n- [Website Categorization API](https://developer.similarweb.com/website_categorization_API)\r\n- [Category Rank API](https://developer.similarweb.com/category_rank_api)\r\n- [Top Sites API](https://developer.similarweb.com/top_sites)\r\n- [Social Referrals API](https://developer.similarweb.com/social_referrals_api)\r\n- [Search Keywords API](https://developer.similarweb.com/keywords_api)\r\n- [Destinations API](https://developer.similarweb.com/destinations_api)\r\n- [Referrals API](https://developer.similarweb.com/referring_websites_pro_api)\r\n- [Keyword Competitors API](https://developer.similarweb.com/organic_paid_search_comptetitors_pro_api)\r\n- [APP Details API](https://developer.similarweb.com/mobile_api_app_details)\r\n- [Google Play Installs API](https://developer.similarweb.com/mobile_api_app_installs)\r\n- [Related Site Apps API](https://developer.similarweb.com/mobile_api_related_apps)\r\n\r\n\r\n## Installation\r\n\r\n    pip install SimilarWeb-Python\r\n\r\n## Examples\r\n```python\r\nimport similarweb\r\n\r\n# Parameters\r\napi_key = YOUR_API_KEY\r\ndomain = \"similarweb.com\"\r\nstart_month = \"1-2015\" # in format M-YYYY\r\nend_month = \"2-2015\" # in format M-YYYY\r\ntime_granularity = \"MONTHLY\" # Can be: Daily, Weekly, Monthly\r\nmain_domain_only = False # get metrics on the main domain only?\r\n\r\n#================================\r\n# TrafficAPI\r\n#================================\r\nclient = similarweb.TrafficAPI(api_key, domain, start_month,\r\n                               end_month, time_granularity,\r\n                               main_domain_only)\r\nresults = client.query()\r\n\r\n#================================\r\n# RankAndReachAPI\r\n#================================\r\nclient = similarweb.RankAndReachAPI(api_key, domain)\r\nresults = client.query()\r\n\r\n#================================\r\n# EngagementAPI\r\n#================================\r\nendpoint = \"pageviews\" # Can be: pageviews, visitduration, bouncerate\r\nclient = similarweb.EngagementAPI(api_key, endpoint, domain,\r\n                                  start_month, end_month,\r\n                                  time_granularity, main_domain_only)\r\nresults = client.query()\r\n\r\n#================================\r\n# SimilarWebsitesAPI\r\n#================================\r\nclient = similarweb.SimilarWebsitesAPI(api_key, domain)\r\nresults = client.query()\r\n\r\n#================================\r\n# AlsoVisitedAPI\r\n#================================\r\nclient = similarweb.AlsoVisitedAPI(api_key, domain)\r\nresults = client.query()\r\n\r\n#================================\r\n# WebsiteTagsAPI\r\n#================================\r\nclient = similarweb.WebsiteTagsAPI(api_key, domain)\r\nresults = client.query()\r\n\r\n#================================\r\n# WebsiteCategorizationAPI\r\n#================================\r\nclient = similarweb.WebsiteCategorizationAPI(api_key, domain)\r\nresults = client.query()\r\n\r\n#================================\r\n# CategoryRankAPI\r\n#================================\r\nclient = similarweb.CategoryRankAPI(api_key, domain)\r\nresults = client.query()\r\n\r\n#================================\r\n# TopSitesAPI\r\n#================================\r\n# If left blank, `All Categories` will be requested.\r\n# Use `http://api.similarweb.com/v1/TopSites/categories`\r\n# to get a list of available categories.\r\ncategory = \"Shopping~Sports\"\r\n\r\n# If left blank, `Worldwide` will be requested.\r\n# Use `http://api.similarweb.com/v1/TopSites/countries`\r\n# to get a list of available categories.\r\ncountry = \"United States\"\r\nclient = similarweb.TopSitesAPI(api_key, domain, category, country)\r\nresults = client.query()\r\n\r\n#================================\r\n# SocialReferralsAPI\r\n#================================\r\nclient = similarweb.SocialReferralsAPI(api_key, domain)\r\nresults = client.query()\r\n\r\n#================================\r\n# SearchKeywordsAPI\r\n#================================\r\nendpoint = \"orgsearch\" # Can be: orgsearch, paidsearch\r\nresults_page = 2 # Enter for more than 10 results\r\nclient = similarweb.SearchKeywordsAPI(api_key, endpoint, domain,\r\n                                      start_month, end_month,\r\n                                      main_domain_only, results_page)\r\nresults = client.query()\r\n\r\n#================================\r\n# DestinationsAPI\r\n#================================\r\nclient = similarweb.DestinationsAPI(api_key, domain)\r\nresults = client.query()\r\n\r\n#================================\r\n# ReferralsAPI\r\n#================================\r\nresults_page = 2 # Enter for more than 10 results\r\nclient = similarweb.ReferralsAPI(api_key, domain, start_month,\r\n                                 end_month, main_domain_only,\r\n                                 results_page)\r\nresults = client.query()\r\n\r\n#================================\r\n# KeywordCompetitorsAPI\r\n#================================\r\nendpoint = \"orgkwcompetitor\" # Can be: orgkwcompetitor, paidkwcompetitor\r\nresults_page = 2 # Enter for more than 10 results\r\nclient = similarweb.KeywordCompetitorsAPI(api_key, endpoint,\r\n                                          domain, start_month,\r\n                                          end_month, main_domain_only, results_page)\r\nresults = client.query()\r\n\r\n#================================\r\n# AppDetailsAPI\r\n#================================\r\napp_id = \"com.yahoo.mobile.client.android.mail\" # ID of the app\r\napp_store_id = 0 # 0 for Google Play Store, 1 for iOS AppStore\r\nclient = similarweb.AppDetailsAPI(api_key, app_id, app_store_id)\r\nresults = client.query()\r\n\r\n#================================\r\n# GoogleAppInstallsAPI\r\n#================================\r\nclient = similarweb.GoogleAppInstallsAPI(api_key, app_id)\r\nresults = client.query()\r\n\r\n#================================\r\n# RelatedSiteAppsAPI\r\n#================================\r\nclient = similarweb.RelatedSiteAppsAPI(api_key, domain, app_store_id)\r\nresults = client.query()\r\n```\r\n\r\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/audiencepi/SimilarWeb-Python",
        "keywords": null,
        "license": "MIT",
        "maintainer": null,
        "maintainer_email": null,
        "name": "SimilarWeb-Python",
        "package_url": "https://pypi.org/project/SimilarWeb-Python/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/SimilarWeb-Python/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/audiencepi/SimilarWeb-Python"
        },
        "release_url": "https://pypi.org/project/SimilarWeb-Python/0.0.3/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Python Wrapper for SimilarWeb API",
        "version": "0.0.3"
    },
    "last_serial": 1785048,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "50b0ac6260f8d3212e61faef3f1b5132",
                    "sha256": "7a0771085458d3a4cd8f5164939f8921f95021c3af448aeea8e5b2b0614e3ce1"
                },
                "downloads": -1,
                "filename": "SimilarWeb-Python-0.0.1.zip",
                "has_sig": false,
                "md5_digest": "50b0ac6260f8d3212e61faef3f1b5132",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9577,
                "upload_time": "2015-05-06T22:13:32",
                "url": "https://files.pythonhosted.org/packages/93/83/15be4428512363a7a71f216aa71fbfdebf1e9a78f79d7adf0b6458aaf2f6/SimilarWeb-Python-0.0.1.zip"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "549e7302b4373c0eb54909d437db6bcc",
                    "sha256": "e1bfeb84e25adb50e5e9c81a64f0f892136ac38513ef50c173e98d73f7f45009"
                },
                "downloads": -1,
                "filename": "SimilarWeb-Python-0.0.2.zip",
                "has_sig": false,
                "md5_digest": "549e7302b4373c0eb54909d437db6bcc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9533,
                "upload_time": "2015-05-06T22:25:36",
                "url": "https://files.pythonhosted.org/packages/90/ea/dcedcff5df8478a91f66f297e3ba40584c9e5deb8dabb3105660485cf81a/SimilarWeb-Python-0.0.2.zip"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5f7bba2e4537d6d2bd625eaca12a0366",
                    "sha256": "b65aec8b5aad1affee2656651c64b03ab0079490491147a05239a25585ddd7c9"
                },
                "downloads": -1,
                "filename": "SimilarWeb-Python-0.0.3.zip",
                "has_sig": false,
                "md5_digest": "5f7bba2e4537d6d2bd625eaca12a0366",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9399,
                "upload_time": "2015-10-25T09:23:33",
                "url": "https://files.pythonhosted.org/packages/7f/56/04136619fa8bf997c5bc8eafa82aa4678f8140ae7a624621f4a853fa7e5d/SimilarWeb-Python-0.0.3.zip"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5f7bba2e4537d6d2bd625eaca12a0366",
                "sha256": "b65aec8b5aad1affee2656651c64b03ab0079490491147a05239a25585ddd7c9"
            },
            "downloads": -1,
            "filename": "SimilarWeb-Python-0.0.3.zip",
            "has_sig": false,
            "md5_digest": "5f7bba2e4537d6d2bd625eaca12a0366",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9399,
            "upload_time": "2015-10-25T09:23:33",
            "url": "https://files.pythonhosted.org/packages/7f/56/04136619fa8bf997c5bc8eafa82aa4678f8140ae7a624621f4a853fa7e5d/SimilarWeb-Python-0.0.3.zip"
        }
    ]
}