Welcome to the Dratio Python client!

This client allows you to easily access and download data from the Dratio API using Python. With this client, you can seamlessly integrate Dratio's comprehensive range of data sets into your data science projects related to marketing, consumption, demographics, or income. Start leveraging the power of data to make data-driven decisions and drive innovation in your organization.

To get started, simply install the client and authenticate with your Dratio API key. Then, you can use the provided methods to access and download the data you need. The data will be returned as a Pandas DataFrame, making it easy to manipulate and analyze.

Installation

Currently, dratio’s client is available in Python 3.7 to 3.10, regardless of the platform. The stable version can be installed via PyPI.

pip install dratio

In case of using datasets with geographic information, you must have geopandas installed in your Python environment. You can also install the package with all the necessary dependencies directly using pip.

pip install dratio[geo]

Create API Keys

Before you can start using the API, you will need to create an API key. If you are not registered you can create an account on dratio.io.

| Please, store your API Keys in a safe place and never share them publicly, as they give access to all services offered on your behalf. In case of a leak, you can delete and create new keys.

Get started

The Client class allows you to access all API resources using your key.

from dratio import Client

client = Client('<your_api_key>')

Basic functionalities allow you to search and filter datasets available for download.

client.get_datasets()

Once a Dataset is selected, you can access its information and download its content as a Pandas DataFrame or, in case of datasets with geographic information, as a GeoDataFrame.

dataset = client.get('municipalities')

df = dataset.to_pandas() # Download as DataFrame
gdf = dataset.to_geopandas() # GeoDataFrame with geographic information

License & Terms and conditions

This source code is licensed under the Apache License, Version 2.0. You may obtain a copy of the License at apache.org.

The use of the data offered by this client must be in accordance with dratio's terms and conditions. You may obtain a copy of the terms at dratio.io

Support

If you find a bug, or have a feature suggestion, please log an issue or contact us through our page or via mail to info@dratio.io.