Get started
Errors
Errors use standard HTTP status codes and a JSON body that says what went wrong and how to fix it. Errors never cost credits.
| Status | When |
|---|---|
400 | A parameter is missing or out of range. The body names it. |
401 | No key, or the key is not valid or has been revoked. With no key at all the answer is one line: {"error": "A key is needed. Get one at https://gangwayais.com/account/"} |
402 | No credits left in this period, or paid_plan_required: a full report or a CSV or GPX export asked for on the free API allowance (for a report the body gives the address of its free preview). |
404 | No such vessel, port or route. |
422 | The request is valid but cannot be answered here (for example a route beyond 85° latitude). |
429 | Too many requests. Wait for Retry-After seconds. |
503 | A source or the route planner is busy. Retry with backoff. |
{
"status": 401,
"error": "unauthorized",
"detail": "this API key is not valid",
"param": null
}
