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

# Status

> Check which Stophy sources passed their last checks with GET /v1/status, and see how the API stays stable: one version at /v1, and how changes reach you.

`GET /v1/status` shows which sources passed their last health checks. It is free and needs no API key, so a monitor or an agent can call it at any time.

## Make a request

```bash cURL theme={null}
curl https://api.stophy.dev/v1/status
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/status");
const { sources, updatedAt } = await response.json();
console.log(updatedAt, sources.filter((source: { state: string }) => source.state !== "up"));
```

```python Python theme={null}
import requests

body = requests.get("https://api.stophy.dev/v1/status").json()
print(body["updatedAt"], [s["id"] for s in body["sources"] if s["state"] != "up"])
```

## Read the response

> [accordion] Response
>
> This real response is cut to three of its 32 sources.
>
> ```json theme={null}
> {
>   "sources": [
>     {
>       "id": "amazon",
>       "name": "amazon",
>       "state": "up",
>       "passed": 5,
>       "total": 5,
>       "failing": [],
>       "medianMs": 1149,
>       "lastCheckAt": "2026-11-17T13:34:17.409Z"
>     },
>     {
>       "id": "ebay",
>       "name": "ebay",
>       "state": "partial",
>       "passed": 1,
>       "total": 2,
>       "failing": ["ebay.search"],
>       "medianMs": 5618,
>       "lastCheckAt": "2026-11-17T13:35:37.751Z"
>     },
>     {
>       "id": "expedia",
>       "name": "expedia",
>       "state": "down",
>       "passed": 0,
>       "total": 1,
>       "failing": ["expedia.hotels"],
>       "medianMs": 1439,
>       "lastCheckAt": "2026-11-17T09:59:16.557Z"
>     }
>   ],
>   "updatedAt": "2026-11-17T13:35:51.437Z"
> }
> ```

Each source is a site or a group of endpoints, such as `amazon` or `google`. Stophy checks each source on a schedule, with one check for each endpoint it covers.

| Field | What it is |
| - | - |
| `state` | `up` when every check passed, `partial` when some failed, `down` when none passed |
| `passed`, `total` | How many of the source's checks passed in the last run, and how many ran |
| `failing` | The checks that failed, as endpoint ids such as `ebay.search` |
| `medianMs` | The median time of the last checks, in milliseconds |
| `lastCheckAt` | When this source was last checked |
| `updatedAt` | When the list was last refreshed |

Use it to tell a problem on Stophy's side from a problem with your request. If a source is `partial` or `down`, the calls that read it can fail with `sourceUnavailable`, `sourceRefused`, `sourceTimeout` or `sourceChanged`. See [Troubleshooting](https://docs.stophy.dev/production/troubleshooting.md). A failed call costs nothing.

## How the API stays stable

* **One version.** Every endpoint is under `/v1`. There is no other version. A path that is not an endpoint answers `404` with code `notFound`, and the answer links to the [OpenAPI document](https://api.stophy.dev/openapi.json).
* **Strict requests.** An endpoint rejects a field it does not take with `400 invalidRequest`, and the answer lists the fields it does take. A typo cannot change what a call does without telling you.
* **Missing is empty.** Most responses leave out `null`, empty strings, empty objects and empty lists. Read optional fields with a default, and never depend on a field being present.
* **Older fields stay.** When a field is replaced, the older one stays in responses next to the new one, and the OpenAPI document marks it as an older field. For example `costUsd` replaced the cost in steps of \$0.002 that `creditsUsed` counts. Move to the new field when you can.
* **One source of truth.** The OpenAPI document at `https://api.stophy.dev/openapi.json` and the list at `https://api.stophy.dev/v1/endpoints` are generated from the running API. Every field, limit and price in them is what is live. The [SDKs](https://docs.stophy.dev/sdks) are generated from it too.

## How changes reach you

The [changelog](https://docs.stophy.dev/changelog.md) lists each release, newest first. For a material change to the service, the [Terms of Service](https://stophy.dev/tos) say Stophy writes to you by email or on the dashboard. Pin your SDK version, and read the changelog before you update.

## Related

* [Troubleshooting](https://docs.stophy.dev/production/troubleshooting.md)
* [Rate limits](https://docs.stophy.dev/production/rate-limits.md)
* [Changelog](https://docs.stophy.dev/changelog.md)
* [API reference](https://docs.stophy.dev/api-reference/introduction.md)


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