# BrowserCat API API

> BrowserCat API API on Apizie: 23 endpoints (Show server health, Show server metrics, Open OpenAPI docs, Retrieve API spec as JSON, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/open-data:browsercat/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:browsercat`
- Category: Open Data
- Status: byok
- Source: https://browsercat.com
- Page: https://zieapi.vercel.app/api/open-data/browsercat
- OpenAPI: https://zieapi.vercel.app/api/open-data/browsercat/openapi.json

Providing purr-fect headless browser access via utility endpoints and direct websocket connections.

## Endpoints

### Show server health
`GET https://zieapi.vercel.app/v1/open-data:browsercat/server-check-health-status` (byok)

### Show server metrics
`GET https://zieapi.vercel.app/v1/open-data:browsercat/server-show-metrics` (byok)

### Open OpenAPI docs
`GET https://zieapi.vercel.app/v1/open-data:browsercat/open-api-explore-functionality` (byok)

### Retrieve API spec as JSON
`GET https://zieapi.vercel.app/v1/open-data:browsercat/open-api-get-spec-json` (byok)

### Retrieve API spec as YAML
`GET https://zieapi.vercel.app/v1/open-data:browsercat/open-api-get-yaml-spec` (byok)

### Connect to a browser
`GET https://zieapi.vercel.app/v1/open-data:browsercat/browsers-establish-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no |  |

### List API keys
`GET https://zieapi.vercel.app/v1/open-data:browsercat/api-keys-list-all` (byok)

### Create an API key
`POST https://zieapi.vercel.app/v1/open-data:browsercat/api-keys-create-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an API key
`GET https://zieapi.vercel.app/v1/open-data:browsercat/api-keys-get-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyId | string | yes | Key ID |

### Update an API key
`POST https://zieapi.vercel.app/v1/open-data:browsercat/api-keys-update-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyId | string | yes | Key ID |
| body | object | yes | JSON request body |

### Patch an API key
`POST https://zieapi.vercel.app/v1/open-data:browsercat/api-keys-update-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyId | string | yes | Key ID |
| body | object | yes | JSON request body |

### Revoke an API key
`POST https://zieapi.vercel.app/v1/open-data:browsercat/api-keys-revoke-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyId | string | yes | Key ID |

### List aggregate account usage
`GET https://zieapi.vercel.app/v1/open-data:browsercat/usage-list-aggregate-account-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit the number of results |
| offset | string | no | Offset the returned results by this many |
| afterDate | string | no | Only return results after this date (inclusive) |
| beforeDate | string | no | Only return results before this date (exclusive) |
| unit | string | no |  |
| userId | string | no |  |
| keyId | string | no |  |
| method | string | no |  |
| endpoint | string | no |  |

### List sessions within range
`GET https://zieapi.vercel.app/v1/open-data:browsercat/usage-get-session-range` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit the number of results |
| offset | string | no | Offset the returned results by this many |
| afterDate | string | no | Only return results after this date (inclusive) |
| beforeDate | string | no | Only return results before this date (exclusive) |

### Retrieve data for a request
`GET https://zieapi.vercel.app/v1/open-data:browsercat/usage-get-request-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | UsageSession ID |

### List events for a request
`GET https://zieapi.vercel.app/v1/open-data:browsercat/usage-list-request-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | UsageSession ID |
| limit | integer | no | Limit the number of results |
| offset | string | no | Offset the returned results by this many |
| afterDate | string | no | Only return results after this date (inclusive) |
| beforeDate | string | no | Only return results before this date (exclusive) |

### Retrieve data for an event
`GET https://zieapi.vercel.app/v1/open-data:browsercat/usage-get-event-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | UsageSession ID |
| eventId | string | yes | UsageEvent ID |

### List subscriptions within range
`GET https://zieapi.vercel.app/v1/open-data:browsercat/billing-list-subscriptions-within-range` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit the number of results |
| offset | string | no | Offset the returned results by this many |
| afterDate | string | no | Only return results after this date (inclusive) |
| beforeDate | string | no | Only return results before this date (exclusive) |

### Get active subscription
`GET https://zieapi.vercel.app/v1/open-data:browsercat/billing-get-active-subscription` (byok)

### Get specific subscription
`GET https://zieapi.vercel.app/v1/open-data:browsercat/billing-get-specific-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subId | string | yes | Subscription ID |

### List invoices within range
`GET https://zieapi.vercel.app/v1/open-data:browsercat/billing-list-invoices-range` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit the number of results |
| offset | string | no | Offset the returned results by this many |
| afterDate | string | no | Only return results after this date (inclusive) |
| beforeDate | string | no | Only return results before this date (exclusive) |

### Get specific invoice
`GET https://zieapi.vercel.app/v1/open-data:browsercat/billing-get-specific-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invId | string | yes | Invoice ID |

### Get PDF receipt for specific invoice
`GET https://zieapi.vercel.app/v1/open-data:browsercat/billing-get-invoice-pdf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invId | string | yes | Invoice ID |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:browsercat/server-check-health-status" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the BrowserCat API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:browsercat/server-check-health-status with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the BrowserCat API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. BrowserCat API itself also needs your own key from api.browsercat.com.

### Can AI agents use the BrowserCat API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:browsercat.

### What is the status of the BrowserCat API API?
Needs your own provider key (bring your own key)