Reports

Submit async report job

Changed on

Initiates a bulk data export job. Returns report_id immediately with status: _PENDING_. Poll GET /api/v0/report until status is _DONE_, then download the ZIP from result_url.

Report types

report_typeDescriptionCredit cost
vessel_listFull vessel registry snapshot5,000
port_listFull port list snapshot500
request_usageYour API key usage logFree
inradius_historyHistorical AIS for a zone (max 7-day window, max 50 NM radius)1 per unique vessel per calendar day, summed across the date range
dry_dock_datesDry dock bulk export2,000
companiesMaritime companies bulk export2,000
casualtyCasualties bulk export2,000
inspectionsInspections bulk export2,000
sales_purchase_demolitionsSales and demolitions bulk export2,000
ownershipOwnership bulk export2,000
class_societyClassification society bulk export2,000
engineEngine data bulk export2,000

Credit cost: the cost of the requested report_type, as listed above. Submitting carries no separate charge on top of that.

You are charged once per report. Checking the status of a report you already submitted is free, however many times you do it, and that includes fetching a fresh result_url after the previous link expired. A failed report deducts no credits.

An existing report cannot be restarted. To change the parameters, submit a new report, which is charged as a new report.

post/api/v0/report

Request

Request body

report_type'vessel_list' | 'port_list' | 'request_usage' | 'inradius_history' | 'dry_dock_dates' | 'companies' | 'casualty' | 'inspections' | 'sales_purchase_demolitions' | 'ownership' | 'class_society' | 'engine' required
latnumber float

Required for inradius_history. Centre latitude.

lonnumber float

Required for inradius_history. Centre longitude.

radiusinteger

Required for inradius_history. Radius in nautical miles (max 50).

fromstring date

Start date yyyy-mm-dd. inradius_history max 7-day window; request_usage max 31 days.

tostring date

End date yyyy-mm-dd.

updated_fromstring date

For add-on bulk reports. Only include records updated on or after this date.

Example request

{
  "lat": 51.8951,
  "lon": 4.3973,
  "radius": 10,
  "from": "2022-07-01",
  "to": "2022-07-05",
  "updated_from": "2023-01-01"
}

Response

Job accepted. Poll with the returned report_id.

Example response

{
  "data": {
    "report_id": "4ddc14e0-9059-9b86-1156-8efd93f0cfe6",
    "status": "_PENDING_",
    "report_type": "ownership",
    "message": "bad parameters: to must be later than from"
  },
  "meta": {
    "duration": 0.012,
    "endpoint": "/api/v0/vessel",
    "success": true,
    "next": "00e32b7a-4067-d6b2-8d73-2bdda4fe72bb"
  }
}

Changes

    • warning

      deleted the query request parameter api-key

    • warning

      added the new _DONE_ enum value to the / response property for the response status

    • warning

      added the new _FAILED_ enum value to the / response property for the response status

    • warning

      added the new _IN_PROGRESS_ enum value to the / response property for the response status

    • warning

      added the new _PENDING_ enum value to the / response property for the response status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed the DONE enum value from the / response property for the response status

    • info

      removed the FAILED enum value from the / response property for the response status

    • info

      removed the IN_PROGRESS enum value from the / response property for the response status

    • info

      removed the PENDING enum value from the / response property for the response status