---
updatedAt: 2026-05-04T21:43:38.000Z
agentTools:
  projectIndex: https://docs.toqua.ai/llms.txt
---

# Retrieve a detailed dataset of a ship's performance over time

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Toqua API",
    "contact": {
      "name": "Toqua",
      "url": "https://toqua.ai/",
      "email": "admin@toqua.ai"
    },
    "version": "0.26"
  },
  "servers": [
    {
      "url": "https://api.toqua.ai",
      "description": "Toqua API"
    }
  ],
  "paths": {
    "/performance/{imo_number}/data": {
      "get": {
        "tags": [
          "Performance"
        ],
        "summary": "Retrieve a detailed dataset of a ship's performance over time",
        "operationId": "get_ship_performance_dataset",
        "security": [
          {
            "APIKeyHeader": []
          },
          {
            "HTTPBearer": []
          }
        ],
        "parameters": [
          {
            "name": "imo_number",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Imo Number"
            }
          },
          {
            "name": "rolling_average",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false,
              "title": "Rolling Average"
            }
          },
          {
            "name": "data_source",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Override data source (nr | sensor)",
              "title": "Data Source"
            },
            "description": "Override data source (nr | sensor)"
          },
          {
            "name": "corrected_stw",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Override corrected STW",
              "title": "Corrected Stw"
            },
            "description": "Override corrected STW"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PerformanceDataset"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DataSource": {
        "type": "string",
        "enum": [
          "sensor",
          "nr"
        ],
        "title": "DataSource"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "PerformanceDataset": {
        "properties": {
          "properties": {
            "$ref": "#/components/schemas/PerformanceDatasetProperties",
            "title": "Properties",
            "description": "The properties of the performance dataset."
          },
          "data_points": {
            "$ref": "#/components/schemas/PerformanceDatasetDatapoints",
            "title": "Data Points",
            "description": "The data points of the performance dataset."
          }
        },
        "type": "object",
        "required": [
          "properties",
          "data_points"
        ],
        "title": "PerformanceDataset",
        "description": "Represents a potentially large dataset of the performance of the vessel over time."
      },
      "PerformanceDatasetDatapoints": {
        "properties": {
          "datetime": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Datetime",
            "description": "List of datetimes. Datetime must be in ISO8601 format, and must specify a timezone.",
            "examples": [
              "2022-08-02T09:21:24+00:00",
              "2022-08-02T09:26:24+00:00"
            ]
          },
          "excess_fuel_percentage": {
            "items": {
              "type": "number"
            },
            "type": "array",
            "title": "Excess Fuel Percentage",
            "description": "List of excess fuel percentage values.",
            "examples": [
              0.95,
              0.9
            ]
          }
        },
        "type": "object",
        "required": [
          "datetime",
          "excess_fuel_percentage"
        ],
        "title": "PerformanceDatasetDatapoints"
      },
      "PerformanceDatasetProperties": {
        "properties": {
          "updated_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Datetime of object creation",
            "description": "Datetime at which the object was created. Datetime must be in ISO8601 format, and must specify a timezone."
          },
          "imo": {
            "type": "string",
            "title": "IMO",
            "description": "The IMO number of the vessel."
          },
          "model_version": {
            "type": "string",
            "title": "Model Version",
            "description": "The version of the model used to generate the performance lifeline."
          },
          "corrected_stw": {
            "type": "boolean",
            "title": "Corrected STW",
            "description": "Whether the STW type that was used to predict the `me_fo_consumption` of the vessel is corrected_stw or sensor_stw."
          },
          "data_source": {
            "$ref": "#/components/schemas/DataSource",
            "title": "Data Source",
            "description": "The source of the performance data.",
            "examples": [
              "nr"
            ]
          },
          "averaging_window_in_days": {
            "type": "number",
            "title": "Averaging Window In Days",
            "description": "The averaging window in days. If `0` then no averaging is applied.",
            "examples": [
              1
            ]
          }
        },
        "type": "object",
        "required": [
          "imo",
          "model_version",
          "corrected_stw",
          "data_source",
          "averaging_window_in_days"
        ],
        "title": "PerformanceDatasetProperties"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      }
    },
    "securitySchemes": {
      "APIKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      },
      "HTTPBearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "externalDocs": {
    "description": "API Documentation",
    "url": "https://docs.toqua.ai"
  }
}
```