Why archive a vessel after screening?#
Archiving a screened vessel is optional. It separates current work from finished work, which makes filtering on transaction status simpler once you have volume. Archive with PUT /transaction/{id}.Archiving applies to screened vessels. A vessel under tracking stays active until tracking stops.Why does screening sometimes take longer?#
The first time a vessel is screened, its entire ship movement history has to be processed. That is the slow part, and it only happens once per vessel. Later screenings of the same vessel, and rescreenings, complete faster.Poll GET /transaction for the status rather than assuming a fixed wait.Why are there two ship movement history endpoints?#
Movement history comes from more than one data source. Keeping an endpoint per source means you can choose which one you want, rather than being handed a blend you cannot unpick.Can I leave a vessel tracking indefinitely?#
You can, but it is worth not doing. Tracking generates positions and notifications continuously, so leaving vessels tracked after you have stopped caring about them adds noise to GET /notification and makes it harder to see what matters.Stop tracking when a voyage ends. The trade report is generated at that point and covers the voyage.What does a 403 mean?#
That the endpoint belongs to an addon your account does not have enabled, not that your credentials are wrong. Wrong credentials give you a 401.Do my Insights credentials work here?#
No. PurpleTRAC has its own credentials and its own scheme, and the two do not cross. If you use both products you hold two sets. See Authentication.
Getting Started
The transaction id and the three workflows.
Errors & Status Codes
Every error shape, and which are not JSON.
Testing
The mock server, the only safe place to try calls, since a real key always reaches production.Modified at 2026-10-02 12:24:26
