# Vendor Status Page (`vendor.status`)

Reads a vendor's public status page and returns its overall state, open incidents with their latest update, scheduled maintenance and affected components.

Docs: https://primaryapi.com/docs/api-reference/vendor/status

- Endpoint: `POST https://api.primaryapi.com/v1/run/vendor.status`
- Category: Web Intelligence · Platform: `vendor` · Kind: lookup · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=vendor.status`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `vendor` | string | yes |  | max 2048 chars | Status page URL ("https://www.githubstatus.com"), a known vendor ("github", "openai", "aws"), or the vendor's domain ("stripe.com" works only when it is in the built-in list). |
| `includeComponents` | boolean | no | false |  | Also return every component with its status (large pages list hundreds). |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `vendor` | string \| null | Registry key when the input matched a known vendor ("github"), else null. |
| `name` | string | Name the status page gives itself. |
| `pageUrl` | string |  |
| `pageType` | enum | Status page format that was read. |
| `indicator` | enum | Overall state: operational, minor (degraded), major (partial or major outage), critical, maintenance. |
| `description` | string \| null | The page's own overall status text, e.g. "All Systems Operational". |
| `incidents` | object[] | Unresolved incidents, newest first. |
| `incidents[].id` | string |  |
| `incidents[].name` | string |  |
| `incidents[].status` | string | The page's own incident status, lower-cased (investigating, identified, monitoring, …). |
| `incidents[].impact` | enum | Normalised impact (pages without an impact field report unknown). |
| `incidents[].startedAt` | string \| null |  |
| `incidents[].updatedAt` | string \| null | Time of the latest published update. |
| `incidents[].url` | string \| null |  |
| `incidents[].latestUpdate` | string \| null | Text of the latest published update, trimmed to 1,000 characters. |
| `incidents[].components` | string[] | Affected component names, sorted. |
| `incidentsAvailable` | boolean | false when the page does not publish incidents in machine-readable form (only component states are known). |
| `maintenances` | object[] | Maintenance in progress or scheduled, soonest first. |
| `maintenances[].id` | string |  |
| `maintenances[].name` | string |  |
| `maintenances[].status` | string | scheduled, in_progress, verifying, … |
| `maintenances[].scheduledFor` | string \| null |  |
| `maintenances[].scheduledUntil` | string \| null |  |
| `maintenances[].url` | string \| null |  |
| `maintenances[].components` | string[] |  |
| `affectedComponents` | object[] | Components that are not operational, sorted by group and name. |
| `affectedComponents[].name` | string |  |
| `affectedComponents[].group` | string \| null | Parent group / section name, when the page groups components. |
| `affectedComponents[].status` | enum | Normalised component status. |
| `componentCount` | integer |  |
| `components` | object[] \| null | Every component (sorted) when includeComponents=true, else null. |
| `components[].name` | string |  |
| `components[].group` | string \| null | Parent group / section name, when the page groups components. |
| `components[].status` | enum | Normalised component status. |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/vendor.status" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vendor":"github"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "vendor": "github",
      "name": "string",
      "pageUrl": "https://example.com",
      "pageType": "statuspage",
      "indicator": "operational",
      "description": "string",
      "incidents": [
        {
          "id": "string",
          "name": "string",
          "status": "string",
          "impact": "none",
          "startedAt": "string",
          "updatedAt": "string",
          "url": "https://example.com",
          "latestUpdate": "string",
          "components": [
            "string"
          ]
        }
      ],
      "incidentsAvailable": true,
      "maintenances": [
        {
          "id": "string",
          "name": "string",
          "status": "string",
          "scheduledFor": "string",
          "scheduledUntil": "string",
          "url": "https://example.com",
          "components": [
            "string"
          ]
        }
      ],
      "affectedComponents": [
        {
          "name": "string",
          "group": "string",
          "status": "operational"
        }
      ],
      "componentCount": 0,
      "components": [
        {
          "name": "string",
          "group": "string",
          "status": "operational"
        }
      ]
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=vendor.status`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

An unknown vendor name, or a URL that is not a supported status page, is a free miss (reason not_a_status_page or unknown_vendor). Sorted output without fetch timestamps: a monitor fires when an incident opens, updates or resolves, or a component changes state.

