# Coverage

> Documentation index: [llms.txt](https://westkite.com/docs/llms.txt). Every page is also at its URL plus `.md`.

Returns what West Kite holds for a state or county: the number of properties served and the share of records carrying each field. Check coverage before treating an empty result as evidence that no records exist. Free.

```endpoint
GET /v1/coverage
```

## Parameters

| Name | Type | Description |
|---|---|---|
| `state` | string | A two-letter code (`TX`) or two-digit FIPS code (`48`). |
| `county` | string | A five-digit county FIPS code, such as `48201`. |

With neither, you get every county West Kite serves.

## Request

```curl
curl "https://api.westkite.com/v1/coverage?county=48201" \
  -H "Authorization: Bearer $WESTKITE_API_KEY"
```

```typescript
const res = await fetch("https://api.westkite.com/v1/coverage?state=TX", {
  headers: { Authorization: `Bearer ${process.env.WESTKITE_API_KEY}` },
});
const { data } = await res.json();
```

```python
import os, requests

res = requests.get(
    "https://api.westkite.com/v1/coverage",
    params={"state": "TX"},
    headers={"Authorization": f"Bearer {os.environ['WESTKITE_API_KEY']}"},
)
counties = res.json()["data"]["counties"]
```

## Response

```json 200
{
  "data": {
    "summary": { "counties": 1, "properties": 1500000 },
    "counties": [
      {
        "county_fips": "48201",
        "name": "Harris County, TX",
        "state": "TX",
        "properties": 1500000,
        "expected_properties": 1520000,
        "verified_at": "2026-11-10T04:12:00.000Z",
        "basis": "complete",
        "field_share": { "owner_name": 0.99, "last_sale_date": 0.71, "year_built": 0.94 }
      }
    ],
    "note": "A county not listed is not covered yet. field_share is the share of rows that carry each field; a field a county does not publish is absent, never zero."
  },
  "missing": [],
  "billing": { "operation_id": "op_c2d9…", "operation": "coverage", "charged_usd": 0, "balance_usd": 9.98 },
  "request_id": "req_c2d9…"
}
```

Values here are an example.

| Field | Description |
|---|---|
| `summary` | The number of counties and properties served in the scope |
| `counties` | One entry per county served, with its property count, `basis` and `field_share` |
 `field_share` is the share of the county's properties that carry each field. A field the county doesn't publish, such as sale prices in Texas, is left out rather than shown as zero.

## How to use it

- A county that isn't in `counties` isn't covered yet. A [find](https://westkite.com/docs/api/find.md) that returns nothing there says nothing about the place; tell the person and file a [data request](https://westkite.com/docs/api/data-requests.md).
- A field missing from `field_share` is unpublished there. Don't filter on it.
- `basis` and an optional `note` say when a county is served on a partial basis.

The same records are listed by category on [Data sources](https://westkite.com/docs/data.md).

## Errors

| Code | When |
|---|---|
| [`invalid_request`](https://westkite.com/docs/api/errors.md#invalid_request) | A `state` or `county` code in another form. |
