Skip to main content

VortexaSDK

Code style: black All Contributors

Welcome to Vortexa's Python Software Development Kit (SDK)! We built the SDK to provide fast, interactive, programmatic exploration of our data. The tool lets Data Scientists, Analysts and Developers efficiently explore the world’s waterborne oil movements, and to build custom models & reports with minimum setup cost.

The SDK sits as a thin python wrapper around Vortexa's API, giving you immediate access to pandas DataFrames.

Example

In an interactive Python console, run:

>>> from datetime import datetime
>>> from vortexasdk import CargoMovements
>>> df = CargoMovements()\
        .search(filter_activity='loading_state',
            filter_time_min=datetime(2017, 8, 2),
            filter_time_max=datetime(2017, 8, 3))\
        .to_df()

returns:

quantity vessels.0.name product.group.label product.grade.label events.cargo_port_load_event.0.end_timestamp events.cargo_port_unload_event.0.start_timestamp
0 1998 ALSIA SWAN Clean products Lube Oils 2017-08-01T06:10:45+0000 2017-08-27T14:38:15+0000
1 16559 IVER Dirty products nan 2017-08-02T17:20:51+0000 2017-09-07T07:52:20+0000
2 522288 BLUE SUN Crude Gharib 2017-08-02T04:22:09+0000 2017-08-13T10:32:09+0000

Quick Start

Try me out in your browser:

Binder

Installation

pip install vortexasdk

or

pip3 install vortexasdk

The SDK requires Python version 3.9. See Setup FAQ for more details.

To install the SDK on an Apple ARM-based machine, use Python versions 3.9.19 and use the latest version of pip. This is supported in the SDK versions 1.0.0 or higher.

Authentication

Set your VORTEXA_API_KEY environment variable, that's all. Alternatively, the SDK prompts to you enter your API Key when running a script interactively.

To get an API key and experiment with Vortexa's data, you can request a demo here.

Check Setup

To check the SDK is setup correctly, run the following in a bash console:

python -m vortexasdk.check_setup

or

python3 -m vortexasdk.check_setup

A successful setup looks like this:

check_setup.png

Next Steps

Learn how to call Endpoints

Glossary

The Glossary can be found at Vortexa API Documentation. The Glossary outlines key terms, functions and assumptions aimed at helping to extract powerful findings from our data.

Documentation

Read the documentation at VortexaSDK Docs

Contributing

We welcome contributions! Please read our Contributing Guide for ways to offer feedback and contributions.

Thanks goes to these wonderful contributors (emoji key):


Kit Burgess

🎨 💻

tinovs

💻 👀

David Andrew Starkey

💻 📖 💡

syed

👀

Jakub Korzeniowski

🤔

Edward Wright

📓

Patrick Roddy

📓

Romain

📓 🤔

Natday

💼 🤔 📓

ArthurD1

📓

Chloe Connor

📓

Achilleas Sfakianakis

📓

Sean Barry

💻 📖

Konrad Moskal

💻

Pawel Pietruszka

💻

Olly De Sousa

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Metadata

Release files for vortexasdk 1.0.34

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vortexasdk 1.0.34
File Size Uploaded Provenance Actions
vortexasdk-1.0.34.tar.gz 179.3 kB Without provenance Details for vortexasdk-1.0.34.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vortexasdk 1.0.34
File Interpreter ABI Platform Actions
vortexasdk-1.0.34-py3-none-any.whl Python 3 none any Details for vortexasdk-1.0.34-py3-none-any.whl

Total release size: 522.8 kB

Release files / vortexasdk-1.0.34.tar.gz

Download URL vortexasdk-1.0.34.tar.gz
Size 179.3 kB
Tags Source
SHA-256 checksum
How to use checksums
5796c6c3d1f2bc9c4a52be3f7c6f32f60a0eb1192e8a5df6980c9760ab8ea83f
BLAKE2b-256 checksum
How to use checksums
ef0098bf58847960ad2043b09754a6ce840f3580f8551afcbfc0d15047b2ae5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.0

Release files / vortexasdk-1.0.34-py3-none-any.whl

Download URL vortexasdk-1.0.34-py3-none-any.whl
Size 343.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
de808c998a1dd3fde95f0c59aa9f8f93ff5aaaf1f7a0c99f59faa7e52dc9bb9b
BLAKE2b-256 checksum
How to use checksums
07e43a43b2b974b5e5b784e58bd9aa852134ac49ceb2021b9870c3a55d2cc78a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.0

Security for vortexasdk 1.0.34

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.34 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page