Skip to main content

Fleetmon API wrapper for ship data

Project description

Fleetmonger

Python wrapper for the fleetmon.com ship-tracking API.

API Calls

Read the details of the API at Fleetmonger. * fleetmonger.myfleet * fleetmonger.vessel * fleetmonger.vesselparticulars * fleetmonger.vesselurl * fleetmonger.porturl * fleetmonger.weather * fleetmonger.containerschedule

Note that some API calls require the purchase of credits at Fleetmon. This package is unaffiliated with Fleetmon, use at your own risk.

Usage

from fleetmonger import Fleetmonger

fm = Fleetmonger('username', 'your key')

fleet = fm.myfleet()

for ship in fleet:
    print ship.name, ship.destination

Vessels

my_vessel = fleet[0]
# or
my_vessel = fm.vessel(mmsi='239725000')
# or
my_vessel = fm.vessel(imo='9197545')
# or
my_vessel = fm.vessel(name='MINNOW')

# Passing incomplete information will raise an error
my_vessel = fm.vessel()
# ValueError

my_vessel.name
# <SS MINNOW>

my_vessel.navigationstatus
# 'On a three hour tour'

my_vessel.etatime
# datetime.datetime(1964, 9, 26, 12, 0, tzinfo=<UTC>)

my_vessel.coords
# (3.469557, -167.255859)

# Missing attributes return None
my_vessel.location
# None

my_vessel.flag
# 'United States'

my_vessel.flag_so
# 'US'

# Some vessels have photos
myvessel.photos
# ["//img1.fleetmon.com/thumbnails/MINNOW_1.220x146.jpg", "//img1.fleetmon.com/thumbnails/MINNOW_2.570x1140.jpg"]

Minimum list of Vessel attributes:

coords (lat, lon), course, destination, draught, etatime, flag, heading, imo, last_port, latitude, location, longitude, mmsi, name, navigationstatus, photos, positionreceived, publicurl, speed, type

Ports

my_vessel.last_port
# <fleetmonger.port.Port object>

port = my_vessel.last_port

port.name
# 'Honolulu, HI'

port.duration
# datetime.timedelta(...)

Port urls and Vessel urls

Pass mmsi, imo or name to vessel methods. Pass locode or name to port methods.

fm.vesselurl(name='MINNOW')

fm.porturl(locode='USLAX')

# Porturl also takes an optional country isocode parameter
fm.porturl(name='new', country='US')
# [<Newark (New York)>, <Newburgh>, <Newburyport>, <Newport (OR)>]

Weather at Location

fm.weather(lat=3.469557, lon=-167.255859)

# You can also pass a vessel object to the weather call
fm.weather(vessel=my_vessel)

Parameters

In general, the parameters that Fleetmonger expects match those of the Fleetmon API, with the following exceptions:

instead of mmsinumber, use mmsi
...        imonumber   ... imo
...        q           ... name

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

fleetmonger-0.0.4.tar.gz (5.8 kB view details)

Uploaded Source

Built Distributions

fleetmonger-0.0.4-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

fleetmonger-0.0.4-py2-none-any.whl (9.0 kB view details)

Uploaded Python 2

File details

Details for the file fleetmonger-0.0.4.tar.gz.

File metadata

  • Download URL: fleetmonger-0.0.4.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for fleetmonger-0.0.4.tar.gz
Algorithm Hash digest
SHA256 af4a9ead214eaa35c84583f50e54ce588dc3ba4f022c1f8e906ef7cd2530ccb4
MD5 a734458da0804d55e22276ec12b7d5e6
BLAKE2b-256 242a9971ea5061cfee0e4229009c8d999a09ce8c93f7bea173b7dc07d6b2e59c

See more details on using hashes here.

File details

Details for the file fleetmonger-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for fleetmonger-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0d48cbe9130356d9646367d5f4082b3e012d125aaa714ac42cbdf736c74fcf24
MD5 b063c9bac9807c012dd68ef1271f59a3
BLAKE2b-256 b2c3c53293e051b3c47ba70f6ee5090281a4eb7c8b4ec6262c327031e3f13836

See more details on using hashes here.

File details

Details for the file fleetmonger-0.0.4-py2-none-any.whl.

File metadata

File hashes

Hashes for fleetmonger-0.0.4-py2-none-any.whl
Algorithm Hash digest
SHA256 fec5f5f140c07485220686cf6bb3d7fc87a4a3dd367f1a1567e4927dcc6d9fbb
MD5 7216d3a57c3c16c75817b075f94889e2
BLAKE2b-256 05806ef049d69f0e6b64932658110f13e2ada464542401f433a64ed2b8ffb5ce

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