Marine Traffic Client Api
Project description
Marine Traffic API Client Python Library
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)
# Data could be fetched in 3 different ways:
routes.raw_data # raw data from api call
routes.formatted_data # json, xml (lxml etree) or csv (pandas csv) formatted
routes.models # list of Client models representing the data
# iterate over the route models
for route in routes.models:
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 position models
for position in vessel_positions.models:
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for Marine_Traffic_API-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a69560103035dc5aee6fd0cc09065d825421d64ae5e3edce47575e76aef9f25 |
|
MD5 | 8d9dc4a91c4666dbcbc3ae05ef4d4e96 |
|
BLAKE2b-256 | 508f6badcedde48b56c24d1379c9784ec9c52e6747825df01097914b2e85d821 |