# Nomisweb — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Access official UK labour market statistics and population data from Nomis, including resident population figures, qualification levels, and detailed datasets. Search and retrieve the specific labour and demographic information you need for analysis and reporting.

**Category:** Government & Public Data | **Website:** [nomisweb.co.uk/](https://nomisweb.co.uk/) | **Docs:** [parse.bot/marketplace/9da28ef2-99a6-4c95-b506-ee94a5d4ed84/nomisweb-co-uk-api](https://parse.bot/marketplace/9da28ef2-99a6-4c95-b506-ee94a5d4ed84/nomisweb-co-uk-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/nomisweb/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get qualifications

Retrieve RQF (Regulated Qualifications Framework) qualification level counts from the Annual Population Survey (dataset NM_17_1) for people aged 16-64 in a specified local authority area and time period. Returns counts by qualification level; some values may be suppressed as statistically unreliable.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `area_name` | string | No | Name of the local authority area (e.g. Camden, Westminster, Islington, Hackney, Tower Hamlets). |
| `time_period` | string | No | Time period code in format YYYY-MM where MM indicates the end month of the survey period (e.g. 2023-12 for Jan 2023-Dec 2023, 2022-12 for Jan 2022-Dec 2022). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/nomisweb/get-qualifications \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"area_name":"<string>","time_period":"<string>"}'
```

### Get resident population

Retrieve resident population estimates from ONS dataset NM_31_1 for a given local authority area and year. Returns a single observation with population count, ONS geography code, and data quality status. The underlying dataset covers mid-year population estimates for England and Wales local authorities.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `area_name` | string | No | Name of the local authority area (e.g. Camden, Westminster, Islington, Hackney, Tower Hamlets). |
| `year` | string | No | Year for population estimates (e.g. 2023, 2022, 2021). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/nomisweb/get-resident-population \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"area_name":"<string>","year":"<string>"}'
```

### List datasets

List all available datasets in the Nomis catalogue with their identifiers and human-readable names. Returns the full set of datasets accessible through the Nomis API, covering labour market statistics, population estimates, census data, and more.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/nomisweb/list-datasets \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.