Oceanbolt Python SDK

GitHubStatusBadge NetlifyStatusBadge

The Oceanbolt Python SDK provides access to Oceanbolt data. It is a python wrapper around the Oceanbolt Data API (REST).

It can be easily integrated existing tools such as jupyter notebooks, scripts, and applications.

Data is returned in the form of pandas.DataFrame, which allows for easy manipulation and further data processing.

The python SDK is available to all Oceanbolt API clients (API authentication token required in order to get access). API tokens can be generated in the Oceanbolt App (app.oceanbolt.com)

We suggest to read the Getting Started page to get up and running quickly.

Project Status

IMPORTANT: The oceanbolt-python-sdk is still undergoing development, and certain features may be changed/removed before the launch of version 1.0.0

Example

Short example to illustrate the use of the oceanbolt-python-sdk:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from datetime import date, timedelta

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.port_calls import PortCalls

base_client = APIClient("<your api access token>")

# Get capesize port calls in Port Hedland for last 7 days
port_calls = PortCalls(base_client).get(
    start_date=date.today() - timedelta(days=7),
    segment=["capesize"],
    unlocode=["AUPHE"],
)

API Reference

Distance Calculator

Indices and tables