Exports

Download an export file

Returns the generated file. CSV carries a UTF-8 byte-order mark so vessel names render correctly in Excel — read it with encoding="utf-8-sig" in Python. JSONL has no BOM, and each line is exactly the record the single-resource endpoint returns.

The SHA-256 of the file is returned in X-ArcNautical-Export-Sha256 and on the export resource, so an archived copy can be proven years later to be the one we generated.

409 export_not_ready means the file is still building; 410 export_unavailable means it has expired or been deleted. Both are recoverable — poll, or create a new export.

Required scope: the scope governing the exported resource.

get/api/v1/exports/{id}/download

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/exports/{id}/download
  • Auth: one of:
    • HTTP bearer
    • API key in header X-ArcNautical-Key
    • HTTP bearer
    • API key in header X-ArcNautical-Key
    • HTTP bearer
    • API key in header X-ArcNautical-Key

Path parameters

idstring uuid required

Export id.

Response

The export file.

Changes

No recorded changes to this operation across all 1 revision of this API.