#!/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


# Now let's load a dataframe of a vessels breakdown by product and status between 1st of January 2024 - 29th of Fabuary 2024 with a "category" layer breakdown.

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

# In[ ]:


df = v.VoyagesProductBreakdown(
    second_breakdown="status",
).search(
    time_min=datetime(2024, 1, 1),
    time_max=datetime(2024, 2, 29, 23, 59),
    breakdown_product="category",
).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