Start designing your API in minutes. The OpenAPI specification file enables you to learn and interact with API elements, including all available endpoints, input and output representations.

OpenAPI Spec

General information

Ship Schedules API is organized around REST.
Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

API endpoint#

1https://schedules.searates.com/api/v2

All endpoints are only accessible via HTTPS and are located at schedules.searates.com

Schedules by Points

get/schedules/by-points

Get schedules for particular direction using UN/LOCODEs for ports, and SCACs for carriers filter.

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-API-KEY

Example: X-API-KEY: 123

Headers

Content-Typeapplication/json

Query Parameters

carriersOptionalstring
SCAC codes list
Example:MSCU,MAEU,COSU,EGLV,YMLU,HDMU
Match pattern:^([A-Z0-9]{4}(?:(,[A-Z0-9]{4})){0,})$
cargo_typeREQUIREDstring
Filter schedules by cargo type:

GC - General cargo

REEF - Reefer

RORO - Ro-Ro cargo

LCL - Less container load
Allowed values:GCREEFLCLRORO
originREQUIREDstring
Origin port UN/LOCODE
Example:AEJEA
Match pattern:^[A-Z0-9]{5}$
destinationREQUIREDstring
Destination port UN/LOCODE
Example:CNSHA
Match pattern:^[A-Z0-9]{5}$
from_dateREQUIREDstring
Start from date - specify the date in format yyyy-mm-dd. Must be current date or future date
Example:2024-04-02
Match pattern:^(\d{4}-\d{2}-\d{2})$
weeksREQUIREDinteger
Weeks ahead to display
>= 1<= 6
Example:3
sortREQUIREDstring
Sorting schedules mode:

DEP - Sort schedules by departure date

ARR - Sort schedules by arrival date

TT - Sort schedules by transit time
Allowed values:DEPARRTT
direct_onlyOptionalboolean
Show only direct service
Default:false
multimodalOptionalboolean
Show multimodal schedules
Default:true

Response example

Schedules by Points

1{
2  "success": true,
3  "status_code": "OK",
4  "metadata": {
5    "request_parameters": {
6      "carriers": "MAEU,MSCU,COSU",
7      "cargo_type": "GC",
8      "origin": "ITGOA",
9      "destination": "EGALY",
10      "from_date": "2024-05-02",
11      "sort": "DEP",
12      "weeks": 6,
13      "direct_only": false,
14      "multimodal": true
15    },
16    "response_stats": [
17      {
18        "status_code": "SCHEDULES_FOUND",
19        "carrier_name": "MSC",
20        "found_schedules": 7
21      },
22      {
23        "status_code": "SCHEDULES_NOT_FOUND",
24        "carrier_name": "MAERSK",
25        "found_schedules": 0
26      },
27      {
28        "status_code": "SCHEDULES_FOUND",
29        "carrier_name": "COSCO",
30        "found_schedules": 4
31      }
32    ]
33  },
34  "data": {
35    "schedules": [
36      {
37        "schedule_id": 3640,
38        "carrier_name": "COSCO",
39        "carrier_scac": "COSU",
40        "cargo_type": "GC",
41        "origin": {
42          "estimated_date": "2024-05-05 01:46:00",
43          "port_name": "Genoa",
44          "port_locode": "ITGOA",
45          "terminal_name": "Voltri Terminal Europa SpA Porto di Voltri 16158 Genoa Italy",
46          "terminal_code": null
47        },
48        "destination": {
49          "estimated_date": "2024-05-17 03:00:00",
50          "port_name": "Alexandria",
51          "port_locode": "EGALY",
52          "terminal_name": "El-Dekheala Container Terminal El-Dekheala Container Terminal (Dkchc)",
53          "terminal_code": null
54        },
55        "legs": [
56          {
57            "order_id": 1,
58            "mode": "VESSEL",
59            "vessel_name": "TAMPA TRIUMPH",
60            "vessel_imo": null,
61            "voyages": [
62              {
63                "name": "voyage",
64                "voyage": "0638-035E"
65              }
66            ],
67            "departure": {
68              "estimated_date": "2024-05-05 01:46:00",
69              "port_name": "Genoa",
70              "port_locode": "ITGOA",
71              "terminal_name": "Voltri Terminal Europa SpA Porto di Voltri 16158 Genoa Italy",
72              "terminal_code": null
73            },
74            "arrival": {
75              "estimated_date": "2024-05-13 07:00:00",
76              "port_name": "Piraeus",
77              "port_locode": "GRPIR",
78              "terminal_name": "Piraeus Container Terminal Piraeus Container Terminal N. Sempo, N. Ikonio, 18863 Perama Greece",
79              "terminal_code": null
80            },
81            "service_name": "AEM1",
82            "service_code": null
83          },
84          {
85            "order_id": 2,
86            "mode": "VESSEL",
87            "vessel_name": "MONTPELLIER",
88            "vessel_imo": null,
89            "voyages": [
90              {
91                "name": "voyage",
92                "voyage": "073E"
93              }
94            ],
95            "departure": {
96              "estimated_date": "2024-05-15 11:00:00",
97              "port_name": "Piraeus",
98              "port_locode": "GRPIR",
99              "terminal_name": "Piraeus Container Terminal Piraeus Container Terminal N. Sempo, N. Ikonio, 18863 Perama Greece",
100              "terminal_code": null
101            },
102            "arrival": {
103              "estimated_date": "2024-05-17 03:00:00",
104              "port_name": "Alexandria",
105              "port_locode": "EGALY",
106              "terminal_name": "El-Dekheala Container Terminal El-Dekheala Container Terminal (Dkchc)",
107              "terminal_code": null
108            },
109            "service_name": "AGX",
110            "service_code": null
111          }
112        ],
113        "cut_off_dates": [],
114        "transit_time": 12,
115        "direct": false,
116        "updated_at": "2024-05-10 12:35:51"
117      },
118      {
119        "schedule_id": 3088,
120        "carrier_name": "COSCO",
121        "carrier_scac": "COSU",
122        "cargo_type": "GC",
123        "origin": {
124          "estimated_date": "2024-05-08 14:52:00",
125          "port_name": "Genoa",
126          "port_locode": "ITGOA",
127          "terminal_name": "Voltri Terminal Europa SpA Porto di Voltri 16158 Genoa Italy",
128          "terminal_code": null
129        },
130        "destination": {
131          "estimated_date": "2024-08-24 23:00:00",
132          "port_name": "Alexandria",
133          "port_locode": "EGALY",
134          "terminal_name": "El-Dekheala Container Terminal El-Dekheala Container Terminal (Dkchc)",
135          "terminal_code": null
136        },
137        "legs": [
138          {
139            "order_id": 1,
140            "mode": "VESSEL",
141            "vessel_name": "COSCO SHIPPING NEBULA",
142            "vessel_imo": null,
143            "voyages": [
144              {
145                "name": "voyage",
146                "voyage": "025E"
147              }
148            ],
149            "departure": {
150              "estimated_date": "2024-05-08 14:52:00",
151              "port_name": "Genoa",
152              "port_locode": "ITGOA",
153              "terminal_name": "Voltri Terminal Europa SpA Porto di Voltri 16158 Genoa Italy",
154              "terminal_code": null
155            },
156            "arrival": {
157              "estimated_date": "2024-08-15 07:00:00",
158              "port_name": "Piraeus",
159              "port_locode": "GRPIR",
160              "terminal_name": "Piraeus Container Terminal Piraeus Container Terminal N. Sempo, N. Ikonio, 18863 Perama Greece",
161              "terminal_code": null
162            },
163            "service_name": "AEM1",
164            "service_code": null
165          },
166          {
167            "order_id": 2,
168            "mode": "VESSEL",
169            "vessel_name": "VEGA COLIGNY",
170            "vessel_imo": null,
171            "voyages": [
172              {
173                "name": "voyage",
174                "voyage": "027E"
175              }
176            ],
177            "departure": {
178              "estimated_date": "2024-08-21 10:00:00",
179              "port_name": "Piraeus",
180              "port_locode": "GRPIR",
181              "terminal_name": "Piraeus Container Terminal Piraeus Container Terminal N. Sempo, N. Ikonio, 18863 Perama Greece",
182              "terminal_code": null
183            },
184            "arrival": {
185              "estimated_date": "2024-08-24 23:00:00",
186              "port_name": "Alexandria",
187              "port_locode": "EGALY",
188              "terminal_name": "El-Dekheala Container Terminal El-Dekheala Container Terminal (Dkchc)",
189              "terminal_code": null
190            },
191            "service_name": "AGX",
192            "service_code": null
193          }
194        ],
195        "cut_off_dates": [],
196        "transit_time": 108,
197        "direct": false,
198        "updated_at": "2024-05-10 12:35:51"
199      },
200      {
201        "schedule_id": 2743,
202        "carrier_name": "MSC",
203        "carrier_scac": "MSCU",
204        "cargo_type": "GC",
205        "origin": {
206          "estimated_date": "2024-05-08 18:48:00",
207          "port_name": "GENOA",
208          "port_locode": "ITGOA",
209          "terminal_name": "BETTOLO CONTAINER TERMINAL",
210          "terminal_code": null
211        },
212        "destination": {
213          "estimated_date": "2024-05-24 22:15:00",
214          "port_name": "ALEXANDRIA OLD PORT",
215          "port_locode": "EGALY",
216          "terminal_name": "ALEXANDRIA OLD PORT",
217          "terminal_code": null
218        },
219        "legs": [
220          {
221            "order_id": 1,
222            "mode": "VESSEL",
223            "vessel_name": "MSC ALIX 3",
224            "vessel_imo": 9166651,
225            "voyages": [
226              {
227                "name": "voyage",
228                "voyage": "AC418A"
229              }
230            ],
231            "departure": {
232              "estimated_date": "2024-05-08 18:48:00",
233              "port_name": "GENOA",
234              "port_locode": "ITGOA",
235              "terminal_name": "BETTOLO CONTAINER TERMINAL",
236              "terminal_code": null
237            },
238            "arrival": {
239              "estimated_date": "2024-05-10 12:33:00",
240              "port_name": "GIOIA TAURO",
241              "port_locode": "ITGIT",
242              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
243              "terminal_code": null
244            },
245            "service_name": "LINE B",
246            "service_code": null
247          },
248          {
249            "order_id": 2,
250            "mode": "VESSEL",
251            "vessel_name": "MSC HARMONY III",
252            "vessel_imo": 9309411,
253            "voyages": [
254              {
255                "name": "voyage",
256                "voyage": "AB418A"
257              }
258            ],
259            "departure": {
260              "estimated_date": "2024-05-17 07:00:00",
261              "port_name": "GIOIA TAURO",
262              "port_locode": "ITGIT",
263              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
264              "terminal_code": null
265            },
266            "arrival": {
267              "estimated_date": "2024-05-24 22:15:00",
268              "port_name": "ALEXANDRIA OLD PORT",
269              "port_locode": "EGALY",
270              "terminal_name": "ALEXANDRIA OLD PORT",
271              "terminal_code": null
272            },
273            "service_name": "ADRIATIC TO E - MED",
274            "service_code": null
275          }
276        ],
277        "cut_off_dates": [],
278        "transit_time": 16,
279        "direct": false,
280        "updated_at": "2024-05-10 12:35:51"
281      },
282      {
283        "schedule_id": 2437,
284        "carrier_name": "COSCO",
285        "carrier_scac": "COSU",
286        "cargo_type": "GC",
287        "origin": {
288          "estimated_date": "2024-05-10 11:24:00",
289          "port_name": "Genoa",
290          "port_locode": "ITGOA",
291          "terminal_name": "Voltri Terminal Europa SpA Porto di Voltri 16158 Genoa Italy",
292          "terminal_code": null
293        },
294        "destination": {
295          "estimated_date": "2024-05-24 03:00:00",
296          "port_name": "Alexandria",
297          "port_locode": "EGALY",
298          "terminal_name": "El-Dekheala Container Terminal El-Dekheala Container Terminal (Dkchc)",
299          "terminal_code": null
300        },
301        "legs": [
302          {
303            "order_id": 1,
304            "mode": "VESSEL",
305            "vessel_name": "THALASSA TYHI",
306            "vessel_imo": null,
307            "voyages": [
308              {
309                "name": "voyage",
310                "voyage": "0639-047E"
311              }
312            ],
313            "departure": {
314              "estimated_date": "2024-05-10 11:24:00",
315              "port_name": "Genoa",
316              "port_locode": "ITGOA",
317              "terminal_name": "Voltri Terminal Europa SpA Porto di Voltri 16158 Genoa Italy",
318              "terminal_code": null
319            },
320            "arrival": {
321              "estimated_date": "2024-05-17 07:00:00",
322              "port_name": "Piraeus",
323              "port_locode": "GRPIR",
324              "terminal_name": "Piraeus Container Terminal Piraeus Container Terminal N. Sempo, N. Ikonio, 18863 Perama Greece",
325              "terminal_code": null
326            },
327            "service_name": "AEM1",
328            "service_code": null
329          },
330          {
331            "order_id": 2,
332            "mode": "VESSEL",
333            "vessel_name": "CMA CGM MONTREAL",
334            "vessel_imo": null,
335            "voyages": [
336              {
337                "name": "voyage",
338                "voyage": "0DMGTS1NL"
339              }
340            ],
341            "departure": {
342              "estimated_date": "2024-05-22 10:00:00",
343              "port_name": "Piraeus",
344              "port_locode": "GRPIR",
345              "terminal_name": "Piraeus Container Terminal Piraeus Container Terminal N. Sempo, N. Ikonio, 18863 Perama Greece",
346              "terminal_code": null
347            },
348            "arrival": {
349              "estimated_date": "2024-05-24 03:00:00",
350              "port_name": "Alexandria",
351              "port_locode": "EGALY",
352              "terminal_name": "El-Dekheala Container Terminal El-Dekheala Container Terminal (Dkchc)",
353              "terminal_code": null
354            },
355            "service_name": "AGX",
356            "service_code": null
357          }
358        ],
359        "cut_off_dates": [],
360        "transit_time": 14,
361        "direct": false,
362        "updated_at": "2024-05-10 12:35:51"
363      },
364      {
365        "schedule_id": 3445,
366        "carrier_name": "MSC",
367        "carrier_scac": "MSCU",
368        "cargo_type": "GC",
369        "origin": {
370          "estimated_date": "2024-05-18 23:00:00",
371          "port_name": "GENOA",
372          "port_locode": "ITGOA",
373          "terminal_name": "BETTOLO CONTAINER TERMINAL",
374          "terminal_code": null
375        },
376        "destination": {
377          "estimated_date": "2024-05-30 21:35:00",
378          "port_name": "ALEXANDRIA OLD PORT",
379          "port_locode": "EGALY",
380          "terminal_name": "ALEXANDRIA OLD PORT",
381          "terminal_code": null
382        },
383        "legs": [
384          {
385            "order_id": 1,
386            "mode": "VESSEL",
387            "vessel_name": "MSC MASHA 3",
388            "vessel_imo": 9188219,
389            "voyages": [
390              {
391                "name": "voyage",
392                "voyage": "AC420A"
393              }
394            ],
395            "departure": {
396              "estimated_date": "2024-05-18 23:00:00",
397              "port_name": "GENOA",
398              "port_locode": "ITGOA",
399              "terminal_name": "BETTOLO CONTAINER TERMINAL",
400              "terminal_code": null
401            },
402            "arrival": {
403              "estimated_date": "2024-05-20 16:45:00",
404              "port_name": "GIOIA TAURO",
405              "port_locode": "ITGIT",
406              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
407              "terminal_code": null
408            },
409            "service_name": "LINE B",
410            "service_code": null
411          },
412          {
413            "order_id": 2,
414            "mode": "VESSEL",
415            "vessel_name": "MSC HANNAH",
416            "vessel_imo": 9316347,
417            "voyages": [
418              {
419                "name": "voyage",
420                "voyage": "AB419A"
421              }
422            ],
423            "departure": {
424              "estimated_date": "2024-05-23 06:20:00",
425              "port_name": "GIOIA TAURO",
426              "port_locode": "ITGIT",
427              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
428              "terminal_code": null
429            },
430            "arrival": {
431              "estimated_date": "2024-05-30 21:35:00",
432              "port_name": "ALEXANDRIA OLD PORT",
433              "port_locode": "EGALY",
434              "terminal_name": "ALEXANDRIA OLD PORT",
435              "terminal_code": null
436            },
437            "service_name": "ADRIATIC TO E - MED",
438            "service_code": null
439          }
440        ],
441        "cut_off_dates": [],
442        "transit_time": 12,
443        "direct": false,
444        "updated_at": "2024-05-10 12:35:51"
445      },
446      {
447        "schedule_id": 3368,
448        "carrier_name": "MSC",
449        "carrier_scac": "MSCU",
450        "cargo_type": "GC",
451        "origin": {
452          "estimated_date": "2024-05-27 13:18:00",
453          "port_name": "GENOA",
454          "port_locode": "ITGOA",
455          "terminal_name": "BETTOLO CONTAINER TERMINAL",
456          "terminal_code": null
457        },
458        "destination": {
459          "estimated_date": "2024-06-07 13:03:00",
460          "port_name": "ALEXANDRIA OLD PORT",
461          "port_locode": "EGALY",
462          "terminal_name": "ALEXANDRIA OLD PORT",
463          "terminal_code": null
464        },
465        "legs": [
466          {
467            "order_id": 1,
468            "mode": "VESSEL",
469            "vessel_name": "MSC RHIANNON",
470            "vessel_imo": 9224051,
471            "voyages": [
472              {
473                "name": "voyage",
474                "voyage": "AC421A"
475              }
476            ],
477            "departure": {
478              "estimated_date": "2024-05-27 13:18:00",
479              "port_name": "GENOA",
480              "port_locode": "ITGOA",
481              "terminal_name": "BETTOLO CONTAINER TERMINAL",
482              "terminal_code": null
483            },
484            "arrival": {
485              "estimated_date": "2024-05-29 07:03:00",
486              "port_name": "GIOIA TAURO",
487              "port_locode": "ITGIT",
488              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
489              "terminal_code": null
490            },
491            "service_name": "LINE B",
492            "service_code": null
493          },
494          {
495            "order_id": 2,
496            "mode": "VESSEL",
497            "vessel_name": "TBN",
498            "vessel_imo": null,
499            "voyages": [
500              {
501                "name": "voyage",
502                "voyage": "TBN"
503              }
504            ],
505            "departure": {
506              "estimated_date": "2024-05-30 22:03:00",
507              "port_name": "GIOIA TAURO",
508              "port_locode": "ITGIT",
509              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
510              "terminal_code": null
511            },
512            "arrival": {
513              "estimated_date": "2024-06-07 13:03:00",
514              "port_name": "ALEXANDRIA OLD PORT",
515              "port_locode": "EGALY",
516              "terminal_name": "ALEXANDRIA OLD PORT",
517              "terminal_code": null
518            },
519            "service_name": "ADRIATIC TO E - MED",
520            "service_code": null
521          }
522        ],
523        "cut_off_dates": [],
524        "transit_time": 11,
525        "direct": false,
526        "updated_at": "2024-05-10 12:35:51"
527      },
528      {
529        "schedule_id": 3849,
530        "carrier_name": "COSCO",
531        "carrier_scac": "COSU",
532        "cargo_type": "GC",
533        "origin": {
534          "estimated_date": "2024-06-01 18:00:00",
535          "port_name": "Genoa",
536          "port_locode": "ITGOA",
537          "terminal_name": "Voltri Terminal Europa SpA Porto di Voltri 16158 Genoa Italy",
538          "terminal_code": null
539        },
540        "destination": {
541          "estimated_date": "2024-09-06 03:00:00",
542          "port_name": "Alexandria",
543          "port_locode": "EGALY",
544          "terminal_name": "El-Dekheala Container Terminal El-Dekheala Container Terminal (Dkchc)",
545          "terminal_code": null
546        },
547        "legs": [
548          {
549            "order_id": 1,
550            "mode": "VESSEL",
551            "vessel_name": "COSCO SHIPPING PISCES",
552            "vessel_imo": null,
553            "voyages": [
554              {
555                "name": "voyage",
556                "voyage": "025E"
557              }
558            ],
559            "departure": {
560              "estimated_date": "2024-06-01 18:00:00",
561              "port_name": "Genoa",
562              "port_locode": "ITGOA",
563              "terminal_name": "Voltri Terminal Europa SpA Porto di Voltri 16158 Genoa Italy",
564              "terminal_code": null
565            },
566            "arrival": {
567              "estimated_date": "2024-08-29 07:00:00",
568              "port_name": "Piraeus",
569              "port_locode": "GRPIR",
570              "terminal_name": "Piraeus Container Terminal Piraeus Container Terminal N. Sempo, N. Ikonio, 18863 Perama Greece",
571              "terminal_code": null
572            },
573            "service_name": "AEM1",
574            "service_code": null
575          },
576          {
577            "order_id": 2,
578            "mode": "VESSEL",
579            "vessel_name": "MONTPELLIER",
580            "vessel_imo": null,
581            "voyages": [
582              {
583                "name": "voyage",
584                "voyage": "077E"
585              }
586            ],
587            "departure": {
588              "estimated_date": "2024-09-04 10:00:00",
589              "port_name": "Piraeus",
590              "port_locode": "GRPIR",
591              "terminal_name": "Piraeus Container Terminal Piraeus Container Terminal N. Sempo, N. Ikonio, 18863 Perama Greece",
592              "terminal_code": null
593            },
594            "arrival": {
595              "estimated_date": "2024-09-06 03:00:00",
596              "port_name": "Alexandria",
597              "port_locode": "EGALY",
598              "terminal_name": "El-Dekheala Container Terminal El-Dekheala Container Terminal (Dkchc)",
599              "terminal_code": null
600            },
601            "service_name": "AGX",
602            "service_code": null
603          }
604        ],
605        "cut_off_dates": [],
606        "transit_time": 97,
607        "direct": false,
608        "updated_at": "2024-05-10 12:35:51"
609      },
610      {
611        "schedule_id": 3189,
612        "carrier_name": "MSC",
613        "carrier_scac": "MSCU",
614        "cargo_type": "GC",
615        "origin": {
616          "estimated_date": "2024-06-05 18:48:00",
617          "port_name": "GENOA",
618          "port_locode": "ITGOA",
619          "terminal_name": "BETTOLO CONTAINER TERMINAL",
620          "terminal_code": null
621        },
622        "destination": {
623          "estimated_date": "2024-06-16 18:33:00",
624          "port_name": "ALEXANDRIA OLD PORT",
625          "port_locode": "EGALY",
626          "terminal_name": "ALEXANDRIA OLD PORT",
627          "terminal_code": null
628        },
629        "legs": [
630          {
631            "order_id": 1,
632            "mode": "VESSEL",
633            "vessel_name": "MSC ALIX 3",
634            "vessel_imo": 9166651,
635            "voyages": [
636              {
637                "name": "voyage",
638                "voyage": "AC422A"
639              }
640            ],
641            "departure": {
642              "estimated_date": "2024-06-05 18:48:00",
643              "port_name": "GENOA",
644              "port_locode": "ITGOA",
645              "terminal_name": "BETTOLO CONTAINER TERMINAL",
646              "terminal_code": null
647            },
648            "arrival": {
649              "estimated_date": "2024-06-07 12:33:00",
650              "port_name": "GIOIA TAURO",
651              "port_locode": "ITGIT",
652              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
653              "terminal_code": null
654            },
655            "service_name": "LINE B",
656            "service_code": null
657          },
658          {
659            "order_id": 2,
660            "mode": "VESSEL",
661            "vessel_name": "TBN",
662            "vessel_imo": null,
663            "voyages": [
664              {
665                "name": "voyage",
666                "voyage": "TBN"
667              }
668            ],
669            "departure": {
670              "estimated_date": "2024-06-09 03:33:00",
671              "port_name": "GIOIA TAURO",
672              "port_locode": "ITGIT",
673              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
674              "terminal_code": null
675            },
676            "arrival": {
677              "estimated_date": "2024-06-16 18:33:00",
678              "port_name": "ALEXANDRIA OLD PORT",
679              "port_locode": "EGALY",
680              "terminal_name": "ALEXANDRIA OLD PORT",
681              "terminal_code": null
682            },
683            "service_name": "ADRIATIC TO E - MED",
684            "service_code": null
685          }
686        ],
687        "cut_off_dates": [],
688        "transit_time": 11,
689        "direct": false,
690        "updated_at": "2024-05-10 12:35:51"
691      },
692      {
693        "schedule_id": 3673,
694        "carrier_name": "MSC",
695        "carrier_scac": "MSCU",
696        "cargo_type": "GC",
697        "origin": {
698          "estimated_date": "2024-06-11 12:30:00",
699          "port_name": "GENOA",
700          "port_locode": "ITGOA",
701          "terminal_name": "BETTOLO CONTAINER TERMINAL",
702          "terminal_code": null
703        },
704        "destination": {
705          "estimated_date": "2024-06-21 22:15:00",
706          "port_name": "ALEXANDRIA OLD PORT",
707          "port_locode": "EGALY",
708          "terminal_name": "ALEXANDRIA OLD PORT",
709          "terminal_code": null
710        },
711        "legs": [
712          {
713            "order_id": 1,
714            "mode": "VESSEL",
715            "vessel_name": "MSC ELEONORA",
716            "vessel_imo": 9064750,
717            "voyages": [
718              {
719                "name": "voyage",
720                "voyage": "AC423A"
721              }
722            ],
723            "departure": {
724              "estimated_date": "2024-06-11 12:30:00",
725              "port_name": "GENOA",
726              "port_locode": "ITGOA",
727              "terminal_name": "BETTOLO CONTAINER TERMINAL",
728              "terminal_code": null
729            },
730            "arrival": {
731              "estimated_date": "2024-06-13 06:15:00",
732              "port_name": "GIOIA TAURO",
733              "port_locode": "ITGIT",
734              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
735              "terminal_code": null
736            },
737            "service_name": "LINE B",
738            "service_code": null
739          },
740          {
741            "order_id": 2,
742            "mode": "VESSEL",
743            "vessel_name": "MSC HARMONY III",
744            "vessel_imo": 9309411,
745            "voyages": [
746              {
747                "name": "voyage",
748                "voyage": "AB422A"
749              }
750            ],
751            "departure": {
752              "estimated_date": "2024-06-14 07:00:00",
753              "port_name": "GIOIA TAURO",
754              "port_locode": "ITGIT",
755              "terminal_name": "MEDCENTER CONTAINER TERMINAL",
756              "terminal_code": null
757            },
758            "arrival": {
759              "estimated_date": "2024-06-21 22:15:00",
760              "port_name": "ALEXANDRIA OLD PORT",
761              "port_locode": "EGALY",
762              "terminal_name": "ALEXANDRIA OLD PORT",
763              "terminal_code": null
764            },
765            "service_name": "ADRIATIC TO E - MED",
766            "service_code": null
767          }
768        ],
769        "cut_off_dates": [],
770        "transit_time": 10,
771        "direct": false,
772        "updated_at": "2024-05-10 12:35:51"
773      }
774    ]
775  }
776}

Schedules by Vessel

get/schedules/by-vessel

Get schedules for particular vessel using it's IMO number, and SCACs for carriers filter.

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-API-KEY

Example: X-API-KEY: 123

Headers

Content-Typeapplication/json

Query Parameters

carriersOptionalstring
SCAC codes list
Example:MAEU,MSCU,COSU,ONEY,HDMU,OOLU,YMLU,EGLV,CMDU
Match pattern:^([A-Z0-9]{4}(?:(,[A-Z0-9]{4})){0,})$
imoREQUIREDinteger
IMO code of the vessel
Example:9588081
voyagesOptionalstring
Voyage numbers list
Example:057W,058E

Response example

Schedules by Vessel

1{
2  "success": true,
3  "status_code": "OK",
4  "metadata": {
5    "request_parameters": {
6      "carriers": "YMLU,OOLU",
7      "imo": 9588081,
8      "voyages": "058E,058W"
9    },
10    "response_stats": [
11      {
12        "status_code": "SCHEDULES_FOUND",
13        "carrier_name": "YANG MING",
14        "found_schedules": 1
15      },
16      {
17        "status_code": "SCHEDULES_FOUND",
18        "carrier_name": "OOCL",
19        "found_schedules": 1
20      }
21    ]
22  },
23  "data": {
24    "schedules": [
25      {
26        "schedule_id": 3296,
27        "carrier_name": "YANG MING",
28        "carrier_scac": "YMLU",
29        "vessel_name": "ONE HELSINKI",
30        "vessel_imo": 9588081,
31        "service_name": "FP1",
32        "service_code": "FP1",
33        "all_voyages": [
34          "058E",
35          "FP12406AB"
36        ],
37        "calling_ports": [
38          {
39            "order_id": 1,
40            "voyages": [
41              {
42                "name": "arrival",
43                "voyage": "058E"
44              },
45              {
46                "name": "arrival local",
47                "voyage": "FP12406AB"
48              },
49              {
50                "name": "departure",
51                "voyage": "058E"
52              },
53              {
54                "name": "departure local",
55                "voyage": "FP12406AB"
56              }
57            ],
58            "skip": false,
59            "estimated_dates": {
60              "arrival_date": null,
61              "berth_date": null,
62              "departure_date": null
63            },
64            "actual_dates": {
65              "arrival_date": "2024-04-13 23:00:00",
66              "berth_date": "2024-04-14 00:00:00",
67              "departure_date": "2024-04-14 22:00:00"
68            },
69            "port_name": "Busan, Busan Gwang'yeogsi [Pusan-Kwangyokshi]",
70            "port_locode": "KRPUS",
71            "terminal_name": "HMM PSA NEW-PORT TERMINAL",
72            "terminal_code": null,
73            "cut_off_dates": []
74          },
75          {
76            "order_id": 2,
77            "voyages": [
78              {
79                "name": "arrival",
80                "voyage": "058E"
81              },
82              {
83                "name": "arrival local",
84                "voyage": "FP12406AB"
85              },
86              {
87                "name": "departure",
88                "voyage": "058E"
89              },
90              {
91                "name": "departure local",
92                "voyage": "FP12406AB"
93              }
94            ],
95            "skip": false,
96            "estimated_dates": {
97              "arrival_date": null,
98              "berth_date": null,
99              "departure_date": null
100            },
101            "actual_dates": {
102              "arrival_date": "2024-04-16 13:30:00",
103              "berth_date": "2024-04-16 14:23:00",
104              "departure_date": "2024-04-17 01:48:00"
105            },
106            "port_name": "Kobe, Hyogo[Hyogo]",
107            "port_locode": "JPUKB",
108            "terminal_name": "PORT ISLAND PC16/17",
109            "terminal_code": null,
110            "cut_off_dates": []
111          },
112          {
113            "order_id": 3,
114            "voyages": [
115              {
116                "name": "arrival",
117                "voyage": "058E"
118              },
119              {
120                "name": "arrival local",
121                "voyage": "FP12406AB"
122              },
123              {
124                "name": "departure",
125                "voyage": "058E"
126              },
127              {
128                "name": "departure local",
129                "voyage": "FP12406AB"
130              }
131            ],
132            "skip": false,
133            "estimated_dates": {
134              "arrival_date": null,
135              "berth_date": null,
136              "departure_date": null
137            },
138            "actual_dates": {
139              "arrival_date": "2024-04-17 16:45:00",
140              "berth_date": "2024-04-17 20:15:00",
141              "departure_date": "2024-04-18 15:00:00"
142            },
143            "port_name": "Nagoya, Aiti [Aichi]",
144            "port_locode": "JPNGO",
145            "terminal_name": "TOBISHIMA CONTAINER BERTH",
146            "terminal_code": null,
147            "cut_off_dates": []
148          },
149          {
150            "order_id": 4,
151            "voyages": [
152              {
153                "name": "arrival",
154                "voyage": "058E"
155              },
156              {
157                "name": "arrival local",
158                "voyage": "FP12406AB"
159              },
160              {
161                "name": "departure",
162                "voyage": "058E"
163              },
164              {
165                "name": "departure local",
166                "voyage": "FP12406AB"
167              }
168            ],
169            "skip": false,
170            "estimated_dates": {
171              "arrival_date": null,
172              "berth_date": null,
173              "departure_date": null
174            },
175            "actual_dates": {
176              "arrival_date": "2024-04-19 06:57:00",
177              "berth_date": "2024-04-19 07:41:00",
178              "departure_date": "2024-04-20 16:23:00"
179            },
180            "port_name": "Tokyo, Tokyo [Tokyo]",
181            "port_locode": "JPTYO",
182            "terminal_name": "OHI NO. 6/7 NYK CONTAINER TERMINAL",
183            "terminal_code": null,
184            "cut_off_dates": []
185          },
186          {
187            "order_id": 5,
188            "voyages": [
189              {
190                "name": "arrival",
191                "voyage": "058E"
192              },
193              {
194                "name": "arrival local",
195                "voyage": "FP12406AB"
196              },
197              {
198                "name": "departure",
199                "voyage": "058E"
200              },
201              {
202                "name": "departure local",
203                "voyage": "FP12406AB"
204              }
205            ],
206            "skip": false,
207            "estimated_dates": {
208              "arrival_date": null,
209              "berth_date": null,
210              "departure_date": null
211            },
212            "actual_dates": {
213              "arrival_date": "2024-05-03 04:38:00",
214              "berth_date": "2024-05-03 05:55:00",
215              "departure_date": "2024-05-07 03:20:00"
216            },
217            "port_name": "Los Angeles, California",
218            "port_locode": "USLAX",
219            "terminal_name": "YUSEN TERMINAL",
220            "terminal_code": null,
221            "cut_off_dates": []
222          },
223          {
224            "order_id": 6,
225            "voyages": [
226              {
227                "name": "arrival",
228                "voyage": "058E"
229              },
230              {
231                "name": "arrival local",
232                "voyage": "FP12406AB"
233              },
234              {
235                "name": "departure",
236                "voyage": "058E"
237              },
238              {
239                "name": "departure local",
240                "voyage": "FP12406AB"
241              }
242            ],
243            "skip": false,
244            "estimated_dates": {
245              "arrival_date": "2024-05-09 05:00:00",
246              "berth_date": "2024-05-09 07:00:00",
247              "departure_date": "2024-05-10 17:00:00"
248            },
249            "actual_dates": {
250              "arrival_date": null,
251              "berth_date": null,
252              "departure_date": null
253            },
254            "port_name": "Oakland, California",
255            "port_locode": "USOAK",
256            "terminal_name": "TRAPAC, INC. (OAK)",
257            "terminal_code": null,
258            "cut_off_dates": []
259          },
260          {
261            "order_id": 7,
262            "voyages": [
263              {
264                "name": "arrival",
265                "voyage": "058E"
266              },
267              {
268                "name": "arrival local",
269                "voyage": "FP12406AB"
270              },
271              {
272                "name": "departure",
273                "voyage": "058E"
274              },
275              {
276                "name": "departure local",
277                "voyage": "FP12406AB"
278              }
279            ],
280            "skip": false,
281            "estimated_dates": {
282              "arrival_date": "2024-05-23 05:00:00",
283              "berth_date": "2024-05-23 08:00:00",
284              "departure_date": "2024-05-24 04:00:00"
285            },
286            "actual_dates": {
287              "arrival_date": null,
288              "berth_date": null,
289              "departure_date": null
290            },
291            "port_name": "Tokyo, Tokyo [Tokyo]",
292            "port_locode": "JPTYO",
293            "terminal_name": "TOKYO OHI TML",
294            "terminal_code": null,
295            "cut_off_dates": []
296          },
297          {
298            "order_id": 8,
299            "voyages": [
300              {
301                "name": "arrival",
302                "voyage": "058E"
303              },
304              {
305                "name": "arrival local",
306                "voyage": "FP12406AB"
307              },
308              {
309                "name": "departure",
310                "voyage": "058E"
311              },
312              {
313                "name": "departure local",
314                "voyage": "FP12406AB"
315              }
316            ],
317            "skip": false,
318            "estimated_dates": {
319              "arrival_date": "2024-05-26 05:00:00",
320              "berth_date": "2024-05-26 08:00:00",
321              "departure_date": "2024-05-27 03:00:00"
322            },
323            "actual_dates": {
324              "arrival_date": null,
325              "berth_date": null,
326              "departure_date": null
327            },
328            "port_name": "Kobe, Hyogo[Hyogo]",
329            "port_locode": "JPUKB",
330            "terminal_name": "ROKKO ISLAND C-6/7",
331            "terminal_code": null,
332            "cut_off_dates": []
333          },
334          {
335            "order_id": 9,
336            "voyages": [
337              {
338                "name": "arrival",
339                "voyage": "058E"
340              },
341              {
342                "name": "arrival local",
343                "voyage": "FP12406AB"
344              },
345              {
346                "name": "departure",
347                "voyage": "058E"
348              },
349              {
350                "name": "departure local",
351                "voyage": "FP12406AB"
352              }
353            ],
354            "skip": false,
355            "estimated_dates": {
356              "arrival_date": "2024-05-27 05:00:00",
357              "berth_date": "2024-05-27 08:00:00",
358              "departure_date": "2024-05-28 13:00:00"
359            },
360            "actual_dates": {
361              "arrival_date": null,
362              "berth_date": null,
363              "departure_date": null
364            },
365            "port_name": "Nagoya, Aiti [Aichi]",
366            "port_locode": "JPNGO",
367            "terminal_name": "TOBISHIMA CONTAINER BERTH",
368            "terminal_code": null,
369            "cut_off_dates": []
370          },
371          {
372            "order_id": 10,
373            "voyages": [
374              {
375                "name": "arrival",
376                "voyage": "058E"
377              },
378              {
379                "name": "arrival local",
380                "voyage": "FP12406AB"
381              },
382              {
383                "name": "departure",
384                "voyage": "058E"
385              },
386              {
387                "name": "departure local",
388                "voyage": "FP12406AB"
389              }
390            ],
391            "skip": false,
392            "estimated_dates": {
393              "arrival_date": "2024-05-30 02:00:00",
394              "berth_date": "2024-05-30 04:00:00",
395              "departure_date": "2024-05-31 00:00:00"
396            },
397            "actual_dates": {
398              "arrival_date": null,
399              "berth_date": null,
400              "departure_date": null
401            },
402            "port_name": "Busan, Busan Gwang'yeogsi [Pusan-Kwangyokshi]",
403            "port_locode": "KRPUS",
404            "terminal_name": "HMM PSA NEW-PORT TERMINAL",
405            "terminal_code": null,
406            "cut_off_dates": []
407          }
408        ],
409        "updated_at": "2024-05-10 12:41:37"
410      },
411      {
412        "schedule_id": 2747,
413        "carrier_name": "OOCL",
414        "carrier_scac": "OOLU",
415        "vessel_name": "ONE HELSINKI",
416        "vessel_imo": 9588081,
417        "service_name": "JPX",
418        "service_code": "JPX",
419        "all_voyages": [
420          "057W",
421          "058E",
422          "058W",
423          "059E",
424          "059W"
425        ],
426        "calling_ports": [
427          {
428            "order_id": 1,
429            "voyages": [
430              {
431                "name": "arrival",
432                "voyage": "057W"
433              },
434              {
435                "name": "departure",
436                "voyage": "057W"
437              }
438            ],
439            "skip": false,
440            "estimated_dates": {
441              "arrival_date": null,
442              "berth_date": null,
443              "departure_date": null
444            },
445            "actual_dates": {
446              "arrival_date": "2024-04-10 08:21:00",
447              "berth_date": null,
448              "departure_date": "2024-04-10 17:40:00"
449            },
450            "port_name": "Nagoya, Aiti [Aichi]",
451            "port_locode": "JPNGO",
452            "terminal_name": null,
453            "terminal_code": null,
454            "cut_off_dates": []
455          },
456          {
457            "order_id": 2,
458            "voyages": [
459              {
460                "name": "arrival",
461                "voyage": "058E"
462              },
463              {
464                "name": "departure",
465                "voyage": "058E"
466              }
467            ],
468            "skip": false,
469            "estimated_dates": {
470              "arrival_date": null,
471              "berth_date": null,
472              "departure_date": null
473            },
474            "actual_dates": {
475              "arrival_date": "2024-04-16 14:38:00",
476              "berth_date": null,
477              "departure_date": "2024-04-17 02:00:00"
478            },
479            "port_name": "Kobe, Hyogo[Hyogo]",
480            "port_locode": "JPUKB",
481            "terminal_name": null,
482            "terminal_code": null,
483            "cut_off_dates": []
484          },
485          {
486            "order_id": 3,
487            "voyages": [
488              {
489                "name": "arrival",
490                "voyage": "058E"
491              },
492              {
493                "name": "departure",
494                "voyage": "058E"
495              }
496            ],
497            "skip": false,
498            "estimated_dates": {
499              "arrival_date": null,
500              "berth_date": null,
501              "departure_date": null
502            },
503            "actual_dates": {
504              "arrival_date": "2024-04-17 20:08:00",
505              "berth_date": null,
506              "departure_date": "2024-04-18 14:57:00"
507            },
508            "port_name": "Nagoya, Aiti [Aichi]",
509            "port_locode": "JPNGO",
510            "terminal_name": null,
511            "terminal_code": null,
512            "cut_off_dates": []
513          },
514          {
515            "order_id": 4,
516            "voyages": [
517              {
518                "name": "arrival",
519                "voyage": "058E"
520              },
521              {
522                "name": "departure",
523                "voyage": "058E"
524              }
525            ],
526            "skip": false,
527            "estimated_dates": {
528              "arrival_date": null,
529              "berth_date": null,
530              "departure_date": null
531            },
532            "actual_dates": {
533              "arrival_date": "2024-04-19 07:47:00",
534              "berth_date": null,
535              "departure_date": "2024-04-20 16:30:00"
536            },
537            "port_name": "Tokyo, Tokyo [Tokyo]",
538            "port_locode": "JPTYO",
539            "terminal_name": null,
540            "terminal_code": null,
541            "cut_off_dates": []
542          },
543          {
544            "order_id": 5,
545            "voyages": [
546              {
547                "name": "arrival",
548                "voyage": "058W"
549              },
550              {
551                "name": "departure",
552                "voyage": "058W"
553              }
554            ],
555            "skip": false,
556            "estimated_dates": {
557              "arrival_date": null,
558              "berth_date": null,
559              "departure_date": null
560            },
561            "actual_dates": {
562              "arrival_date": "2024-05-03 05:59:00",
563              "berth_date": null,
564              "departure_date": "2024-05-07 03:12:00"
565            },
566            "port_name": "Los Angeles, California",
567            "port_locode": "USLAX",
568            "terminal_name": null,
569            "terminal_code": null,
570            "cut_off_dates": []
571          },
572          {
573            "order_id": 6,
574            "voyages": [
575              {
576                "name": "arrival",
577                "voyage": "058W"
578              },
579              {
580                "name": "departure",
581                "voyage": "058W"
582              }
583            ],
584            "skip": false,
585            "estimated_dates": {
586              "arrival_date": "2024-05-09 07:00:00",
587              "berth_date": null,
588              "departure_date": "2024-05-10 17:00:00"
589            },
590            "actual_dates": {
591              "arrival_date": null,
592              "berth_date": null,
593              "departure_date": null
594            },
595            "port_name": "Oakland, California",
596            "port_locode": "USOAK",
597            "terminal_name": null,
598            "terminal_code": null,
599            "cut_off_dates": []
600          },
601          {
602            "order_id": 7,
603            "voyages": [
604              {
605                "name": "arrival",
606                "voyage": "058W"
607              },
608              {
609                "name": "departure",
610                "voyage": "058W"
611              }
612            ],
613            "skip": false,
614            "estimated_dates": {
615              "arrival_date": "2024-05-23 08:00:00",
616              "berth_date": null,
617              "departure_date": "2024-05-24 04:00:00"
618            },
619            "actual_dates": {
620              "arrival_date": null,
621              "berth_date": null,
622              "departure_date": null
623            },
624            "port_name": "Tokyo, Tokyo [Tokyo]",
625            "port_locode": "JPTYO",
626            "terminal_name": null,
627            "terminal_code": null,
628            "cut_off_dates": []
629          },
630          {
631            "order_id": 8,
632            "voyages": [
633              {
634                "name": "arrival",
635                "voyage": "058W"
636              },
637              {
638                "name": "departure",
639                "voyage": "058W"
640              }
641            ],
642            "skip": false,
643            "estimated_dates": {
644              "arrival_date": "2024-05-25 08:00:00",
645              "berth_date": null,
646              "departure_date": "2024-05-26 03:00:00"
647            },
648            "actual_dates": {
649              "arrival_date": null,
650              "berth_date": null,
651              "departure_date": null
652            },
653            "port_name": "Kobe, Hyogo[Hyogo]",
654            "port_locode": "JPUKB",
655            "terminal_name": null,
656            "terminal_code": null,
657            "cut_off_dates": []
658          },
659          {
660            "order_id": 9,
661            "voyages": [
662              {
663                "name": "arrival",
664                "voyage": "058W"
665              },
666              {
667                "name": "departure",
668                "voyage": "058W"
669              }
670            ],
671            "skip": false,
672            "estimated_dates": {
673              "arrival_date": "2024-05-26 19:00:00",
674              "berth_date": null,
675              "departure_date": "2024-05-27 17:00:00"
676            },
677            "actual_dates": {
678              "arrival_date": null,
679              "berth_date": null,
680              "departure_date": null
681            },
682            "port_name": "Nagoya, Aiti [Aichi]",
683            "port_locode": "JPNGO",
684            "terminal_name": null,
685            "terminal_code": null,
686            "cut_off_dates": []
687          },
688          {
689            "order_id": 10,
690            "voyages": [
691              {
692                "name": "arrival",
693                "voyage": "059E"
694              },
695              {
696                "name": "departure",
697                "voyage": "059E"
698              }
699            ],
700            "skip": false,
701            "estimated_dates": {
702              "arrival_date": "2024-05-31 19:00:00",
703              "berth_date": null,
704              "departure_date": "2024-06-02 00:00:00"
705            },
706            "actual_dates": {
707              "arrival_date": null,
708              "berth_date": null,
709              "departure_date": null
710            },
711            "port_name": "Kobe, Hyogo[Hyogo]",
712            "port_locode": "JPUKB",
713            "terminal_name": null,
714            "terminal_code": null,
715            "cut_off_dates": []
716          },
717          {
718            "order_id": 11,
719            "voyages": [
720              {
721                "name": "arrival",
722                "voyage": "059E"
723              },
724              {
725                "name": "departure",
726                "voyage": "059E"
727              }
728            ],
729            "skip": false,
730            "estimated_dates": {
731              "arrival_date": "2024-06-03 08:00:00",
732              "berth_date": null,
733              "departure_date": "2024-06-04 14:00:00"
734            },
735            "actual_dates": {
736              "arrival_date": null,
737              "berth_date": null,
738              "departure_date": null
739            },
740            "port_name": "Nagoya, Aiti [Aichi]",
741            "port_locode": "JPNGO",
742            "terminal_name": null,
743            "terminal_code": null,
744            "cut_off_dates": []
745          },
746          {
747            "order_id": 12,
748            "voyages": [
749              {
750                "name": "arrival",
751                "voyage": "059E"
752              },
753              {
754                "name": "departure",
755                "voyage": "059E"
756              }
757            ],
758            "skip": false,
759            "estimated_dates": {
760              "arrival_date": "2024-06-06 00:00:00",
761              "berth_date": null,
762              "departure_date": "2024-06-07 21:00:00"
763            },
764            "actual_dates": {
765              "arrival_date": null,
766              "berth_date": null,
767              "departure_date": null
768            },
769            "port_name": "Tokyo, Tokyo [Tokyo]",
770            "port_locode": "JPTYO",
771            "terminal_name": null,
772            "terminal_code": null,
773            "cut_off_dates": []
774          },
775          {
776            "order_id": 13,
777            "voyages": [
778              {
779                "name": "arrival",
780                "voyage": "059W"
781              },
782              {
783                "name": "departure",
784                "voyage": "059W"
785              }
786            ],
787            "skip": false,
788            "estimated_dates": {
789              "arrival_date": "2024-06-19 18:00:00",
790              "berth_date": null,
791              "departure_date": "2024-06-24 03:00:00"
792            },
793            "actual_dates": {
794              "arrival_date": null,
795              "berth_date": null,
796              "departure_date": null
797            },
798            "port_name": "Los Angeles, California",
799            "port_locode": "USLAX",
800            "terminal_name": null,
801            "terminal_code": null,
802            "cut_off_dates": []
803          },
804          {
805            "order_id": 14,
806            "voyages": [
807              {
808                "name": "arrival",
809                "voyage": "059W"
810              },
811              {
812                "name": "departure",
813                "voyage": "059W"
814              }
815            ],
816            "skip": false,
817            "estimated_dates": {
818              "arrival_date": "2024-06-25 08:00:00",
819              "berth_date": null,
820              "departure_date": "2024-06-26 17:00:00"
821            },
822            "actual_dates": {
823              "arrival_date": null,
824              "berth_date": null,
825              "departure_date": null
826            },
827            "port_name": "Oakland, California",
828            "port_locode": "USOAK",
829            "terminal_name": null,
830            "terminal_code": null,
831            "cut_off_dates": []
832          }
833        ],
834        "updated_at": "2024-05-10 12:41:37"
835      }
836    ]
837  }
838}

Get carriers list

get/carriers

Get list of all carriers in schedules system

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-API-KEY

Example: X-API-KEY: 123

Headers

Content-Typeapplication/json

Query Parameters

schedule_typeOptionalstring
Filter carriers by supported schedules types:
- BY_POINTS - get list of carriers for Schedules by Points
- BY_VESSEL - get list of carriers for Schedules by Vessel
Allowed values:BY_POINTSBY_VESSEL
cargo_typeOptionalstring
Filter carriers by supported cargo types:
- GC - General cargo
- REEF - Reefer
- RORO - Ro-Ro
- LCL - Less container load
Allowed values:GCREEFROROLCL

Response example

A list of carriers

1{
2  "success": true,
3  "status_code": "OK",
4  "data": {
5    "carriers": [
6      {
7        "name": "MAERSK",
8        "category": "Deep Sea",
9        "scac_codes": [
10          "MAEU"
11        ],
12        "supported_schedule_types": [
13          "BY_POINTS"
14        ],
15        "supported_cargo_types": [
16          "GC"
17        ],
18        "active": true,
19        "maintenance": {
20          "by_points": false,
21          "by_vessel": false
22        }
23      }
24    ]
25  }
26}

Get carrier entry

get/carriers/{scac}

Get carrier entry

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-API-KEY

Example: X-API-KEY: 123

Headers

Content-Typeapplication/json

Path Parameters

scacREQUIREDstring
SCAC
Example:MAEU
Match pattern:^[A-Z0-9]{4}$

Response example

Carrier detailed information

1{
2  "success": true,
3  "status_code": "OK",
4  "data": {
5    "carrier": {
6      "name": "MAERSK",
7      "category": "Deep Sea",
8      "scac_codes": [
9        "MAEU"
10      ],
11      "supported_schedule_types": [
12        "BY_POINTS"
13      ],
14      "supported_cargo_types": [
15        "GC"
16      ],
17      "active": true,
18      "maintenance": {
19        "by_points": false,
20        "by_vessel": false
21      }
22    }
23  }
24}

Get vessel entry

get/vessels/{imo}

Get detailed information on vessel

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-API-KEY

Example: X-API-KEY: 123

Headers

Content-Typeapplication/json

Path Parameters

imoREQUIREDinteger
IMO
Example:9588081

Response example

Vessel detailed information

1{
2  "success": true,
3  "status_code": "OK",
4  "data": {
5    "vessel": {
6      "name": "ONE HELSINKI",
7      "imo": 9588081,
8      "call_sign": "3FIW4",
9      "mmsi": 373119000,
10      "flag": "PA",
11      "year_built": 2012,
12      "capacity_teu": 8930
13    }
14  }
15}

Get port entry

get/ports/{locode}

Get detailed information on port

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-API-KEY

Example: X-API-KEY: 123

Headers

Content-Typeapplication/json

Path Parameters

locodeREQUIREDstring
UN/LOCODE
Example:USNYC
Match pattern:^[A-Z0-9]{5}$

Response example

Port detailed information

1{
2  "success": true,
3  "status_code": "OK",
4  "data": {
5    "port": {
6      "name": "New York",
7      "state": "New York",
8      "country": "United States",
9      "country_code": "US",
10      "locode": "USNYC",
11      "lat": 40.6759,
12      "lng": -74.0829,
13      "timezone": "America/New_York"
14    }
15  }
16}

Get api usage info

get/usage

Get api usage info

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-API-KEY

Example: X-API-KEY: 123

Headers

Content-Typeapplication/json

Response example

Usage info

1{
2  "success": true,
3  "status_code": "OK",
4  "data": {
5    "calls": {
6      "total": 3000,
7      "used": 20,
8      "remaining": 2980
9    },
10    "calls_by_type": {
11      "by_points": 10,
12      "by_vessel": 10
13    },
14    "expires_on": "2026-02-28 00:00:00"
15  }
16}

SeaRates 2023—Find a tool Request an IT quote Contact us

Introduction

Ship Schedules API

version 2

OpenAPI Specification

OpenAPI Spec

General information

API endpoint#

Schedules by Points

Headers

Query Parameters

Show response schema

Response example

Schedules by Vessel

Headers

Query Parameters

Show response schema

Response example

Get carriers list

Headers

Query Parameters

Show response schema

Response example

Get carrier entry

Headers

Path Parameters

Show response schema

Response example

Get vessel entry

Headers

Path Parameters

Show response schema

Response example

Get port entry

Headers

Path Parameters

Show response schema

Response example

Get api usage info

Headers

Show response schema

Response example