Welcome to dratio’s documentation!

Data as-a-service to make better decisions based on technology

This client allows you to interact with the services offered by dratio.io using Python. You can download ready-to-use datasets for all types of industries. All data is reviewed, documented and linked together by common variables, allowing you to reference directly with your data without spending time on integration.

Installation

Currently, dratio’s client is available in Python 3.7 to 3.11, 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 from PyPI.

pip install dratio[geo]

Create API Keys

Before you can start using the services offered and access all the datasets, you will need to create an API key. If you are not registered you can create an account on dratio.io.

Note

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 from the platform.

Get started

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

from dratio import Client

client = Client('Your API key')

Pro Tip! You can define the key in the environment variable DRATIO_KEY and simple create the client without passing the key as a parameter: client = Client().

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

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 Dratio’s web services must be in accordance with the terms and conditions that can be found at dratio.io/legal/.

Support

This library is supported by dratio’s team. If you find a bug, or have a feature suggestion, we would appreciate it if you create an issue or contact us through our page or via mail to info@menhir.ai.