#!/usr/bin/env python
# coding: utf-8

# ### This notebook gives a 30 second introduction to the Vortexa SDK

# First let's import our requirements

# In[ ]:


from datetime import datetime
import vortexasdk as v


# Top hits of destinations by number of vessels on 1st August 2021.

# You'll need to enter your Vortexa API key when prompted.

# In[ ]:


df = v.VoyagesTopHits()\
    .search(
        time_min=datetime(2021, 8, 1, 0, 0),
        time_max=datetime(2021, 8, 1, 23, 59),
        breakdown_split_property="destination_shipping_region")\
    .to_df()


# In[ ]:


df.head()


# That's it! You've successfully loaded data using the Vortexa SDK. Check out https://vortechsa.github.io/python-sdk/ for more examples