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!

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.0.32)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for vortexadevelopers from gravatar.com vortexadevelopers

Credits

Author: Vortexa Developers

License

Apache Software License (Apache Software License 2.0)

Requires

Python >=3.9

Provides Extra

binder deploy tests

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vortexasdk-1.0.31.tar.gz (175.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vortexasdk-1.0.31-py3-none-any.whl (341.0 kB view details)

Uploaded Python 3

File details

Details for the file vortexasdk-1.0.31.tar.gz.

File metadata

  • Download URL: vortexasdk-1.0.31.tar.gz
  • Upload date:
  • Size: 175.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.0

File hashes

Hashes for vortexasdk-1.0.31.tar.gz
Algorithm Hash digest
SHA256 8d5bca95ce0999d31424d35af0efe540afab2233387d8973d7eeb2a43fbaac9e
MD5 44a61a3563006ed9370cf5e9b2f132e4
BLAKE2b-256 96ba4e8b3882130f15c4656d554181c197636176bd3e3d02f763d6cbb8e29644

See more details on using hashes here.

File details

Details for the file vortexasdk-1.0.31-py3-none-any.whl.

File metadata

  • Download URL: vortexasdk-1.0.31-py3-none-any.whl
  • Upload date:
  • Size: 341.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.0

File hashes

Hashes for vortexasdk-1.0.31-py3-none-any.whl
Algorithm Hash digest
SHA256 b909bb2bfd985f7ed9c42255d13b22b5721d27ec6a78b7a6701c87b8301e3d39
MD5 96f5cf9ca61777b74615cd9e560ff2d9
BLAKE2b-256 75a79d9c4725767ee6683a7c4136bf494e51dc9b5f9fe8dbb3cbbe91da021a5d

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.32

2 files

This release

1.0.31 This release

2 files

Pre-release

1.0.30a1

2 files

1.0.29

2 files

1.0.28

2 files

1.0.27

2 files

1.0.26

2 files

1.0.25

2 files

1.0.24

2 files

1.0.23

2 files

1.0.22

2 files

1.0.21

2 files

1.0.20

2 files

1.0.19

2 files

1.0.18

2 files

1.0.17

2 files

1.0.16

2 files

1.0.15

2 files

1.0.14

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

Pre-release

1.0.1a1

2 files

Pre-release

1.0.0a4

2 files

Pre-release

1.0.0a3

2 files

Pre-release

1.0.0a2

2 files

Pre-release

1.0.0a1

2 files

0.75.5

2 files

0.75.4

2 files

0.75.3

2 files

0.75.2

2 files

0.75.1

2 files

0.75.0

2 files

0.74.4

2 files

0.74.3

2 files

0.74.2

2 files

0.74.1

2 files

0.73.1

2 files

0.73.0

2 files

0.72.8

2 files

0.72.7

2 files

0.72.6

2 files

0.72.5

2 files

0.72.4

2 files

0.72.3

2 files

0.72.2

2 files

0.72.1

2 files

0.72.0

2 files

0.71.0

2 files

0.70.0

2 files

0.69.0

2 files

0.68.4

2 files

0.68.3

2 files

0.68.2

2 files

0.68.1

2 files

0.68.0

2 files

0.67.14

2 files

0.67.13

2 files

0.67.12

2 files

0.67.11

2 files

0.67.10

2 files

0.67.9

2 files

0.67.8

2 files

0.67.7

2 files

0.67.6

2 files

0.67.5

2 files

0.67.4

2 files

0.67.3

2 files

0.67.2

2 files

0.67.1

2 files

0.67.0

2 files

0.66.0

2 files

0.65.0

2 files

0.64.2

2 files

0.64.1

2 files

0.64.0

2 files

0.63.2

2 files

0.63.0

2 files

0.62.0

2 files

0.61.0

2 files

0.60.0

2 files

0.59.0

2 files

0.58.0

2 files

0.57.0

2 files

0.56.0

2 files

0.55.0

2 files

0.54.0

2 files

0.53.9

2 files

0.53.7

2 files

0.53.6

2 files

0.53.5

2 files

0.53.4

2 files

0.53.3

2 files

0.53.2

2 files

0.53.1

2 files

0.53

2 files

0.50

2 files

0.49

2 files

0.48.9

2 files

0.48.8

2 files

0.48.7

2 files

0.48.6

2 files

0.48.5

2 files

0.48.4

2 files

0.48.3

2 files

0.48.2

2 files

0.48.1

2 files

0.47.1

2 files

0.47.0

2 files

0.46.12

2 files

0.46.11

2 files

0.46.10

2 files

0.46.9

2 files

0.46.8

2 files

0.46.7

2 files

0.46.6

2 files

0.46.5

2 files

0.46.4

2 files

0.46.3

2 files

0.46.2

2 files

0.46.0

2 files

0.45.0

2 files

0.44.0

2 files

0.43.0

2 files

0.42.2

2 files

0.42.1

2 files

0.41.1

2 files

0.41.0

2 files

0.40.1

2 files

0.40.0

2 files

0.39.0

2 files

0.38.0

2 files

0.37.2

2 files

0.37.1

2 files

0.37.0

2 files

0.36.2

2 files

0.36.1

2 files

0.36.0

2 files

0.35.0

2 files

0.34.2

2 files

0.34.1

2 files

0.34.0

2 files

0.33.2

2 files

0.33.1

2 files

0.33.0

2 files

0.32.1

2 files

0.32.0

2 files

0.31.4

2 files

0.31.3

2 files

0.30.3

2 files

0.30.2

2 files

0.30.1

2 files

0.30.0

2 files

0.29.1

2 files

0.28.9

2 files

0.28.8

2 files

0.28.6

2 files

0.28.5

2 files

0.28.4

2 files

0.28.3

2 files

0.28.2

2 files

0.28.1

2 files

0.28.0

2 files

0.27.9

2 files

0.27.8

2 files

0.27.7

2 files

0.27.6

2 files

0.27.5

2 files

0.27.4

2 files

0.27.3

2 files

Pre-release

0.27.2a2

2 files

Pre-release

0.27.2a1

2 files

0.27.1

2 files

0.26.0

2 files

0.25.2

2 files

0.25.1

2 files

0.25.0

2 files

0.24.0

2 files

0.23.2

2 files

0.23.0

2 files

0.22.1

2 files

0.22.0

2 files

0.21.1

2 files

0.21.0

2 files

0.20.0

2 files

0.19.0

2 files

0.18.0

2 files

0.17.2

2 files

0.17.1

2 files

0.16.0

2 files

Pre-release

0.16.0a4

2 files

Pre-release

0.16.0a3

2 files

Pre-release

0.16.0a1

2 files

0.15.2

2 files

0.15.1

2 files

0.15.0

2 files

0.14.2

2 files

0.14.1

2 files

0.14.0

2 files

0.13.1

2 files

0.13.0

2 files

0.12.1

2 files

0.12.0

2 files

0.11.2

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.5

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.3

2 files

0.3.3

2 files

0.3.2

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

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