Skip to main content

Marine Traffic Client Api

Project description

Marine Traffic API Client Python Library

PyPI version

Installation

Works on python 3.x.

pip install Marine-Traffic-API

Usage

from marinetrafficapi import MarineTrafficApi

# initialize API
api = MarineTrafficApi(api_key="__your_api_key_here__")

# fetch ship routes
routes = api.routes(port_start_id=1, 
                    port_target_id=10, 
                    include_alternatives=True, 
                    include_in_land=True)

# iterate over the routes
for route in routes:
	route.distance
	route.panama
	route.suez
	route.final_path

# fetch vessel positions
vessel_positions = api.vessel_track(period='daily', 
                                    days=3, 
                                    mmsi=241486000)

# iterate over positions
for position in vessel_positions:
	position.mmsi
	position.status
	position.speed
	position.longitude
	position.latitude
	position.course
	position.heading
	position.timestamp
	position.ship_id
	position.wind_angle

Debugging

If you want to debug your code using the data regarding the API call.

# initialize with debug=True
api = MarineTrafficApi(api_key="...", debug=True)

# after every API call the client library will automatically print all the data to standard output
api.routes(...)

# and you can always have all debug data in your code
debug_data = api.request.debug.show()

Official documentation

For more information visit official documentation: https://www.marinetraffic.com/en/ais-api-services/

Project details


Download files

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

Source Distribution

Marine Traffic API-0.1.2.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

Marine_Traffic_API-0.1.2-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file Marine Traffic API-0.1.2.tar.gz.

File metadata

  • Download URL: Marine Traffic API-0.1.2.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.2

File hashes

Hashes for Marine Traffic API-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5e93784d7efcf5e86adefd7ee375270fa460972469c64005b7a3eb87a90bafb8
MD5 ee69264a367fd9f83e6045c23d4031c7
BLAKE2b-256 b271c44542813cc1e25d50e49dd00396f66241226440031062bd264ae7dbdb8e

See more details on using hashes here.

File details

Details for the file Marine_Traffic_API-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: Marine_Traffic_API-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.2

File hashes

Hashes for Marine_Traffic_API-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1a220eac86a112ddd809b9530c6b717d89ad1bd6591a5f4aed998f71b7276e16
MD5 2bd0a2c585c4b603774aba99ef79c4d3
BLAKE2b-256 16eb491245f50ed8c5c2da1a3a2585612e59e84ab668f793226b6469c9e698f3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page