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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cdb32c405646b60fabab47ab7418bc82e6f2607955995f0d13480c9feb2c76d9 |
|
MD5 | 94d950ffcae207607bb32a198a660cdc |
|
BLAKE2b-256 | 8bbb2911c8e931a3f32f12eb6bb564d69fa34192aa152e35a94e2555013c26c2 |
Hashes for similarweb_rest_api-0.0.3-py3.11.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e3024386541c33634b0986d117e68f62f5943a45c0dd2371514e515cf22e53f |
|
MD5 | 1b3f96d842ceddfaab70d824cd5fcc3b |
|
BLAKE2b-256 | c290123d4802fa348481baeecacebf8b04b0bfe252843d387d93d7d7d85da1da |
Hashes for similarweb_rest_api-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04e5590f85b062b77f115f8e349c65b3863305f8e0d90fb008a501e3fa74665d |
|
MD5 | 47148fadac0eca4bf9f77abf5947be53 |
|
BLAKE2b-256 | 625c428fbc197955e650c2b4d0ddc140e67f2ba2b8265957ea4a4acc7030f050 |