The endpoint allows you to retrieve your monthly usages of the API
- [Retrieve list of shipments called with the API, that usages have a minimum resolution of a month (you cant select the usage for one week for example, the usage will automatically be for the month of the week provided)](https://documentation.safecube.ai/reference/retrieveshipmentusages.md) - [🚀Getting Started with Webhooks](https://documentation.safecube.ai/reference/getting-started-with-webhooks.md): Creating and setting up a webhook in Sinay’s webhook API can be done in 2 ways. - [Adding shipments](https://documentation.safecube.ai/reference/react-to-shipmentinerror.md): Understanding webhook events when adding shipments to your endpoint. - [Testing your endpoint](https://documentation.safecube.ai/reference/testing-your-endpoint.md): A guide to testing if your webhook endpoint is functional. - [Detect and Recover webhook failures](https://documentation.safecube.ai/reference/detect-and-recover-webhook-failures.md) - [Shipment usage](https://documentation.safecube.ai/reference/shipment-usage.md): Optimize your tracking to avoid overages. - [🧰 Webhook Resources](https://documentation.safecube.ai/reference/webhook-ressources.md) - [🔄️Synchronous and Asynchronous tracking](https://documentation.safecube.ai/reference/️synchronous-and-asynchronous-tracking.md): Synchronous vs Asynchronous APIs: Choosing Between Container Tracking and Webhook - [Webhooks as PUSH API](https://documentation.safecube.ai/reference/using-webhooks-as-a-push-api.md): Webhooks API can be used either to notify your users about specific change in the data AND/OR to update your data automatically (without making any Container API requests). Find here the documentation on how to get automatic data updates. - [Possible Events](https://documentation.safecube.ai/reference/possible-webhook-events.md) - [Auto removal policy](https://documentation.safecube.ai/reference/auto-removal-policy.md): Shipments are automatically unsubscribed from your endpoints. Here is when. - [Create Endpoint](https://documentation.safecube.ai/reference/v1endpointcreate.md): Create a new endpoint for the application. Specify the url you wish to receive webhooks and the events you wish to track. When `secret` is `null` the secret is automatically generated (recommended) - [List Endpoints](https://documentation.safecube.ai/reference/v1endpointlist.md): List the application's endpoints. - [Get Endpoint](https://documentation.safecube.ai/reference/v1endpointget.md): Retrieve an endpoint parameters. - [Update Endpoint](https://documentation.safecube.ai/reference/v1endpointupdate.md): Update an endpoint. This will replace all your endpoint parameters with the one you specify. If you don't specify a parameter, it will be erased. If you wish to update an endpoint partially, use PATCH /endpoint/{endpoint_id} - [Delete Endpoint](https://documentation.safecube.ai/reference/v1endpointdelete.md): Delete an endpoint. - [Patch Endpoint](https://documentation.safecube.ai/reference/v1endpointpatch.md): Partially update an endpoint. - [Get Endpoint Secret](https://documentation.safecube.ai/reference/v1endpointget-secret.md): Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/). - [Rotate Endpoint Secret](https://documentation.safecube.ai/reference/v1endpointrotate-secret.md): Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours. - [Endpoint Stats](https://documentation.safecube.ai/reference/v1endpointget-stats.md): Get basic statistics for the endpoint, since max 28 days. Will return amount of messages sent with success, failed or still in progress. - [Recover Failed Webhooks](https://documentation.safecube.ai/reference/v1endpointrecover.md): Resend all failed messages since a given time. - [Replay Missing Webhooks](https://documentation.safecube.ai/reference/v1endpointreplay.md): Replays messages to the endpoint. Only messages that were created after `since` will be sent. Messages that were previously sent to the endpoint are not resent. - [Get Endpoint Headers](https://documentation.safecube.ai/reference/v1endpointget-headers.md): Get the additional headers to be sent with the webhook - [Update Endpoint Headers](https://documentation.safecube.ai/reference/v1endpointupdate-headers.md): Set the additional headers to be sent with the webhook This can be used in case your infrastructure requires additional security. This will replace all previously sent headers. Use PATCH to update the headers partially. - [Patch Endpoint Headers](https://documentation.safecube.ai/reference/v1endpointpatch-headers.md): Partially set the additional headers to be sent with the webhook - [Send Event Type Example Message](https://documentation.safecube.ai/reference/v1endpointsend-example.md): Send an example message for a specific event. Note that this will only sent demo data (and not real tracking data) This can only be used to send event types that are configured for the endpoint. - [Add shipments asynchronously](https://documentation.safecube.ai/reference/easy-shipment-asynchronous.md): Add container or BL or BK to one or multiple endpoints with their container / BL / BK numbers. Your request will immediatelly be acknowledged. You can then monitor if you shipment has been correctly added with the events 'shipment.added.to.endpoint' and 'shipment.in.error - [Get the list of shipments for all your endpoints](https://documentation.safecube.ai/reference/v1easyshipmentget.md): Get all container / bl / bk that are currently monitored by each of your endpoints - [Update shipments to endpoints](https://documentation.safecube.ai/reference/v1easyshipmentupdate.md): You can update container or BL or BK to one or multiple endpoints with their container / BL / BK numbers. Note that all the container / bl / bk will be replaced by the one provided in your request. If you just wish to add shipments, use the POST endpoint. - [Delete shipments to endpoints](https://documentation.safecube.ai/reference/v1easyshipmentdelete.md): You can delete container or BL or BK to one or multiple endpoints by their container / BL / BK numbers. Note that the container / bl / bk provided will be deleted for endpoint provided - [Get dashboard url](https://documentation.safecube.ai/reference/v1applicationdashboard.md): Get your dashboard url. Open it with a web browser to monitor your webhook endpoints. - [Retrieve list of shipments called with the API](https://documentation.safecube.ai/reference/retrieveshipmentusages-webhooks.md): Retrieve the list of shipments called with the API within the provided timeframe, that usages have a minimum resolution of a month (you cant select the usage for one week for example, the usage will automatically be for the month of the week provided) - [Port Occupation](https://documentation.safecube.ai/reference/port-coverage.md) - [Search Port Details by its name or unlocode](https://documentation.safecube.ai/reference/searchportdetails.md): Retrieve detailed informations about a specific port by its UNLOCODE. It include the berth occupation rate and the difference with the average one. - [Get Port Details by unlocode](https://documentation.safecube.ai/reference/getportdetails.md): Retrieve detailed informations about a specific port by its UNLOCODE. It include the berth occupation rate and the difference with the average one. - [Get Vessels in port](https://documentation.safecube.ai/reference/getvesselsinport.md): Retrieve a list of vessels currently in the specified port - [Schedule API](https://documentation.safecube.ai/reference/schedule-api.md) - [Schedule API Coverage](https://documentation.safecube.ai/reference/schedule-api-coverage.md) - [Retrieve your monthly usages](https://documentation.safecube.ai/reference/retrieveusages-6.md):The endpoint allows you to retrieve your monthly usages of the API
- [Retrieve the current credit consumption period](https://documentation.safecube.ai/reference/retrievecurrentconsumptionperiod-1.md):Retrieve the current credit consumption period, including the remaining and initial credits and the period boundaries.
- [Retrieve all credit consumption periods](https://documentation.safecube.ai/reference/retrieveconsumptionperiods-1.md):Retrieve all credit consumption periods, including the remaining and initial credits and the period boundaries for each period.
- [Get vessels arrivals and departure at port](https://documentation.safecube.ai/reference/get_schedules-port-traffic.md):Get the vessels arriving at and departing from a specific port over a date range. Provide the port UN/LOCODE (required) and, optionally, the sealines and the date range.
- [Get schedules for a specific port](https://documentation.safecube.ai/reference/get_schedules-port.md):Get the maritime schedules calling at a specific port, identified by its UN/LOCODE. Optionally filter by sealines and departure date.
- [Get schedules by vessel IMO](https://documentation.safecube.ai/reference/get_schedules-vessel.md):Get the maritime schedules for a given vessel, identified by its IMO number. Optionally filter by port UN/LOCODE and sealines.
- [Get schedules between two ports](https://documentation.safecube.ai/reference/get_schedules-point-to-point.md):Get the maritime schedules between two ports (point-to-point). Provide the destination port UN/LOCODE (required) and, optionally, an origin port, the sealines and a departure date to refine the search.
- [Get Started with Safecube Shipment Management API](https://documentation.safecube.ai/reference/get-started-with-safecube-shipment-management-api.md): Get access, create shipments and retrieve their public sharing link. - [Embed Safecube within an Iframe](https://documentation.safecube.ai/reference/embed-safecube-with-an-iframe.md) - [Create shipments](https://documentation.safecube.ai/reference/post_public-shipments.md):Endpoint that allows to create shipments in Safecube web application. The shipment creation is asynchronous.
When Safecube will have processed your request entirely, you will receive a email with the shipment creation summary, including if the shipment has been created or not, and if not, why.
- [Delete multiple shipments](https://documentation.safecube.ai/reference/delete_public-shipments.md): Endpoint that allows to delete shipments from the Safecube web application. Deleted shipments will not be updated, trigger alerts or be charged. - [Get multiple shipments](https://documentation.safecube.ai/reference/post_public-shipments-search.md): Endpoint that searchs for shipments in the web application and returns the public shipment link. - [Retrieve co2 consumption for a trip from one port to another.](https://documentation.safecube.ai/reference/computeco2.md):This endpoint is used to compute the CO2 emissions of a TEU during its journey from a port to another port.
To identify the vessel, you can use the IMO (International Maritime Organization) or the MMSI (Maritime Mobile Service Identity), but not both in the same reaquest.
You can also set an optional custom average speed for the vessel during the journey, in knots. By default the average speed will be computed by our routing system.
The maximum allowed speed input is 25 knots
You can set up the departure port using its 5 digits UN Locode. Please make sure it is a Locode for a port.
You can set up the arrival port using its 5 digits UN Locode. Please make sure it is a Locode for a port.
The response will give you the voyage length in nautical miles and an estimation of the tons of CO2 emitted for this voyage, by TEU, with different methods.
In this method, we model the journey from port to port of this vessel using our data models. We also use our database of ships to model their physical characteristics (hull, engine, capacity, etc.) to estimate their fuel consumption. The CO2 emission is then derived from the ship estimated fuel consumption.
This method computes only Tank to Wheel co2 emission (for the moment).
In this method, we use the factors given by the GLEC Framework (2019 edit). From the departure and arrival, we deduce which tradelane have been used, and we find the corresponding emission factors. Then we apply these factors to the voyage length.
This method does not take into account specific vessel characteristics.
This method allows to estimate Well to Tank, Tank to Wheel and Well to Wheel (ie total) co2 emissions.
- [Retrieve your monthly usages](https://documentation.safecube.ai/reference/retrieveusages-4.md):The endpoint allows you to retrieve your monthly usages of the API
- [About the API](https://documentation.safecube.ai/reference/about-the-api.md) - [ETA computation](https://documentation.safecube.ai/reference/computeeta.md):This endpoint is used to compute the Estimated Time of Arrival of any vessel.
To compute the ETA of a vessel, we need information concerning the vessel, the departure (optional) and the arrival. These 3 elements are present in the request in 3 different fields.
It will allow you to compute the ETA of a vessel from the vessel position to a port or from a port to another port.
To identify the vessel, you can use the IMO (International Maritime Organization) or the MMSI (Maritime Mobile Service Identity).
You can optionally set the vessel speed to use for computation, in nautical miles per hour. The maximum speed is 25.0
By default, the ETA is computed with the latest known position of the vessel as departure (time and position). The API allows you to compute an ETA of a vessel from a port to another port. In that case, you must use the field departure to define the departure port code and the departure date time (ISO 8601 format).
Note that you can't define a departure date time in case of vessel position to port ETA computation.
Arrival field is used to define to where the eta must be computed. You need to indicate the port code of the arrival.
You will find the response of the ETA in the field named arrivalTime in format ISO 8601
You will also find the confidence of the result which is a value from 1 to 5, 5 means high confidence.
You will also find the remaining distance which is in nautical miles
The fields from the request will also be added in the response.
You can find below 2 examples of payloads for the 2 ways to compute the ETA.
- [Retrieve your monthly usages](https://documentation.safecube.ai/reference/retrieveusages-1.md):The endpoint allows you to retrieve your monthly usages of the API
- [Retrieve Noise emitted for a trip from one port to another.](https://documentation.safecube.ai/reference/computenoise.md):This endpoint is used to compute the SEL and noises emissions in multiple frequencies of a vessel during its journey from a port to another port and compare them to the recommended thresholds.
To identify the vessel, you can use the IMO (International Maritime Organization) or the MMSI (Maritime Mobile Service Identity).
You can set up the departure port using its 5 digits UN Locode. Please make sure it is a Locode for a port.
You can set up the arrival port using its 5 digits UN Locode. Please make sure it is a Locode for a port.
The response will give you an estimation of the SEL and booleans indicating if the noise emitted is above the recommended thresholds for this voyage.
To achieve this result, we model the journey from port to port of this vessel using our data models. We also use our database of ships to model their physical characteristics to estimate their emission of noise.
The duration response is in milliseconds (ms).
The sel response is in pascal squared second (Pa².s).
- [Retrieve your monthly usages](https://documentation.safecube.ai/reference/retrieveusages-3.md):The endpoint allows you to retrieve your monthly usages of the API
- [Congestion](https://documentation.safecube.ai/reference/congestion.md) - [Congestion API Coverage](https://documentation.safecube.ai/reference/congestion-api-coverage.md) - [Retrieve aggregated congestion data for multiple ports](https://documentation.safecube.ai/reference/retrievecongestionaggregatebatch.md):Returns congestion, time-in-port statistics, and vessel counts for a list of ports.
Maximum 10 ports per request.
- [Retrieve aggregated congestion data for a port](https://documentation.safecube.ai/reference/retrievecongestionaggregate.md):Returns congestion, time-in-port statistics, and vessel counts for a given port.
- [Retrieve the current credit consumption period](https://documentation.safecube.ai/reference/retrievecurrentconsumptionperiod.md) - [Retrieve all credit consumption periods](https://documentation.safecube.ai/reference/retrieveconsumptionperiods.md) ## Changelog - [Enhanced Alert Management with Priority Levels](https://documentation.safecube.ai/changelog/enhanced-alert-management-with-priority-levels.md) - [Automatic Shipment Archiving](https://documentation.safecube.ai/changelog/automatic-shipment-archiving.md) - [Kanban View & Vessel Schedules](https://documentation.safecube.ai/changelog/kanban-view-vessel-schedules.md) - [New Port & Vessel intelligence APIs](https://documentation.safecube.ai/changelog/new-port-vessel-intelligence-apis.md) - [New Analytics Dashboard](https://documentation.safecube.ai/changelog/new-analytics-dashboard.md) - [New module added: Vessel Tracking](https://documentation.safecube.ai/changelog/new-module-added-vessel-tracking.md) - [New Warning in API - Split BL](https://documentation.safecube.ai/changelog/new-warning-in-api-split-bl.md) - [Embed & Brand Safecube with New Premium Tools](https://documentation.safecube.ai/changelog/embed-brand-safecube-with-new-premium-tools.md) - [Customize Your Shipment List View](https://documentation.safecube.ai/changelog/customize-your-shipment-list-view.md) - [New API Field – Container Size & Type](https://documentation.safecube.ai/changelog/new-api-field-container-size-type.md)