Get vessel positional data

Production

https://api.polestar-production.com

GET

/purpletrac/v1/position

Retrieves the vessel's positional data from when the vessel started tracking.

Refer to Tracking a Vessel to see how this endpoint is used in the vessel tracking workflow.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

Query Params

Responses

🟢200OK

application/json

Positions reported since tracking started, newest first.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.polestar-production.com/purpletrac/v1/position?username=undefined&limit=undefined&offset=undefined&id=undefined&api_key=%3Capi-key%3E'

Response Example

200 - Default

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 4
    },
    "objects": [
        {
            "creation_date": "2023-12-07 11:59:16.054895+00:00",
            "destination": "EG PSD",
            "destination_eta": "2023-12-07 17:00:00+00:00",
            "heading": 114,
            "info": [],
            "latitude": 32.137417,
            "longitude": 30.847609,
            "outlier": false,
            "position_type": "AIS",
            "resource_uri": "",
            "speed": 12.8,
            "status": null,
            "status_timestamp": "2023-12-07 11:57:21+00:00",
            "timestamp": "2023-12-07 11:57:21+00:00",
            "transaction": "/api/v1/transaction/2854829"
        },
        {
            "creation_date": "2023-12-07 11:59:14.441966+00:00",
            "destination": "EG PSD",
            "destination_eta": "2023-12-07 17:00:00+00:00",
            "heading": 115,
            "info": [],
            "latitude": 32.163326,
            "longitude": 30.783585,
            "outlier": false,
            "position_type": "AIS",
            "resource_uri": "",
            "speed": 12.8,
            "status": null,
            "status_timestamp": "2023-12-07 11:57:21+00:00",
            "timestamp": "2023-12-07 11:40:32+00:00",
            "transaction": "/api/v1/transaction/2854829"
        },
        {
            "creation_date": "2023-12-07 10:38:05.183160+00:00",
            "destination": "EG PSD",
            "destination_eta": "2023-12-07 17:00:00+00:00",
            "heading": 112,
            "info": [],
            "latitude": 32.26791,
            "longitude": 30.494967,
            "outlier": false,
            "position_type": "AIS",
            "resource_uri": "",
            "speed": 12.4,
            "status": null,
            "status_timestamp": "2023-12-07 10:23:53+00:00",
            "timestamp": "2023-12-07 10:23:53+00:00",
            "transaction": "/api/v1/transaction/2854829"
        },
        {
            "creation_date": "2023-12-06 16:04:00.311525+00:00",
            "destination": "EG PSD",
            "destination_eta": "2023-12-07 17:00:00+00:00",
            "heading": 106,
            "info": [],
            "latitude": 33.791149,
            "longitude": 25.810593,
            "outlier": false,
            "position_type": "AIS",
            "resource_uri": "",
            "speed": 12,
            "status": null,
            "status_timestamp": "2023-12-06 13:52:58+00:00",
            "timestamp": "2023-12-06 13:52:58+00:00",
            "transaction": "/api/v1/transaction/2854829"
        }
    ]
}

Modified at 2026-09-18 08:35:54

Update voyage and tracking details

Retrieve a list of vessel or bill of lading notifications