Skip to main content
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

Read the response

This real response is cut to three of its 32 sources.
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. 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. 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.
  • 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 are generated from it too.

How changes reach you

The changelog lists each release, newest first. For a material change to the service, the Terms of Service say Stophy writes to you by email or on the dashboard. Pin your SDK version, and read the changelog before you update.