API Reference

Ingest sensor data

post
https://api.toqua.ai/ships//data/sensors
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
datetime_start
length ≤ 500000

List of datetimes on which the sensor averaging period starts. Datetime must be in ISO8601 format, and must specify a timezone.

datetime_end
array of date-times
required
length ≤ 500000

List of datetimes on which the sensor averaging period ends. Datetime must be in ISO8601 format, and must specify a timezone.

End datetime*
lat
length ≤ 500000

List of latitudes in decimal degrees format (DDD.DDDDD°). Positive values are north of the equator.

lng
length ≤ 500000

List of longitudes in decimal degrees format (DDD.DDDDD°). Positive values are east of the prime meridian.

sog
length ≤ 500000

List of Speed Over Ground values in knots (kn).

stw
length ≤ 500000

List of Speed Through Water values in knots (kn).

me_power
length ≤ 500000

List of main engine shaft power values in kilowatt (kW).

me_rpm
length ≤ 500000

List of main engine shaft RPM values in Rotations Per Minute (RPM).

me_fo_consumption
length ≤ 500000

List of main engine fuel oil consumption values in metric tons/day (mt/day).

me_fuel_type
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

me_lcv
length ≤ 500000

List of main engine lower calorific values in megajoule/kilogram (MJ/kg).

me_gas_consumption
length ≤ 500000

List of main engine gas consumption values in metric tons/day (mt/day).

me_gas_type
length ≤ 500000

The type of gas fuel used. If both gas fuel type and LCV are provided, LCV takes precedence. Each gas fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.

me_gas_lcv
length ≤ 500000

List of main engine gas lower calorific values in megajoule/kilogram (MJ/kg).

shaft_generator_power
length ≤ 500000

List of shaft generator power values in kilowatt (kW).

boiler_fo_consumption_1
length ≤ 500000

List of boiler 1 fuel oil consumption values in metric tons/day (mt/day).

boiler_fo_consumption_2
length ≤ 500000

List of boiler 2 fuel oil consumption values in metric tons/day (mt/day).

boiler_fo_consumption_3
length ≤ 500000

List of boiler 3 fuel oil consumption values in metric tons/day (mt/day).

boiler_power_1
length ≤ 500000

List of boiler 1 power values in kilowatt (kW).

boiler_power_2
length ≤ 500000

List of boiler 2 power values in kilowatt (kW).

boiler_power_3
length ≤ 500000

List of boiler 3 power values in kilowatt (kW).

boiler_lcv_1
length ≤ 500000

List of boiler 1 lower calorific values in megajoule/kilogram (MJ/kg).

boiler_lcv_2
length ≤ 500000

List of boiler 2 lower calorific values in megajoule/kilogram (MJ/kg).

boiler_lcv_3
length ≤ 500000

List of boiler 3 lower calorific values in megajoule/kilogram (MJ/kg).

boiler_fuel_type_1
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

boiler_fuel_type_2
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

boiler_fuel_type_3
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

boiler_fo_consumption
length ≤ 500000
deprecated

DEPRECATED: Use boiler_fo_consumption_1 instead. List of boiler fuel oil consumption values in metric tons/day (mt/day) for the first boiler.

boiler_power
length ≤ 500000
deprecated

DEPRECATED: Use boiler_power_1 instead. List of boiler power values in kilowatt (kW) for the first boiler.

boiler_lcv
length ≤ 500000
deprecated

DEPRECATED: Use boiler_lcv_1 instead. List of boiler lower calorific values in megajoule/kilogram (MJ/kg) for the first boiler.

boiler_fuel_type
length ≤ 500000
deprecated

DEPRECATED: Use boiler_fuel_type_1 instead. The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

ae_fo_consumption_1
length ≤ 500000

List of auxiliary engine 1 fuel oil consumption values in metric tons/day (mt/day).

ae_fo_consumption_2
length ≤ 500000

List of auxiliary engine 2 fuel oil consumption values in metric tons/day (mt/day).

ae_fo_consumption_3
length ≤ 500000

List of auxiliary engine 3 fuel oil consumption values in metric tons/day (mt/day).

ae_fo_consumption_4
length ≤ 500000

List of auxiliary engine 4 fuel oil consumption values in metric tons/day (mt/day).

ae_fo_consumption_5
length ≤ 500000

List of auxiliary engine 5 fuel oil consumption values in metric tons/day (mt/day).

ae_fo_consumption_6
length ≤ 500000

List of auxiliary engine 6 fuel oil consumption values in metric tons/day (mt/day).

ae_power_1
length ≤ 500000

List of auxiliary engine 1 power values in kilowatt (kW).

ae_power_2
length ≤ 500000

List of auxiliary engine 2 power values in kilowatt (kW).

ae_power_3
length ≤ 500000

List of auxiliary engine 3 power values in kilowatt (kW).

ae_power_4
length ≤ 500000

List of auxiliary engine 4 power values in kilowatt (kW).

ae_power_5
length ≤ 500000

List of auxiliary engine 5 power values in kilowatt (kW).

ae_power_6
length ≤ 500000

List of auxiliary engine 6 power values in kilowatt (kW).

ae_lcv_1
length ≤ 500000

List of auxiliary engine 1 lower calorific values in megajoule/kilogram (MJ/kg).

ae_lcv_2
length ≤ 500000

List of auxiliary engine 2 lower calorific values in megajoule/kilogram (MJ/kg).

ae_lcv_3
length ≤ 500000

List of auxiliary engine 3 lower calorific values in megajoule/kilogram (MJ/kg).

ae_lcv_4
length ≤ 500000

List of auxiliary engine 4 lower calorific values in megajoule/kilogram (MJ/kg).

ae_lcv_5
length ≤ 500000

List of auxiliary engine 5 lower calorific values in megajoule/kilogram (MJ/kg).

ae_lcv_6
length ≤ 500000

List of auxiliary engine 6 lower calorific values in megajoule/kilogram (MJ/kg).

ae_fuel_type_1
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

ae_fuel_type_2
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

ae_fuel_type_3
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

ae_fuel_type_4
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

ae_fuel_type_5
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

ae_fuel_type_6
length ≤ 500000

The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

ae_fo_consumption
length ≤ 500000
deprecated

DEPRECATED: Use ae_fo_consumption_1 instead. List of auxiliary engine fuel oil consumption values in metric tons/day (mt/day) for the first auxiliary engine.

ae_power
length ≤ 500000
deprecated

DEPRECATED: Use ae_power_1 instead. List of auxiliary engine power values in kilowatt (kW) for the first auxiliary engine.

ae_lcv
length ≤ 500000
deprecated

DEPRECATED: Use ae_lcv_1 instead. List of auxiliary engine lower calorific values in megajoule/kilogram (MJ/kg) for the first auxiliary engine.

ae_fuel_type
length ≤ 500000
deprecated

DEPRECATED: Use ae_fuel_type_1 instead. The type of fuel used. If both fuel type and LCV are provided, LCV takes precedence. Each fuel type will be mapped to a standard LCV value as described in MEPC.281(70). Available values are:
"MGO": ISO 8217 Grades DMX through DMB, LCV: 42.7 MJ/kg.
"LFO": ISO 8217 Grades RMA through RMD, LCV: 41.2 MJ/kg.
"HFO": ISO 8217 Grades RME through RMK, LCV: 40.2 MJ/kg.
"LPG_propane": Liquefied Petroleum Gas (Propane), LCV: 46.3 MJ/kg.
"LPG_butane": Liquefied Petroleum Gas (Butane), LCV: 45.7 MJ/kg
"LNG": Liquefied Natural Gas, LCV: 48.0 MJ/kg.
"methanol": Methanol, LCV: 19.9 MJ/kg.
"ethanol": Ethanol, LCV: 26.8 MJ/kg.

ship_heading
length ≤ 500000

Ship heading direction values in degrees true (°T): north is at 0° and increases clockwise.

fuel_specific_energy
length ≤ 500000
deprecated

List of Fuel Specific Energy values in megajoule/kilogram (MJ/kg). This field is deprecated, please use me_lcv instead.

draft_avg
length ≤ 500000

List of average draft values in meter (m).

trim
length ≤ 500000

List of trim values in meter (m). Calculated as draft fore - draft aft.

sea_depth
length ≤ 500000

Sea Depth in meters (m).

rudder_angle
length ≤ 500000

Rudder angle in degrees (°).

air_lubrication_system_power
length ≤ 500000

List of air lubrication system power values in kilowatt (kW), summed over all compressors.

propeller_pitch_angle
length ≤ 500000

Propeller pitch angle in degrees (°). A pitch angle of 0° indicates the neutral position. Positive values correspond to forward thrust (blades angled to push water aft), negative values to reverse thrust (blades angled to push water forward).

operating_mode

Operating mode of the vessel during the sensor data recording. Examples are 'fuel optimization on', 'air lubrication on', 'main engine running'.

cyl_oil_rob
length ≤ 500000

List of cylinder lube oil remaining on board values in metric tons (mt).

cyl_oil_consumption
length ≤ 500000

List of cylinder lube oil consumption values in grams per kilowatt hour (g/kWh).

sys_oil_rob
length ≤ 500000

List of system oil remaining on board values in metric tons (mt).

sys_oil_consumption
length ≤ 500000

List of system oil consumption values in metric tons per day (mt/day).

Responses

501

Not Implemented

Updated 10 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago