Credits and limits
Credits count what an answer returns. A request that finds nothing, or fails, is not counted; the one exception is a sanctions check, where a clean result is the answer so it costs 1. Each response says in its headers what it cost. Full reports are for paid plans; with the free API allowance you see a free preview of each report.
| Returned | Credits |
|---|---|
| One vessel (search, details, area) | 1 |
| One vessel-day of track | 1 |
| One port call or one event | 1 |
| One row of a port's vessel list, one port in an area | 1 |
| One sanctions check, depth at one position | 1 |
| One port picture or waiting-time report | 5 |
| A port's terminals, one terminal report, one congestion report or a congestion list | 5 |
| A vessel's activity or employment, a gate's transits, a port's bunker deliveries, a traffic density map | 5 |
| One call in a vessel's or a port's call list | 1 |
| One route or one route check | 10 |
| One port call summary | 2,500 |
| One transit report | 5,000 |
| One AIS call timeline (one call) | 8,000 |
| One port and terminal report | 8,000 |
| One cargo and trade report | 8,000 |
| One port waiting report | 8,000 |
| One vessel history, up to 90 days | 15,000 |
| One vessel history, over 90 days | 20,000 |
| An AIS call timeline up to 90 days back for a vessel on your list on a Plus watch plan, or a call timeline, call summary or history on Pro or Custom, whenever you added her | free |
| Longer histories and port reports for what you watch on Pro, within the month's allowance (10 on Pro) | free |
| Other reports on a watch plan | 20 % off on Plus, 30 % off on Pro |
| A report's free preview (key figures and how well heard) | free |
| Status, sources, usage, report verification | free |
Response headers
| Header | Meaning |
|---|---|
X-Credits-Used | credits this request cost |
X-Credits-Remaining | left in this billing period |
X-RateLimit-Remaining | requests left this minute |
Retry-After | seconds to wait after a 429 |
Data API plans
| Plan | Credits a month | Data | Requests a minute | Largest vessel area | History | Price |
|---|---|---|---|---|---|---|
| Free API allowance | 1,000 | 24 hours behind | 30 | 1 square degree | 7 days | €0 |
| Plus | 20,000 | live | 120 | 4 square degrees | 90 days | €49 a month |
| Pro | 80,000 | live and the live stream | 300 | 25 square degrees | up to 12 months | Write to us |
| Scale | 250,000 or agreed | live and the live stream | 600 | 100 square degrees | up to 12 months | Write to us |
The largest vessel area applies to vessels in an area and to the live stream. Port lists, events and congestion take a box up to 400 square degrees on every plan. Within the requests a minute, 6 route requests and 30 route checks a minute per key on every plan. The free API allowance reaches back 7 days from now and its answers end 24 hours ago so its track is at most 144 hours.
The same report asked for again within 24 hours costs nothing: same path, same question. So does one you already bought on the dashboard, when asked for there. After 24 hours it is a new report.
Extra credits for the rest of the month: 10,000 for €35 on Plus, 25,000 for €65 on Pro. A watch plan brings no Data API credits: the Data API is its own plan. Prices exclude VAT.
curl -i https://gangwayais.com/v1/vessels/538005172 \ -H "Authorization: Bearer $GANGWAY_KEY" # HTTP/2 200 # x-credits-used: 1 # x-credits-remaining: 19 842 # x-ratelimit-remaining: 119