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.

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.

To use the SDK, you need to create an account in our API Portal and subscribe to an API.

Now you're ready to fetch some data. See our examples on how you can use our APIs.

Check Contributing.md on how you can build and contribute this library.