WaterQualityArchive SDK

Water Quality Archive client, generated from the OpenAPI spec.

The Water Quality Archive provides comprehensive data on water quality measurements from various sampling points across England including coastal, river, lake, and groundwater sources.

Learn more about Water Quality Archive at environment.data.gov.uk/water-quality/view/landing.

This is an unofficial SDK for the Water Quality Archive public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

Learn more about Voxgig SDKs at voxgig.com/sdk.

Metadata kindly supplied by www.freepublicapis.com.

TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as a small set of semantic entities — Measurement — that you call directly, instead of assembling URL paths and query strings. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list):

const client = new WaterQualityArchiveSDK()
const items = await client.Measurement().list()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Offline unit testing

Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

TypeScript

const client = WaterQualityArchiveSDK.test()
const measurements = await client.Measurement().list()
// measurements is an array of bare Measurement records populated with mock data
console.log(measurements)

Python

client = WaterQualityArchiveSDK.test()
measurements = client.Measurement().list()
print(measurements)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = WaterQualityArchiveSDK::test([
    "entity" => ["measurement" => ["test01" => []]],
]);
$measurements = $client->Measurement()->list();

Golang

client := sdk.Test()
result, err := client.Measurement(nil).List(
    nil, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = WaterQualityArchiveSDK.test({
  "entity" => { "measurement" => { "test01" => {} } },
})
measurements = client.Measurement.list()

Lua

local client = sdk.test()
local results, err = client:Measurement():list()

Packages

Quickstart

TypeScript

import { WaterQualityArchiveSDK } from '@voxgig-sdk/water-quality-archive'

const client = new WaterQualityArchiveSDK()

// List all measurements (returns Measurement[])
const measurements = await client.Measurement().list()
for (const measurement of measurements) {
  console.log(measurement)
}

See the TypeScript README for the full guide.

Surfaces

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o water-quality-archive-mcp .

Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "water-quality-archive": {
      "command": "/abs/path/to/water-quality-archive-mcp"
    }
  }
}

Entities

The API exposes one entity:

The operations available across these entities are list — see each entity’s own list above for exactly which it supports.

Quickstart in other languages

Python

from waterqualityarchive_sdk import WaterQualityArchiveSDK

client = WaterQualityArchiveSDK()

# List all measurements (returns a list, raises on error)
measurements = client.Measurement().list()
for measurement in measurements:
    print(measurement)

PHP

<?php
require_once 'waterqualityarchive_sdk.php';

$client = new WaterQualityArchiveSDK();

// List all measurements (returns an array; throws on error)
$measurements = $client->Measurement()->list();
print_r($measurements);

Golang

import sdk "github.com/voxgig-sdk/water-quality-archive-sdk/go"

client := sdk.New()

// List all measurements
measurements, err := client.Measurement(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(measurements)

Ruby

require_relative "WaterQualityArchive_sdk"

client = WaterQualityArchiveSDK.new

# List all measurements (returns an Array; raises on error)
measurements = client.Measurement.list
puts measurements

Lua

local sdk = require("water-quality-archive_sdk")

local client = sdk.new()

-- List all measurements
local measurements, err = client:Measurement():list()
print(measurements)

Direct and prepare

For endpoints the entity model doesn’t cover, use the low-level methods:

• direct(fetchargs) — build and send an HTTP request in one step.
• prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})
if err != nil {
    panic(err)
}
fmt.Println(result)

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

1. Point — resolve the API endpoint from the operation definition.
2. Spec — build the HTTP specification (URL, method, headers, body).
3. Request — send the HTTP request.
4. Response — receive and parse the response.
5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

Pass custom features via the extend option at construction time.

Per-language documentation

• TypeScript
• Python
• PHP
• Golang
• Ruby
• Lua

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

• Upstream API: https://environment.data.gov.uk/water-quality/view/landing

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.

Generated from the Water Quality Archive OpenAPI spec by @voxgig/sdkgen.