• Version 01

Schedules by Points

API Entry Point

https://sirius.searates.com/schedule

Method - GET

Request Parameters

Parameter
Description
sealine

SCAC - code from list below:

SCAC
Name
SKLU
SINOKOR
CMDU
CMA CGM
MSCU
MSC
ANNU
ANL
OOLU
OOCL
SUDU
HAMBURG SUD
HLCU
HAPAG-LLOYD
EIMU
EIMSKIP
12AT
Interasia Lines
TRKU
TURKON
REGU
RCL
ZIMU
ZIM
FESO
FESCO
ADMU
ADMIRAL
ARKU
ARKAS
MATS
MATSON
MAEU
MAERSK
ESPU
EMIRATES
13DF
T.S. LINES
KMTU
KMTC
COSU
COSCO
GSLU
GOLD STAR LINE
BORU
BORCHARD
EGLV
EVERGREEN
HDMU
HYUNDAI
SMLM
SM LINE
YMLU
YANG MING
PCIU
PIL
12PD
SITC
22AA
WAN HAI
ONEY
ONE
11DX
CNC
SEJJ, MCCQ, SEAU
SEALAND
APLU
APL
portcode
UN/LOCODE - the UN/LOCODE of departure port.
portdestinationcode
UN/LOCODE - the UN/LOCODE of arrival port.
fromdate
Start from date - specify the date in format dd-mm-yyyy or today.
weeksahead
Weeks ahead - weeks to display.
direction

List of available directions:

Value
Description
D
Earliest Departure Date
A
Latest Arrival Date
service_mode_from

Origin service mode.

List of available origin service modes:

Value
Description
CY
Container yard
SD
Store door
service_mode_to

Destination service mode.

List of available destination service modes:

Value
Description
CY
Container yard
SD
Store door
api_key
API Key - to get api key, please contact us.

Request Parameter and Demonstration

Name
Description
Complete request link
https://sirius.searates.com/schedule?sealine=_SEALINE_SCAC_&portcode=_UN_LOCODE_DEPARTURE_PORT_&portdestinationcode=_UN_LOCODE_ARRIVAL_PORT_&fromdate=_DATE_&weeksahead=_WEEKS_NUMBER_&direction=_DIRECTION_TYPE_LETTER_&api_key=_YOUR_API_KEY
Demo Sealine
ARKU
Demo UN/LOCODE of departure port
UAODS
Demo UN/LOCODE of arrival port
TRGEM
Demo date
09-10-2020
Demo direction
D
Demo weeks
2
Demo API Key
DEMO_KEY

Response

Name
Description
All possible statuses
SUCCESS
Schedule received.
NO_RESPONSE_FROM_CARRIER
We can't retrieve the schedule. Maybe sealine number is incorrect or sealine does not provide the schedule for requested route. Check input or try again later.
WRONG_SEALINE_SCAC
Inputed sealine SCAC code is not valid.
WRONG_START_DATE_FORMAT
Inputed start date has the wrong format.
WRONG_WEEKS_AHEAD_NUMBER
Inputed weeks ahead number is not valid.
WRONG_PORT_CODE_FORMAT
Inputed UN/LOCODE of departure port is not valid.
WRONG_PORT_DESTINATION_CODE_FORMAT
Inputed UN/LOCODE of arrival port is not valid.
WRONG_DIRECTION
Inputed direction value is not valid.
WRONG_SERVICE_MODE_FROM_FORMAT
Inputed origin service mode value is not valid.
WRONG_SERVICE_MODE_TO_FORMAT
Inputed destination service mode value is not valid.
API_KEY_WRONG
API Key is incorrect.
API_KEY_NO_ACCESS
This API Key is not assigned to this product.
API_KEY_EXPIRED
API Key is expired, please contact us to extend it.
REQUEST_RATE_TOO_HIGH
Request rate is too high for this API key.
TOO_MANY_REQUESTS
Your API key has reached its limit for this month. Please contact us to extend your subscription.
UNEXPECTED_ERROR
Error. Please, contact us and explain, in what situation its happen.
All possible types
1
Transported by VESSEL
2
Transported by FEEDER, BARGE
3
Transported by TRUCK, RAIL

List of shipping lines that will be available in the near future

  • Tarros
  • Tanto
  • Nile Dutch

JSON Response Structure

responseobject
|-----statusstring
|-----routesarray //all routes by schedule
|-----|-----[0]
|-----|-----|---transShipmentsarray //array of subroutes
|-----|-----|-----------------[0]
|-----|-----|------------------|-----typenumber //the type of transport provided
|-----|-----|------------------|-----vesselNamestring //the name of vessel
|-----|-----|------------------|-----vesselCodestring //the code of vessel
|-----|-----|------------------|-----voyagestring
|-----|-----|------------------|-----departureobject //all departure info
|-----|-----|------------------|-----|-----datenumber //timestamp of departure date
|-----|-----|------------------|-----|-----portNamestring //the name of departure port
|-----|-----|------------------|-----|-----portUnlocodestring //the UN/LOCODE of departure port
|-----|-----|------------------|-----|-----terminalstring //address of departure terminal
|-----|-----|------------------|-----arrivalobject //all arrival info
|-----|-----|------------------|-----|-----datenumber //timestamp of arrival date
|-----|-----|------------------|-----|-----portNamestring //the name of arrival port
|-----|-----|------------------|-----|-----portUnlocodestring //the UN/LOCODE of arrival port
|-----|-----|------------------|-----|-----terminalstring //address of arrival terminal
|-----|-----|------------------|-----servicestring //service name
|-----|-----|---cutOffnumber //timestamp of cut off date
|-----|-----|---transitTimenumber //days of transit time
                

Notes *

  • Any field of transShipments array could be empty or has the value “TBN”, as fields cutOff and transitTime except type. This means that sealine doesn’t provide this kind of data at the moment.
  • Field named cutOff represents CY date. If sealine doesn’t provide this date it will be set two days before first departure date of transShipments array
  • In case of FEEDER or LAND type transportation fields named: vesselName, vesselCode, voyage, service will be empty.
  • Some of sealines do not provide schedules for past dates, only from today.
  • The sealines: ONE, COSCO, OOCL, MAERSK, SAFMARINE, SEALAND, YANG MING, HAPAG-LLOYD may require service mode parameter CY or SD for departure port and arrival port to get more schedules.

Schedules by Vessel

API Entry Point

https://sirius.searates.com/schedule/vessel

Method - GET

Request Parameters

Parameter
Description
imo
IMO - unique identifier of the vessel
api_key
API Key - to get api key, please contact us
Complete request link
https://sirius.searates.com/schedule/vessel?imo=_IMO_&api_key=_YOUR_API_KEY

Supported Shipping Lines List

Name
SCAC
CMA CGM
CMDU
ANL
ANNU
ARKAS
ARKU
MAERSK
MAEU
COSCO
COSU
BORCHARD
BORU
EVERGREEN
EGLV
HYUNDAI
HDMU
SM LINE
SMLM
YANG MING
YMLU
PIL
PCIU
SITC
12PD
ONE
ONEY
CNC
11DX
SEALAND
SEJJ, MCCQ, SEAU
APL
APLU

Request Parameter and Demonstration

Name
Description
Complete request link
https://sirius.searates.com/schedule/vessel?imo=_IMO_&api_key=_YOUR_API_KEY
Demo IMO
9356165
Demo API Key
DEMO_KEY

Response

Name
Description
All possible statuses
SUCCESS
Schedules received.
NOT_FOUND
Sealine does not provide the schedules for requested vessel.
ERROR
Inputed vessel's IMO or API Key is not valid.

List of shipping lines that will be available in the near future

  • Hapag-Lloyd
  • OOCL

JSON Response Structure

statusstring //request status
messagestring //request status description
dataobject //all retrieved data
|-----vesselobject//vessel information
|-----|-----namestring //vessel name
|-----|-----imostring //IMO number
|-----|-----call_signstring //call sign
|-----|-----mmsistring //MMSI
|-----|-----flagstring //country code (2 characters)
|-----|-----year_builtnumber //the year vessel was built
|-----|-----capacitynumber //vessel's capacity (TEU)
|-----locationsarray //an array with all locations present in schedules
|-----|--------[0]
|-----|---------|---idnumber //unique identifier
|-----|---------|---namestring //the name of the location (name of city)
|-----|---------|---statestring //first level administrative unit (state, district, province, region)
|-----|---------|---countrystring //country name
|-----|---------|---country_codestring //country code (2 characters)
|-----|---------|---locodestring //UN/LOCODE
|-----|---------|---latitudenumber //latitude
|-----|---------|---longitudenumber //longitude
|-----|---------|---timezonestring //location time zone
|-----schedulesarray //array of found schedules grouped by voyages
|-----|-------[0]
|-----|--------|----carrier_namestring //shipping line name
|-----|--------|----carrier_codestring //shipping line scac
|-----|--------|----service_namestring //name of trade path
|-----|--------|----service_codestring //code of trade path
|-----|--------|----voyagesarray //array of all voyages present in ports array
|-----|--------|-----------[0]
|-----|--------|------------|----[0]string //voyage
|-----|--------|----portsarray //array of ports the vessel passes
|-----|--------|---------[0]
|-----|--------|----------|----arrival_voyagestring //main voyage on arrival
|-----|--------|----------|----arrival_local_voyagestring //the local voyage on arrival, given by shipping line
|-----|--------|----------|----departure_voyagestring //main voyage on departure
|-----|--------|----------|----departure_local_voyagestring //the local voyage on departure, given by shipping line
|-----|--------|----------|----estimated_arrivalstring //date of estimated arrival in (dd.mm.yyyy hh:mm) format
|-----|--------|----------|----estimated_berthstring //date of estimated berth in (dd.mm.yyyy hh:mm) format
|-----|--------|----------|----estimated_departurestring //date of estimated departure in (dd.mm.yyyy hh:mm) format
|-----|--------|----------|----actual_arrivalstring //date of actual arrival in (dd.mm.yyyy hh:mm) format
|-----|--------|----------|----actual_berthstring //date of actual berth in (dd.mm.yyyy hh:mm) format
|-----|--------|----------|----actual_departurestring //date of actual departure in (dd.mm.yyyy hh:mm) format
|-----|--------|----------|----locationnumber //unique identifier (id) from the locations array
|-----|--------|----------|----terminalstring //terminal name
|-----|--------|----------|----deadlinesarray //array of deadlines related to the current port
|-----|--------|----------|-------------[0]
|-----|--------|----------|--------------|---namestring //title of deadline
|-----|--------|----------|--------------|---datestring //date of deadline in (dd.mm.yyyy hh:mm) format
                

Notes *

  • Schedules are only displayed within 3 months from date of request.