ExpectedArrivals

Description

EXPECTEDARRIVALS method allows you to query any combination of AIS data and Voyage or Master data for all vessels expected in the port of interest within the period you define. The response includes all vessels, which have entered the port of interest as Destination in their AIS transponder.

Data Content Credits
AIS Coordinates, course, speed, heading, current draught, destination, ETA and static vessel data 5*
Voyage Last port/country and time of departure 1
Master IMO, name, flag, type, year of build, builder, owner / manager, dimensions, maximum draught, gross tonnage, net tonnage, deadweight, TEU, crude capacity 2

(*) API returns the most up-to-date position of the vessel (Terrestrial or Satellite)

URL format

https://api.vtexplorer.com/expectedarrivals?userkey=AABBCCDD&param1=value1&param2=value2....

Parameters

Parameter Required Type Default Description
userkey yes text - Your personal API key
format no text json Response format json or xml
extradata no text - Additional datasets voyage, master
limit no integer - Maximum number of returned records
interval yes* integer unlimited Time interval (minutes) in the future to check for expected arrivals
fromdate yes* datetime unlimited Expected arrivals between fromdate and todate (YYYY-MM-DD HH:MM:SS)
todate yes* datetime unlimited Expected arrivals between fromdate and todate (YYYY-MM-DD HH:MM:SS)
locode yes text - Unique ID of the requested port
aistype no list of integers - List of vessel types, according to AIS Specification

*Note: The request should contain timespan specified by interval or fromdate / todate parameters!

Examples (JSON format)

https://api.vtexplorer.com/expectedarrivals?userkey=AABBCCDD&interval=1440&locode=BGVAR

[  
    {  
        "AIS":{  
            "MMSI":636092343,
            "TIMESTAMP":"2017-08-16 13:02:17 UTC",
            "LATITUDE":40.79601,
            "LONGITUDE":28.89114,
            "COURSE":138.5,
            "SPEED":0.4,
            "HEADING":135,
            "NAVSTAT":1,            
            "IMO":9407469,
            "NAME":"ANNA-MARIA",
            "CALLSIGN":"D5AS7",
            "TYPE":70,
            "A":162,
            "B":28,
            "C":21,
            "D":11,
            "DRAUGHT":6.5,
            "DESTINATION":"VARNA",
            "ETA_AIS":"08-16 14:00",
            "ETA":"2017-08-16 14:00:00",
            "SRC":"TER",
            "ZONE": "Black Sea",
            "ECA": false            
        }
    },
    {  
        "AIS":{  
            "MMSI":271001057,
            "TIMESTAMP":"2017-08-16 13:06:41 UTC",
            "LATITUDE":43.0857,
            "LONGITUDE":27.95016,
            "COURSE":160.0,
            "SPEED":0.5,
            "HEADING":73,
            "NAVSTAT":1,            
            "IMO":9126742,
            "NAME":"ROZA A",
            "CALLSIGN":"TCRB7",
            "TYPE":71,
            "A":138,
            "B":30,
            "C":10,
            "D":10,
            "DRAUGHT":7.5,
            "DESTINATION":"BGVAR",
            "ETA_AIS":"08-16 15:00",
            "ETA":"2017-08-16 15:00:00",
            "SRC":"SAT",
            "ZONE": "Black Sea",
            "ECA": false            
        }
    }
]

https://api.vtexplorer.com/expectedarrivals?userkey=AABBCCDD&extradata=voyage,master&interval=1440&locode=BGVAR

[  
    {  
        "AIS":{  
            "MMSI":636092343,
            "TIMESTAMP":"2017-08-16 13:09:20 UTC",
            "LATITUDE":40.79497,
            "LONGITUDE":28.89261,
            "COURSE":152.0,
            "SPEED":0.9,
            "HEADING":162,
            "NAVSTAT":1,            
            "IMO":9407469,
            "NAME":"ANNA-MARIA",
            "CALLSIGN":"D5AS7",
            "TYPE":70,
            "A":162,
            "B":28,
            "C":21,
            "D":11,
            "DRAUGHT":6.5,
            "DESTINATION":"VARNA",
            "ETA_AIS":"08-16 14:00",
            "ETA":"2017-08-16 14:00:00",
            "SRC":"SAT",
            "ZONE": "Black Sea",
            "ECA": false            
        },
        "MASTERDATA":{  
            "IMO":9407469,
            "NAME":"ANNA-MARIA",
            "FLAG":"LR",
            "BUILT":2007,
            "BUILDER":"KAWASAKI",
            "OWNER":"ANNA-MARIA SCHIFFAHRTS",
            "MANAGER":"BLUMENTHAL JMK GMBH & CO KG",
            "LENGTH":189.9,
            "BEAM":32.3,
            "MAXDRAUGHT":13.0,
            "GT":30811,
            "NT":18205,
            "DWT":55473,
            "TEU":0,
            "CRUDE":0
        },
        "VOYAGE":{  
            "LOCODE":"BR002",
            "DEPARTURE":"2017-06-10 15:20:10 UTC",
            "LASTPORT":"Santos Anchorage",
            "LASTCOUNTRY":"Brazil"
        }
    },
    {  
        "AIS":{  
            "MMSI":271001057,
            "TIMESTAMP":"2017-08-16 13:09:40 UTC",
            "LATITUDE":43.08535,
            "LONGITUDE":27.95031,
            "COURSE":166.0,
            "SPEED":0.2,
            "HEADING":54,
            "NAVSTAT":1,            
            "IMO":9126742,
            "NAME":"ROZA A",
            "CALLSIGN":"TCRB7",
            "TYPE":71,
            "A":138,
            "B":30,
            "C":10,
            "D":10,
            "DRAUGHT":7.5,
            "DESTINATION":"BGVAR",
            "ETA_AIS":"08-16 15:00",
            "ETA":"2017-08-16 15:00:00",
            "SRC":"TER",
            "ZONE": "Black Sea",
            "ECA": false            
        },
        "MASTERDATA":{  
            "IMO":9126742,
            "NAME":"ROZA A",
            "FLAG":"TR",
            "BUILT":1997,
            "BUILDER":"CHINA SB CORP",
            "OWNER":"LIMAR LIMAN",
            "MANAGER":"ARKAS DENIZCILIK VE NAKLIYAT",
            "LENGTH":168.8,
            "BEAM":27.3,
            "MAXDRAUGHT":13.5,
            "GT":15120,
            "NT":6764,
            "DWT":19325,
            "TEU":1439,
            "CRUDE":0
        },
        "VOYAGE":{  
            "LOCODE":"TRAMB",
            "DEPARTURE":"2017-08-15 12:05:56 UTC",
            "LASTPORT":"Ambarli",
            "LASTCOUNTRY":"Turkey"
        }
    }
]

Examples (XML format)

https://api.vtexplorer.com/expectedarrivals?userkey=AABBCCDD&interval=1440&format=xml&locode=BGVAR


<VESSELS>
    <VESSEL>
        <AIS MMSI="277373000" TIMESTAMP="2017-08-11 13:59:40 UTC" LATITUDE="43.18176" LONGITUDE="28.02028" COURSE="12.5" SPEED="1.6" HEADING="21" NAVSTAT="0" IMO="9143582" NAME=" AQUARIUS" CALLSIGN=" LYST" TYPE="70" A="72" B="10" C="7" D="3" DRAUGHT="3.0" DESTINATION="VARNA <<<<<<<<" ETA_AIS="08-11 17:00" ETA="2017-08-11 17:00:00" SRC="TER" ZONE="Black Sea" ECA="false"/>
    </VESSEL>
    <VESSEL>
        <AIS MMSI="671432000" TIMESTAMP="2017-08-11 13:59:35 UTC" LATITUDE="42.47287" LONGITUDE="27.51356" COURSE="91.6" SPEED="7.3" HEADING="91" NAVSTAT="0" IMO="8030283" NAME="AVIVA" CALLSIGN="5VCM5" TYPE="79" A="109" B="33" C="14" D="4" DRAUGHT="5.4" DESTINATION="VARNA" ETA_AIS="08-12 01:00" ETA="2017-08-12 01:00:00" SRC="SAT" ZONE="Black Sea" ECA="false"/>
    </VESSEL>
</VESSELS>```