A library to simplify the access to the REST API of similarweb.
Project description
similarweb REST API
Introduction
The similarweb REST API is a library that simplifies the access to the REST API of Similarweb.
Installation
To install the library, run the following command:
Copy code
pip install similarweb-rest-api
Usage
To use the library, import the SimilarwebApi class and create an instance of it. Then, use the get method to make a request to the API.
from similarweb_rest_api import SimilarwebApi
api = SimilarwebApi()
response = api.get('website/traffic', domain='example.com', start_date='2020-01-01', end_date='2020-01-31')
The get method returns a SimilarwebResponse object, which contains the API response in various formats. To access the response in a specific format, use one of the following methods:
to_json: returns the response as a JSON string to_dataframe: returns the response as a Pandas DataFrame to_sql: returns an SQL statement to insert the response into a table to_xml: returns the response as an XML document to_excel: writes the response to an Excel file to_csv: writes the response to a CSV file to_html: returns the response as an HTML table to_jsonl: writes the response to a JSON Lines file to_yaml: returns the response as a YAML document
For example, to convert the response to a DataFrame and display the first 5 rows:
df = response.to_dataframe()
df.head()
Parameters
The following parameters can be passed to the get function:
name: The name of the API endpoint. domain: The domain to get data for. api_key: Your API key. start_date: The start date for the data range (in the format YYYY-MM). end_date: The end date for the data range (in the format YYYY-MM).
License
This library is free to use for non-commercial purposes. For commercial use, please contact the author for permission.
Contact
If you have any questions or suggestions, please contact the author Damien Frigewski at dfrigewski@gmail.com.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for similarweb_rest_api-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 763e2287ca64158eabc840179ae1af507cfb3ad5791f6a609d8886a504361474 |
|
MD5 | 3bf6116df08ef7c973cc35ccc7c0d641 |
|
BLAKE2b-256 | cee8bed28f054ba6a9b745ca5cddb5c9598e374fc65f2d11aa179462e3c91f9e |
Hashes for similarweb_rest_api-0.0.2-py3.11.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f191ad930b4f8e09907078eea5dc072f544a676567872d74ee8c699a1f1d44e |
|
MD5 | 732289f7ad81a1e7bdf68570c7cbf328 |
|
BLAKE2b-256 | ca58a950b752ac6fcb0aa6b810d6f626765d0083f13d66c1401ee1861845968a |
Hashes for similarweb_rest_api-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc35de3355dbacc6689ecb4d2661092877e58963f7921e519bbab4b551c0ae8f |
|
MD5 | 41251cc505a25667dc3bd77f4a8da079 |
|
BLAKE2b-256 | d47d51fcf9d2929c50df81658c8cbae1b3bc2d7115b8c8e763ca6537d6451427 |