Articles in this section

Python

Tom Andres Lomsdalen
  • Updated
Follow

Use Python with WATS by any of the following options:

pywats-api — Official Python library (Beta)

The recommended way to integrate Python with WATS is the official pywats-api package, available on PyPI.

⚠️ Beta notice: This library is currently in beta (v0.5.0b3). The API is stabilizing but may have minor changes before the 1.0 release. It is suitable for evaluation and new integrations, but review the changelog before upgrading in production.

Installation:

pip install pywats-api

Requires Python 3.10+ (Developed using 3.14, so until release this is the safest choice)

It is based on WATS Server 2025.3.x or later, but most functions will work on older WATS versions as well.

For documentation, examples, and source code, see the PyPI page.

Use the REST API directly

You can also use Python with the WATS REST API without any library. Post reports in WSJF or WSXF format using any HTTP client (e.g. requests or httpx). This gives you full control and minimal dependencies.

import requests

requests.post(
    "https://yourserver.wats.com/api/report/WSJF",
    json=your_wsjf_payload,
    headers={"Authorization": "Basic YOUR_TOKEN"}
)

Other options

  • Install the WATS Client (Windows) and save reports in WSJF or WSXF format — the WATS Client service will upload them automatically (supports offline use)
  • Use a third-party .NET package to access the Client API (Windows)

For additional questions, please contact support@virinco.com.

Related articles

Comments

1 comment

Date Votes
  • Jesper Johnsen

    This got me started with the rest API and JSON:

    import json
    import requests

    sPyToken = "Your Token"
    headers = {"Authorization": 'Basic %s'%sPyToken}

    f = open('./WATS - WSJF UUT Example file.json',) 
    jsonData = json.load(f)
    response = requests.post('https://<your server name>.wats.com/api/report/wsjf', data=json.dumps(jsonData), headers=headers)

    print("Status code: ", response.status_code)
    print("Printing Entire Post Request")
    print(response.json())
    0
    Comment actions Permalink

Please sign in to leave a comment.