> ## Documentation Index
> Fetch the complete documentation index at: https://docs.checkthatfield.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Widget overview

> Show how likely the fields near a home are to be built on, in your own page, with two lines of HTML.

The Check That Field widget puts our scores for the fields near a place into your page. It suits property listings, area guides and regional portals: anywhere a reader wants to know whether the field behind a house might become a housing estate.

You add a `div` and a script tag. The widget does the rest: it finds the nearest open fields, shows their scores, sizes itself to fit and credits the data it uses.

> [card] [Install it](https://docs.checkthatfield.com/widget/install.md)
>
> The snippet, a plain-iframe version for strict sites, and how to get a key.

> [card] [Options](https://docs.checkthatfield.com/widget/options.md)
>
> Where to look (postcode, or latitude and longitude) and light or dark.

> [card] [What readers see](https://docs.checkthatfield.com/widget/states.md)
>
> Every state, from a full answer to "isn't set up for this site".

> [card] [Security and privacy](https://docs.checkthatfield.com/widget/security-and-privacy.md)
>
> Who may show it, what we count, and what we never collect.

## What it shows

For a postcode or a point, the widget looks at the **5 nearest open fields within 500 m** and shows:

* **The nearest field with a score**: its band (Low, Moderate, High or Very High), its score out of 100, how far away it is, the outlook over the next 5 and 15 years, and up to three main reasons in a few words.
* **Fields nearby**: each of the five, numbered, with its distance, its size in hectares, and its band and score, or "Being checked".
* **A small map** of the same fields, numbered as in the list. It loads only when the reader scrolls near it.
* **A link to the full report** on checkthatfield.com, which opens in a new tab.
* **The data credits** we are required to show, and "Powered by Check That Field".

This is what our free report shows. The sources, the records and the full reasoning stay in the deep report on our site.

> [!NOTE]
>
> Fields we haven't scored yet are queued for scoring when the widget asks about them, and show as "Being checked" until they are done, usually in a few minutes. See [Pending scores](https://docs.checkthatfield.com/api/pending-scores.md).

## How it works

The widget is an iframe served from `www.checkthatfield.com`. Its styles and scripts are kept apart from your page, so neither can break the other. The optional loader script, `/embed/v1.js`, has no dependencies. It makes the iframe as the widget nears the screen, and resizes it to fit its content.

Each widget uses a **publishable key** (`ctf_pk_live_…`). The key is meant to sit in your page's HTML, and it works only on the sites it was issued for. See [Security and privacy](https://docs.checkthatfield.com/widget/security-and-privacy.md).

## What it costs you

Every widget load is one call against your key's monthly quota, the same quota the API counts against. Pricing is by arrangement for now: email [hello@checkthatfield.com](mailto:hello@checkthatfield.com).

> [!TIP]
>
> Need the numbers in your own design, or on your server? Use the [Partner API](https://docs.checkthatfield.com/api/overview.md) instead. It returns the same scores as JSON.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.