Skip to main content

Vortexa SDK

Project description

VortexaSDK

All Contributors

CircleCI Code style: black

The VortexaSDK is Vortexa's Software Development Kit (SDK) for Python, which allows Data Scientists, Analysts and Developers to query Vortexa's API

Quick Start

Installation
$ pip install vortexasdk
Authentication

Set your VORTEXA_API_KEY environment variable, that's all.

Refer to Vortexa API Authentication for more details, including instructions on where to find your API key.

Example
>>> from datetime import datetime
>>> from vortexasdk import CargoMovements
>>> df = CargoMovements()\
        .search(filter_activity='loading_state',
            filter_time_min=datetime(2017, 8, 1, 23),
            filter_time_max=datetime(2017, 8, 1, 23))\
        .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 AMBITION 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
3 46260 XINWANYU16 Clean products Chemicals 2017-08-01T01:07:40+0000 2017-08-10T06:21:43+0000

Next Steps

Learn how to call Endpoints

Documentation

Read the documentation at VortexaSDK Docs

Contributing

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

Glossary

The Glossary can be found at Vortexa API Documentation

This outlines key terms, functions and assumptions aimed at helping to extract powerful findings from our data.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Kit Burgess
Kit Burgess

🎨 💻
tinovs
tinovs

💻 👀
David Andrew Starkey
David Andrew Starkey

💻 📖 💡
syed
syed

👀
Jakub Korzeniowski
Jakub Korzeniowski

🤔
Edward Wright
Edward Wright

📓
Patrick Roddy
Patrick Roddy

📓
Romain
Romain

📓 🤔
Natday
Natday

💼 🤔 📓
ArthurD1
ArthurD1

📓
Chloe Connor
Chloe Connor

📓
Achilleas Sfakianakis
Achilleas Sfakianakis

📓

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

Project details


Download files

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

Files for vortexasdk, version 0.9.1
Filename, size File type Python version Upload date Hashes
Filename, size vortexasdk-0.9.1-py3-none-any.whl (67.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size vortexasdk-0.9.1.tar.gz (63.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page