v1.0/ — This document./sandbox — The sandbox page.The page where the API can be tried and tested.
/404.html — The "Not found" page./api/image — GET a screenshot URL.Takes a screenshot of the vessel at the specified moment in the past. The screenshot will contain the vessel marker, its track of the given duration, its photo and location description. Screenshots are taken against the map which center can be specified by latitude-longitude couple and the zoom value. The height and width of the screenshot can be also specified. The screenshot URL is returned in the response.
For details see the table of the query parameters below.
| Name | Description | Value | Default | Example |
|---|---|---|---|---|
dateTime | Date and time of the desired vessel position. Required. | String, ISO 8601 | 2023-03-24T09:17:45.913Z | |
token | Authentication token. Required. | String, [8, 100] | ||
vesselId | Vessel ID. Required. | Integer, [1, 999999] | ||
duration | Duration in hours back from dateTime. | [1, 999], Integer | 36 | |
lat | Latitude of the screenshot center. If present requires lng. | Float, [-90, 90] | Vessel latitude at dateTime moment. | -62.789 |
lng | Longitude of the screenshot center. If present requires lat. | Float, [-180, 180] | Vessel longitude at dateTime moment. | 132.34 |
layout | Image layout type. SIMPLE stands for plain map view, CARD has the vessel photo and info atop. Lower case values are also valid. | Enum, ["SIMPLE", "CARD"] | SIMPLE | CARD |
height | Height of the screenshot image. If present requires width. | [250, 1800], Integer. | 600 | |
width | Width of the screenshot image. If present requires height. | [250, 1200], Integer. | 400 | |
zoom | Zoom value of the screenshot. | [3, 9], Integer. | 5 |
/api/image?vesselId=9&dateTime=2022-12-12T09:17:45.913Z&token=q1W2rTy0
/api/image?vesselId=9&dateTime=2022-12-12T09:17:45.913Z&zoom=7&token=q1W2rTy0
/api/image?vesselId=9&dateTime=2022-12-12T09:17:45.913Z&duration=48&token=q1W2rTy0
/api/image?vesselId=9&dateTime=2022-12-12T09:17:45.913Z&lat=62&lng=-6.7&token=q1W2rTy0
/api/image?vesselId=9&dateTime=2022-12-12T09:17:45.913Z&layout=CARD&token=q1W2rTy0
/api/image?vesselId=9&dateTime=2022-12-12T09:17:45.913Z&zoom=7&height=500&width=450&token=q1W2rTy0
is a plain string of the image URL:Content-type: text/plain; charset=utf-8
https://tracemyfish-test.fishfacts.com/abc123.png