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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9abe3cbff83d4da696a7b0557d9bcda859c9286e284fb44cddf315ffe6264678 |
|
MD5 | a2dfea4b826291fb0c5707d26ba1daad |
|
BLAKE2b-256 | ce5a468252b262ef3bc1396499d78aae33d6ae9a34575fa6bf13841f80f4bb1b |
Hashes for similarweb_rest_api-0.0.5-py3.11.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34f3b3806f648f3a8ba6e6a6c5829ac08199e289843e53d0c0659f5f7b0761c3 |
|
MD5 | c317c0a1cff93cbf58951f88c9682f0a |
|
BLAKE2b-256 | 0949c4eb7b956454c9d5806a1a72ef3572c6e9eb5700520eec73ad53f186df8a |
Hashes for similarweb_rest_api-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5b45e8e5306b7182cf310ec9e5a0ba778ab9c9d1a6c51de71efb622cc43f061 |
|
MD5 | 87caebd1639194e732c576be23f8665a |
|
BLAKE2b-256 | 1e9a5cf165cc57720dee28cd794c4d1b57e475c22f06b8d456eaf823d25fab03 |