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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ddb84cea072838a4c167d5a342f021aac5b8b6c7d23e01e5a6efcfd03b07683 |
|
MD5 | 8bbe4446b1d6997d2a0313560074593d |
|
BLAKE2b-256 | 1bb99292fd56c141c4453f965ceb1747f598955b2f18d090425f1b93a6af22c3 |
Hashes for similarweb_rest_api-0.1.0-py3.11.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc495fc54710ca4a05e1a6de4c63a9f52c69aed79aae4cdfdf307d292e676f19 |
|
MD5 | db1a3471057f7d4272a908063db08316 |
|
BLAKE2b-256 | e2620bd51846ee742fc6839d70a7df7b9a945f989192020c8f278044ba7da098 |
Hashes for similarweb_rest_api-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12b65452e37abeee188d627354dbd129ca116025f7c83a91f82724a4740e2e95 |
|
MD5 | 1dffd049ba5b463174804ef45b341abe |
|
BLAKE2b-256 | 3708bb818e0cb143f607770b9f4ac7ae5050ff8624dfc78d83f7b5b760195224 |