Skip to main content

Barentswatch REST API Client

Project description

bwac - barentswatch API Client

The script in this repository allows to collect AIS messages send via the barentswatch REST API for AIS data.

Installation

Install from source:

git clone https://github.com/2maz/barentswatch-apiclient.git

python3 -m venv venv-barents-watch
. venv-barents-watch/bin/activate

pip install ./barentswatch-apiclient

Usage

Create an account and register a client (see http://developer.barentswatch.no/docs/appreg). Create a .env file with the credentials for accessing the

BARENTS_WATCH_CLIENT_ID=your@email.com:yourapp
BARENTS_WATCH_CLIENT_SECRET=XXXXX

To download data from the livestream by creating daily CSV files of the format AIS_YYYY_mm_dd.csv use

$> bwac live

To retrieve data from the historic api for a specific timeframe, which can be a maximum of 14 days in the past (this limit is set by barentswatch):

$> bwac historic --from-date 2026-04-14T00:00:00+00:00 --to-date 2026-04-15T23:59:59+00:00

License

This work is licensed under the BSD-3-Clause License. Data is made accessible via barentswatch.no and licensed under Norwegian License for Public Data (see also https://www.barentswatch.no/artikler/api-vilkar/).

Copyright

Copyright (c) 2025-2026 Simula Research Laboratory, Oslo, Norway

Acknowledgments

All data is provided by the live AIS API from barentswatch.no.

The development of this client is part of the EU-project AI4COPSEC which receives funding from the Horizon Europe framework programme under Grant Agreement N. 101190021.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bwac-0.1.0.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bwac-0.1.0-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file bwac-0.1.0.tar.gz.

File metadata

  • Download URL: bwac-0.1.0.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bwac-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bd69859f017c453692ec4175b1a03a2947e299331df812917b0240704200cc00
MD5 9b12e28a169af534888064268b1c15ab
BLAKE2b-256 84611f2b28e50d28a96afeb8543bea5b9a057609b52626feb2cf2d0028ace07a

See more details on using hashes here.

Provenance

The following attestation bundles were made for bwac-0.1.0.tar.gz:

Publisher: build-wheel.yml on 2maz/barentswatch-apiclient

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bwac-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: bwac-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bwac-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a802de9ab103e4761a6c34be10149dd27acd89c2ddc6a22cdd25b0e714bb8e9a
MD5 d2fdb708c94ad7fef1ae43ba51549980
BLAKE2b-256 4564252d5a47eda29d66844fd4898c649eab0e77a237ac5e320b4b3cac0b250f

See more details on using hashes here.

Provenance

The following attestation bundles were made for bwac-0.1.0-py3-none-any.whl:

Publisher: build-wheel.yml on 2maz/barentswatch-apiclient

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page