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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8629e9ff2bc0ae1a4fc2811c6e6f3134395541e9f333f5f8b0904ffc431c85fa |
|
MD5 | 0ca7a94ad68883e8a2ffd425cdebb417 |
|
BLAKE2b-256 | fb444cd64f0b4c4706f1d1c7cfcff09c6186c65ef9b8a82250561f1542e69faa |
Hashes for similarweb_rest_api-0.1.1-py3.11.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12c44153e0570afee75f977dd19336995b76cc2182fc7728b36c8bd4df1d8709 |
|
MD5 | df52865a1d1afb4aca0dff596706a9e1 |
|
BLAKE2b-256 | 5d314c666127620380250afd2dee9d92fdc82b2bda32001e419bdbce0134c1ec |
Hashes for similarweb_rest_api-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f43572813dada9673d9ba3ae9656209d210e018309fa08b172b0af7cb9d2c320 |
|
MD5 | 1e0344000a45c6dc09c60d352cb32e9b |
|
BLAKE2b-256 | 69810341e49c9fcee4d749d21003962b99d140d689dd26dd732781b40d4b2776 |