{ "openapi": "3.0.1", "info": { "title": "PublicAPIs (legacy)", "version": "1.0", "description": "The PublicAPIs at `https://apis.maritrace.com`: every call is a `POST` with a JSON body and HTTP Basic sign-in. Each API is granted separately.\n\nThis is the original OpenAPI description ([swagger.json](https://apis.maritrace.com/swagger/v1/swagger.json)), with the server and sign-in added.\n\nCalls from this page are **real**: they sign in as you, come from your own IP address, and count towards your rate limits (and, where it applies, usage billing) exactly as calls from your systems do." }, "paths": { "/get_AllAreasForPosition": { "post": { "tags": [ "get_AllAreasForPosition" ], "operationId": "get_AllAreasForPosition", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllAreasForPositionParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AllAreasForPositionParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AllAreasForPositionParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllAreasAtPosition" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllAreasAtPosition" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllAreasAtPosition" } } } } } } } }, "/get_AllPorts": { "post": { "tags": [ "get_AllPorts" ], "operationId": "get_AllPorts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_AllPorts_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_AllPorts_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_AllPorts_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicPortPaginatedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicPortPaginatedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicPortPaginatedResponse" } } } } } } }, "/get_AllVesselsWithinEEZ": { "post": { "tags": [ "get_AllVesselsWithinEEZ" ], "operationId": "get_AllVesselsWithinEEZ", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_VesselsWithinEEZ_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_VesselsWithinEEZ_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_VesselsWithinEEZ_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionReport" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionReport" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionReport" } } } } } } } }, "/get_Areas": { "post": { "tags": [ "get_Areas" ], "operationId": "get_Areas", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_Areas_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_Areas_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_Areas_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AreaData" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AreaData" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AreaData" } } } } } } } }, "/get_Breaches": { "post": { "tags": [ "get_Breaches" ], "operationId": "get_Breaches", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_breaches_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_breaches_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_breaches_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Breaches" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Breaches" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Breaches" } } } } } } } }, "/get_CheckCurrentJWC": { "post": { "tags": [ "get_CheckCurrentJWC" ], "operationId": "get_CheckCurrentJWC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VesselPositionsAndCheckJWCRequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VesselPositionsAndCheckJWCRequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VesselPositionsAndCheckJWCRequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/jwcPositionRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/jwcPositionRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/jwcPositionRequestResponse" } } } } } } }, "/get_CheckCurrentJWCProvided": { "post": { "tags": [ "get_CheckCurrentJWCProvided" ], "operationId": "get_CheckCurrentJWCProvided", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JWCPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JWCPosition" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JWCPosition" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/jwcPositionRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/jwcPositionRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/jwcPositionRequestResponse" } } } } } } }, "/get_CheckJWCProvided": { "post": { "tags": [ "get_CheckJWCProvided" ], "operationId": "get_CheckJWCProvided", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JWCProvidedPositions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JWCProvidedPositions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JWCProvidedPositions" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/multiple_imo_jwcPosition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/multiple_imo_jwcPosition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/multiple_imo_jwcPosition" } } } } } } }, "/get_Country": { "post": { "tags": [ "get_Country" ], "operationId": "get_Country", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountriesPostParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CountriesPostParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CountriesPostParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } } }, "/get_MercuryPositions": { "post": { "tags": [ "get_MercuryPositions" ], "operationId": "get_MercuryPositions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_MercuryPositions_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_MercuryPositions_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_MercuryPositions_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MercuryPosition" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MercuryPosition" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MercuryPosition" } } } } } } } }, "/get_NearestPorts": { "post": { "tags": [ "get_NearestPorts" ], "operationId": "get_NearestPorts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_NearestPorts_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_NearestPorts_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_NearestPorts_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPortDistance" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPortDistance" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPortDistance" } } } } } } } }, "/get_Port": { "post": { "tags": [ "get_Port" ], "operationId": "get_Portbycountrycode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortsPostParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PortsPostParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PortsPostParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Port" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Port" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Port" } } } } } } } }, "/get_PortCalls": { "post": { "tags": [ "get_PortCalls" ], "operationId": "get_PortCalls", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_PortCalls_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_PortCalls_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_PortCalls_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortCall_Vessel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortCall_Vessel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortCall_Vessel" } } } } } } } }, "/get_Ports": { "post": { "tags": [ "get_Ports" ], "operationId": "get_Ports", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_Ports_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_Ports_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_Ports_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } } } } } } }, "/get_PortsByCountry": { "post": { "tags": [ "get_PortsByCountry" ], "operationId": "get_PortsByCountry", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_PortsByCountry_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_PortsByCountry_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_PortsByCountry_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } } } } } } }, "/get_PortsByLocodeOrName": { "post": { "tags": [ "get_PortsByLocodeOrName" ], "operationId": "get_PortsByLocodeOrName", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_PortsByLocodeOrName_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_PortsByLocodeOrName_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_PortsByLocodeOrName_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" } } } } } } } }, "/get_PositionCheckJWC": { "post": { "tags": [ "get_PositionCheckJWC" ], "operationId": "get_PositionCheckJWC", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VesselPositionsAndCheckJWCRequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VesselPositionsAndCheckJWCRequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VesselPositionsAndCheckJWCRequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/multiple_imo_jwcPosition" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/multiple_imo_jwcPosition" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/multiple_imo_jwcPosition" } } } } } } } }, "/get_Transits": { "post": { "tags": [ "get_Transits" ], "operationId": "get_Transits", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_TransitsRequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_TransitsRequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_TransitsRequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VesselTransit" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VesselTransit" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VesselTransit" } } } } } } } }, "/get_VesselLatestPositions": { "post": { "tags": [ "get_VesselLatestPositions" ], "operationId": "get_VesselLatestPositions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionReport" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionReport" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionReport" } } } } } } } }, "/get_VesselPositionArea": { "post": { "tags": [ "get_VesselPositionArea" ], "operationId": "get_VesselPositionArea", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VesselPositionArea" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VesselPositionArea" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VesselPositionArea" } } } } } } } }, "/get_Vessels": { "post": { "tags": [ "get_Vessels" ], "operationId": "get_Vessels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/get_Vessel_RequestParameters" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vessel_Info" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vessel_Info" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vessel_Info" } } } } } } } }, "/get_VesselsInArea": { "post": { "tags": [ "get_VesselsInArea" ], "operationId": "get_VesselsInArea", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vesselsInArea" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vesselsInArea" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vesselsInArea" } } } } } } } } }, "components": { "schemas": { "AllAreasAtPosition": { "type": "object", "properties": { "position": { "$ref": "#/components/schemas/CoordDec" }, "areas": { "type": "array", "items": { "$ref": "#/components/schemas/Area_info" }, "nullable": true } }, "additionalProperties": false }, "AllAreasForPositionParameters": { "type": "object", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/CoordDec" }, "nullable": true } }, "additionalProperties": false }, "AreaData": { "type": "object", "properties": { "port": { "$ref": "#/components/schemas/Port_Data" }, "ocean_sea": { "$ref": "#/components/schemas/OceanSea" } }, "additionalProperties": false }, "Area_info": { "type": "object", "properties": { "area_type": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Breaches": { "type": "object", "properties": { "breach_uuid": { "type": "string", "format": "uuid" }, "vessel_uuid": { "type": "string", "format": "uuid" }, "breach_start": { "type": "string", "format": "date-time" }, "breach_end": { "type": "string", "format": "date-time" }, "breach_area_uuid": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CoordDdm": { "type": "object", "properties": { "latDeg": { "type": "integer", "format": "int32" }, "latMin": { "type": "number", "format": "double" }, "latDir": { "$ref": "#/components/schemas/LatitudeDirection" }, "latString": { "type": "string", "nullable": true }, "lonDeg": { "type": "integer", "format": "int32" }, "lonMin": { "type": "number", "format": "double" }, "lonDir": { "$ref": "#/components/schemas/LongitudeDirection" }, "lonString": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CoordDec": { "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lon": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CoordDms": { "type": "object", "properties": { "latDeg": { "type": "integer", "format": "int32" }, "latMin": { "type": "integer", "format": "int32" }, "latSec": { "type": "integer", "format": "int32" }, "latDir": { "$ref": "#/components/schemas/LatitudeDirection" }, "latString": { "type": "string", "nullable": true }, "lonDeg": { "type": "integer", "format": "int32" }, "lonMin": { "type": "integer", "format": "int32" }, "lonSec": { "type": "integer", "format": "int32" }, "lonDir": { "$ref": "#/components/schemas/LongitudeDirection" }, "lonString": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CountriesPostParameters": { "type": "object", "properties": { "alpha2code": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Country": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "alpha_2_code": { "type": "string", "nullable": true }, "alpha_3_code": { "type": "string", "nullable": true }, "numeric_code": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "continent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Distance": { "type": "object", "properties": { "kilometers": { "type": "number", "format": "double", "readOnly": true }, "metres": { "type": "number", "format": "double" }, "nauticalMiles": { "type": "number", "format": "double", "readOnly": true }, "statuteMiles": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "JWCPosition": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "date_received": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "JWCProvidedPositions": { "type": "object", "properties": { "positions": { "type": "array", "items": { "$ref": "#/components/schemas/JWCPosition" }, "nullable": true }, "vessel_imo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LatitudeDirection": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Location": { "type": "object", "properties": { "dec": { "$ref": "#/components/schemas/CoordDec" }, "ddm": { "$ref": "#/components/schemas/CoordDdm" }, "dms": { "$ref": "#/components/schemas/CoordDms" } }, "additionalProperties": false }, "LongitudeDirection": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "MercuryPosition": { "type": "object", "properties": { "box_id": { "type": "string", "nullable": true }, "time": { "type": "string", "format": "date-time" }, "lat": { "type": "number", "format": "double" }, "lon": { "type": "number", "format": "double" }, "quality": { "type": "integer", "format": "int32" }, "altitude": { "type": "number", "format": "double" }, "dir": { "type": "number", "format": "double" }, "velocity": { "type": "number", "format": "double" } }, "additionalProperties": false }, "OceanSea": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "ocean_name": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "eez": { "$ref": "#/components/schemas/Country" } }, "additionalProperties": false }, "PaginationInfo": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "page_size": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "total_pages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Port": { "type": "object", "properties": { "guid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "locode": { "type": "string", "nullable": true }, "wpi_number": { "type": "string", "nullable": true }, "country": { "$ref": "#/components/schemas/Country" }, "risk_rating": { "type": "string", "nullable": true }, "risk_assessment_link": { "type": "string", "nullable": true }, "risk_notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PortArea": { "type": "object", "properties": { "guid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "terminal": { "type": "string", "nullable": true }, "port": { "$ref": "#/components/schemas/Port" } }, "additionalProperties": false }, "PortCall_Vessel": { "type": "object", "properties": { "port": { "$ref": "#/components/schemas/Port" }, "timing": { "$ref": "#/components/schemas/Timing" }, "vessel": { "$ref": "#/components/schemas/Vessel" } }, "additionalProperties": false }, "PortGeometry": { "type": "object", "properties": { "geog_uuid": { "type": "string", "format": "uuid" }, "geometry_geojson": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PortSearchType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "PortSpatialData": { "type": "object", "properties": { "port_uuid": { "type": "string", "format": "uuid" }, "port_entry_geojson": { "type": "string", "nullable": true }, "berthing_areas": { "type": "array", "items": { "$ref": "#/components/schemas/PortGeometry" }, "nullable": true }, "berths": { "type": "array", "items": { "$ref": "#/components/schemas/PortGeometry" }, "nullable": true } }, "additionalProperties": false }, "Port_Data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "locode": { "type": "string", "nullable": true }, "wpi_number": { "type": "string", "nullable": true }, "country": { "$ref": "#/components/schemas/Country" } }, "additionalProperties": false }, "PortsPostParameters": { "required": [ "countryAlpha2Code" ], "type": "object", "properties": { "countryAlpha2Code": { "maxItems": 2, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PositionReport": { "type": "object", "properties": { "vessel_uuid": { "type": "string", "format": "uuid" }, "vessel_id": { "type": "string", "nullable": true }, "vessel_name": { "type": "string", "nullable": true }, "destination": { "type": "string", "nullable": true }, "mmsi": { "type": "string", "nullable": true }, "imo_number": { "type": "string", "nullable": true }, "callsign": { "type": "string", "nullable": true }, "ship_type": { "type": "integer", "format": "int32" }, "navigation_status": { "type": "integer", "format": "int32" }, "dimension_to_bow": { "type": "integer", "format": "int32" }, "dimension_to_port": { "type": "integer", "format": "int32" }, "dimension_to_starboard": { "type": "integer", "format": "int32" }, "dimension_to_stern": { "type": "integer", "format": "int32" }, "draught": { "type": "number", "format": "double" }, "eta_month": { "type": "integer", "format": "int32" }, "eta_day": { "type": "integer", "format": "int32" }, "eta_hour": { "type": "integer", "format": "int32" }, "eta_minute": { "type": "integer", "format": "int32" }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "geojson": { "type": "string", "nullable": true }, "date_received": { "type": "string", "format": "date-time" }, "speed_over_ground": { "type": "number", "format": "double" }, "course_over_ground": { "type": "number", "format": "double" }, "true_heading": { "type": "number", "format": "double" }, "rate_of_turn": { "type": "number", "format": "double" }, "source": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PublicPort": { "type": "object", "properties": { "guid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "locode": { "type": "string", "nullable": true }, "wpi_number": { "type": "string", "nullable": true }, "country": { "$ref": "#/components/schemas/Country" }, "spatial": { "$ref": "#/components/schemas/PortSpatialData" } }, "additionalProperties": false }, "PublicPortDistance": { "type": "object", "properties": { "distance_order": { "type": "integer", "format": "int32" }, "port": { "$ref": "#/components/schemas/PublicPort" }, "location": { "$ref": "#/components/schemas/Location" }, "distance": { "$ref": "#/components/schemas/Distance" } }, "additionalProperties": false }, "PublicPortPaginatedResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPort" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "additionalProperties": false }, "Timing": { "type": "object", "properties": { "startDateTime": { "type": "string", "format": "date-time", "nullable": true }, "endDateTime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Vessel": { "type": "object", "properties": { "vessel_identifier": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "imo": { "type": "string", "nullable": true }, "mmsi": { "type": "string", "nullable": true }, "callsign": { "type": "string", "nullable": true }, "flag": { "$ref": "#/components/schemas/Country" }, "ais_type": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "sub_type": { "type": "string", "nullable": true }, "dwt": { "type": "integer", "format": "int32", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "breadth": { "type": "number", "format": "double", "nullable": true }, "commercial_owner": { "type": "string", "nullable": true }, "effective_controller": { "type": "string", "nullable": true }, "technical_manager": { "type": "string", "nullable": true }, "financial_owner": { "type": "string", "nullable": true }, "gt": { "type": "integer", "format": "int32", "nullable": true }, "year_of_build": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "VesselPositionArea": { "type": "object", "properties": { "imo": { "type": "string", "nullable": true }, "position": { "$ref": "#/components/schemas/PositionReport" }, "areas": { "type": "array", "items": { "$ref": "#/components/schemas/AllAreasAtPosition" }, "nullable": true } }, "additionalProperties": false }, "VesselPositionsAndCheckJWCRequestParameters": { "type": "object", "properties": { "vessel_uuids": { "type": "array", "items": { "type": "string" }, "nullable": true }, "vessel_imos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "vessel_mmsis": { "type": "array", "items": { "type": "string" }, "nullable": true }, "minimum_latitude": { "type": "number", "format": "double" }, "maximum_latitude": { "type": "number", "format": "double" }, "minimum_longitude": { "type": "number", "format": "double" }, "maximum_longitude": { "type": "number", "format": "double" }, "granularity": { "type": "string", "nullable": true }, "date_from": { "type": "string", "format": "date-time" }, "date_to": { "type": "string", "format": "date-time" }, "include_local_ais": { "type": "boolean" }, "include_remote_ais": { "type": "boolean" }, "include_satc": { "type": "boolean" }, "include_emerald": { "type": "boolean" }, "include_mercury": { "type": "boolean" }, "include_mercury_mobile": { "type": "boolean" }, "mercury_box_id": { "type": "string", "nullable": true }, "latest_position_only": { "type": "boolean" }, "user_account_uuid": { "type": "string", "format": "uuid" }, "caller_name": { "type": "string", "nullable": true }, "basic": { "type": "boolean" } }, "additionalProperties": false }, "VesselTransit": { "type": "object", "properties": { "commercial_owner_name": { "type": "string", "nullable": true }, "commercial_owner_url": { "type": "string", "nullable": true }, "commodity_name": { "type": "string", "nullable": true }, "effective_controller_name": { "type": "string", "nullable": true }, "effective_owner_url": { "type": "string", "nullable": true }, "start_area": { "$ref": "#/components/schemas/PortArea" }, "start_port_hours": { "type": "integer", "format": "int32" }, "start_draught_arrival": { "type": "number", "format": "double" }, "start_draught_departure": { "type": "number", "format": "double" }, "start_reported_destination_arrival": { "type": "string", "nullable": true }, "start_reported_destination_departure": { "type": "string", "nullable": true }, "start_port_arrival_date": { "type": "string", "format": "date-time" }, "start_port_departure_date": { "type": "string", "format": "date-time" }, "end_area": { "$ref": "#/components/schemas/PortArea" }, "end_port_hours": { "type": "integer", "format": "int32" }, "end_draught_arrival": { "type": "number", "format": "double" }, "end_draught_departure": { "type": "number", "format": "double" }, "end_reported_destination_arrival": { "type": "string", "nullable": true }, "end_reported_destination_departure": { "type": "string", "nullable": true }, "end_port_arrival_date": { "type": "string", "format": "date-time" }, "end_port_departure_date": { "type": "string", "format": "date-time" }, "sailing_time_mins": { "type": "integer", "format": "int64" }, "status": { "type": "string", "nullable": true }, "tonnage": { "type": "integer", "format": "int64" }, "vessel_age_years": { "type": "integer", "format": "int64" }, "vessel_dwt": { "type": "integer", "format": "int32" }, "vessel_imo": { "type": "string", "nullable": true }, "vessel_liquid_cc": { "type": "integer", "format": "int32" }, "vessel_clean_dirty": { "type": "string", "nullable": true }, "vessel_gt": { "type": "integer", "format": "int32" }, "vessel_nt": { "type": "integer", "format": "int32" }, "vessel_mmsi": { "type": "integer", "format": "int64" }, "vessel_name": { "type": "string", "nullable": true }, "vessel_teus": { "type": "string", "nullable": true }, "vessel_type": { "type": "string", "nullable": true }, "iv": { "type": "string", "nullable": true }, "transit_id": { "type": "string", "format": "uuid" }, "commodity_category": { "type": "string", "nullable": true }, "end_port_area_arrival_date": { "type": "string", "format": "date-time" }, "end_port_area_departure_date": { "type": "string", "format": "date-time" }, "start_port_area_arrival_date": { "type": "string", "format": "date-time" }, "start_port_area_departure_date": { "type": "string", "format": "date-time" }, "vessel_ldt": { "type": "integer", "format": "int32" }, "vessel_lb": { "type": "integer", "format": "int32" }, "vessel_lb_ais": { "type": "integer", "format": "int32" }, "override_rule_id": { "type": "string", "nullable": true }, "transit_serial": { "type": "integer", "format": "int64" }, "tonnage_org": { "type": "integer", "format": "int64" }, "tonnage_type": { "type": "string", "nullable": true }, "sailing_distance": { "type": "integer", "format": "int64" }, "start_draught_departure_upd": { "type": "number", "format": "double" }, "start_portcall_uuid": { "type": "string", "format": "uuid" }, "end_portcall_uuid": { "type": "string", "format": "uuid" }, "vessel_type_ais": { "type": "integer", "format": "int32" }, "vessel_tonnes_loaded": { "type": "integer", "format": "int32" }, "commodity_cat_a": { "type": "string", "nullable": true }, "commodity_cat_b": { "type": "string", "nullable": true }, "vessel_sub_type": { "type": "string", "nullable": true }, "start_port_terminal_name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Vessel_Info": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "mmsi": { "type": "string", "nullable": true }, "imo": { "type": "string", "nullable": true }, "callsign": { "type": "string", "nullable": true }, "dwt": { "type": "number", "format": "double", "nullable": true }, "flag": { "$ref": "#/components/schemas/Country" }, "ais_type": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "breadth": { "type": "number", "format": "double", "nullable": true }, "commercial_owner": { "type": "string", "nullable": true }, "effective_controller": { "type": "string", "nullable": true }, "technical_manager": { "type": "string", "nullable": true }, "financial_owner": { "type": "string", "nullable": true }, "year_of_build": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "get_AllPorts_RequestParameters": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "page_size": { "type": "integer", "format": "int32" }, "include_spatial": { "type": "boolean" } }, "additionalProperties": false }, "get_Areas_RequestParameters": { "type": "object", "properties": { "location": { "$ref": "#/components/schemas/CoordDec" } }, "additionalProperties": false }, "get_MercuryPositions_RequestParameters": { "type": "object", "properties": { "box_id": { "type": "string", "nullable": true }, "date_from": { "type": "string", "format": "date-time" }, "date_to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "nullable": true } }, "additionalProperties": false }, "get_NearestPorts_RequestParameters": { "type": "object", "properties": { "location": { "$ref": "#/components/schemas/Location" }, "result_count": { "type": "integer", "format": "int32" }, "port_search_type": { "$ref": "#/components/schemas/PortSearchType" }, "country_code": { "type": "string", "nullable": true }, "include_spatial": { "type": "boolean" } }, "additionalProperties": false }, "get_PortCalls_RequestParameters": { "type": "object", "properties": { "vessel_imos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "vessel_mmsis": { "type": "array", "items": { "type": "string" }, "nullable": true }, "port_identifiers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "date_from": { "type": "string", "format": "date-time" }, "date_to": { "type": "string", "format": "date-time" }, "return_limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "get_PortsByCountry_RequestParameters": { "type": "object", "properties": { "country_codes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "include_spatial": { "type": "boolean" } }, "additionalProperties": false }, "get_PortsByLocodeOrName_RequestParameters": { "type": "object", "properties": { "locode": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name_partial": { "type": "array", "items": { "type": "string" }, "nullable": true }, "include_spatial": { "type": "boolean" } }, "additionalProperties": false }, "get_Ports_RequestParameters": { "type": "object", "properties": { "port_uuids": { "type": "array", "items": { "type": "string" }, "nullable": true }, "include_spatial": { "type": "boolean" } }, "additionalProperties": false }, "get_TransitsRequestParameters": { "type": "object", "properties": { "imo_numbers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "from_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "get_Vessel_RequestParameters": { "type": "object", "properties": { "vessel_imos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "vessel_mmsis": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "get_VesselsWithinEEZ_RequestParameters": { "type": "object", "properties": { "country_code": { "type": "array", "items": { "type": "string" }, "nullable": true }, "data_source": { "type": "string", "nullable": true } }, "additionalProperties": false }, "get_breaches_RequestParameters": { "type": "object", "properties": { "breach_table_name": { "type": "string", "nullable": true }, "breach_table_uuid_column_name": { "type": "string", "nullable": true }, "breach_uuid": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "vessel_uuid": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "area_uuid": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "jwcPositionRequestResponse": { "type": "object", "properties": { "in_jwc_zone": { "type": "boolean" }, "jwc_uuid": { "type": "string", "format": "uuid", "nullable": true }, "jwc_name": { "type": "string", "nullable": true }, "position": { "$ref": "#/components/schemas/jwcRequestParameters" } }, "additionalProperties": false }, "jwcRequestParameters": { "type": "object", "properties": { "incident_coordinates": { "$ref": "#/components/schemas/CoordDec" }, "position_date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "multiple_imo_jwcPosition": { "type": "object", "properties": { "jwc_pos_list": { "type": "array", "items": { "$ref": "#/components/schemas/jwcPositionRequestResponse" }, "nullable": true }, "imo_number": { "type": "string", "nullable": true } }, "additionalProperties": false }, "vesselsInArea": { "type": "object", "properties": { "imo_number": { "type": "string", "nullable": true }, "mmsi": { "type": "string", "nullable": true }, "date_received": { "type": "string", "nullable": true }, "lat": { "type": "string", "nullable": true }, "lon": { "type": "string", "nullable": true }, "speed_over_ground": { "type": "string", "nullable": true }, "course_over_ground": { "type": "string", "nullable": true }, "true_heading": { "type": "string", "nullable": true }, "navigation_status": { "type": "string", "nullable": true }, "destination": { "type": "string", "nullable": true }, "eta": { "type": "string", "nullable": true }, "draught": { "type": "string", "nullable": true }, "vessel_name": { "type": "string", "nullable": true }, "callsign": { "type": "string", "nullable": true }, "flag": { "type": "string", "nullable": true }, "ship_type": { "type": "string", "nullable": true }, "ship_type_description": { "type": "string", "nullable": true }, "commercial_owner": { "type": "string", "nullable": true }, "effective_controller": { "type": "string", "nullable": true }, "technical_manager": { "type": "string", "nullable": true }, "financial_owner": { "type": "string", "nullable": true }, "position_accuracy": { "type": "string", "nullable": true }, "length": { "type": "string", "nullable": true }, "beam": { "type": "string", "nullable": true }, "deadweight_tonnage": { "type": "string", "nullable": true }, "ship_category": { "type": "string", "nullable": true }, "ship_subcategory": { "type": "string", "nullable": true }, "year_built": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "basic": { "type": "http", "scheme": "basic" } } }, "servers": [ { "url": "https://apis.maritrace.com" } ], "security": [ { "basic": [] } ] }