ParkWhiz API Capability

Search Venues

Search ParkWhiz for venues by name.

Capability ID parkwhiz.search-venues

Cost 1 credit per request

Maximum runtime 30 seconds

# Search Venues

Search ParkWhiz for venues by name.

- Platform: [ParkWhiz](https://docs.upscrape.com/docs/platforms/parkwhiz)
- Capability ID: `parkwhiz.search-venues`
- Cost: 1 credit per request
- Maximum runtime: 30 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "query": "SoFi Stadium"
  },
  "capability": "parkwhiz.search-venues"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | Maximum number of results to return. |
| `page` | `integer` | No | One-based result page to fetch. |
| `query` | `string` | Yes | Venue name |

### Example input

```json
{
  "query": "SoFi Stadium"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "query": "SoFi Stadium",
  "scraped_at": "2026-08-01T10:54:23Z",
  "venues": [
    {
      "address": "1001 S. Stadium Drive",
      "city": "Inglewood",
      "name": "SoFi Stadium",
      "state": "CA",
      "venue_id": 473556
    }
  ]
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `query` | `string` | SoFi Stadium |
| `scraped_at` | `string` | 2026-08-01T10:54:23Z |
| `venues` | `array` | 1 items |
| `venues` | `array` | 1 items |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

limit integer optional

Maximum number of results to return.

page integer optional

One-based result page to fetch.

query string required

Venue name

Example SoFi Stadium

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

Path	Observed type	Example
`query`	`string`	SoFi Stadium
`scraped_at`	`string`	2026-08-01T10:54:23Z
`venues`	`array`	1 items
`venues`	`array`	1 items

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "query": "SoFi Stadium" }, "capability": "parkwhiz.search-venues" }'

import json import requests payload = json.loads(r'''{ "input": { "query": "SoFi Stadium" }, "capability": "parkwhiz.search-venues" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "query": "SoFi Stadium", "scraped_at": "2026-08-01T10:54:23Z", "venues": [ { "address": "1001 S. Stadium Drive", "city": "Inglewood", "name": "SoFi Stadium", "state": "CA", "venue_id": 473556 } ] }