Welcome to the Signal SDK

The Signal Ocean SDK combines the power of Python and Signal Ocean's APIs to give you access to a variety of shipping data available in The Signal Ocean Platform.

The Signal Ocean SDK GitHub repository:

The Signal Ocean PyPi:

Installation

Install the SDK with pip:

pip install signal-ocean

The Signal Ocean SDK depends on the pandas library for some of its data analysis features. Optional pandas dependencies are also optional in this SDK. If you plan to use data frame features like plotting or exporting to Excel, you need to install additional dependencies, for example:

pip install matplotlib openpyxl

For more information refer to pandas documentation.

Getting Started

To use the SDK, you need to create an account in our API Portal and subscribe to an API. Once you have a subscription key, put it inside an environment variable called SIGNAL_OCEAN_API_KEY.

Now you're ready to fetch some data:

from signal_ocean.tonnage_list  import TonnageListAPI

tonnage_list_api = TonnageListAPI()
ports = tonnage_list_api.get_ports()

print(ports)

If you don't want to use environment variables, want to use different keys for different APIs, or if you want to override the environment variables, you can configure your Connection when creating the API class:

from signal_ocean import Connection 
from signal_ocean.tonnage_list  import TonnageListAPI

tonnage_list_api = TonnageListAPI(Connection(api_key='YOUR KEY GOES HERE'))
vessel_classes = tonnage_list_api.get_vessel_classes()

print(vessel_classes)

All API classes follow this pattern of configuration.

Check the docs for examples covering usage of our other APIs.