ParkWhiz API Capability

Search Hourly Parking

Search transient ParkWhiz parking availability and prices near coordinates for a specific time window.

Capability ID parkwhiz.parking.search

Cost 1 credit per request

Maximum runtime 30 seconds

# Search Hourly Parking

Search transient ParkWhiz parking availability and prices near coordinates for a specific time window.

- Platform: [ParkWhiz](https://docs.upscrape.com/docs/platforms/parkwhiz)
- Capability ID: `parkwhiz.parking.search`
- 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": {
    "distance_miles": 0.5,
    "end_time": "2026-09-09T20:00:00-05:00",
    "latitude": 41.881943,
    "longitude": -87.630976,
    "start_time": "2026-09-09T16:00:00-05:00"
  },
  "capability": "parkwhiz.parking.search"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `distance_miles` | `number` | No | Distance miles supplied for this request. |
| `end_time` | `string` | Yes | End time supplied for this request. |
| `latitude` | `number` | Yes | Latitude supplied for this request. |
| `longitude` | `number` | Yes | Longitude supplied for this request. |
| `start_time` | `string` | Yes | Start time supplied for this request. |

### Example input

```json
{
  "distance_miles": 0.5,
  "end_time": "2026-09-09T20:00:00-05:00",
  "latitude": 41.881943,
  "longitude": -87.630976,
  "start_time": "2026-09-09T16:00:00-05:00"
}
```

## 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
{
  "latitude": 41.881943,
  "locations": [
    {
      "address": "122 W. Monroe St.",
      "available": true,
      "base_price": 50,
      "distance_meters": 149,
      "lat": 41.8807336078693,
      "location_id": 63898,
      "lon": -87.63175377622248,
      "name": "Kimpton Gray Chicago - Valet Kiosk",
      "quote_id": "884a6389-3cc7-4de4-b1af-1b309ee062d4",
      "site_url": "/p/chicago-parking/122-w-monroe-st-2",
      "total_price": 53.5
    },
    {
      "address": "35 S. Dearborn St.",
      "available": true,
      "base_price": 18,
      "distance_meters": 161,
      "lat": 41.88127251918902,
      "location_id": 11672,
      "lon": -87.62924820206537,
      "name": "30 W. Monroe St. Garage",
      "quote_id": "87c7e29d-1ec4-4ea1-b8e0-69c353a358d4",
      "site_url": "/p/chicago-parking/35-s-dearborn-st",
      "total_price": 21.06
    },
    {
      "address": "22 W. Monroe St.",
      "available": true,
      "base_price": 52,
      "distance_meters": 227,
      "lat": 41.880813221222844,
      "location_id": 64895,
      "lon": -87.62868046760559,
      "name": "Hampton Inn Majestic Chicago - Valet kiosk",
      "quote_id": "0d342b45-e20a-4703-ab16-6f657714f483",
      "site_url": "/p/chicago-parking/22-w-monroe-st",
      "total_price": 58.97
    }
  ],
  "longitude": -87.630976,
  "scraped_at": "2026-08-30T12:44:18Z",
  "search_type": "transient"
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `latitude` | `number` | 41.881943 |
| `locations` | `array` | 3 items |
| `locations` | `array` | 3 items |
| `longitude` | `number` | -87.630976 |
| `scraped_at` | `string` | 2026-08-30T12:44:18Z |
| `search_type` | `string` | transient |

## 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

distance_miles number optional

Distance miles supplied for this request.

Example 0.5

end_time string required

End time supplied for this request.

Example 2026-09-09T20:00:00-05:00

latitude number required

Latitude supplied for this request.

Example 41.881943

longitude number required

Longitude supplied for this request.

Example -87.630976

start_time string required

Start time supplied for this request.

Example 2026-09-09T16:00:00-05:00

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
`latitude`	`number`	41.881943
`locations`	`array`	3 items
`locations`	`array`	3 items
`longitude`	`number`	-87.630976
`scraped_at`	`string`	2026-08-30T12:44:18Z
`search_type`	`string`	transient

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": { "distance_miles": 0.5, "end_time": "2026-09-09T20:00:00-05:00", "latitude": 41.881943, "longitude": -87.630976, "start_time": "2026-09-09T16:00:00-05:00" }, "capability": "parkwhiz.parking.search" }'

import json import requests payload = json.loads(r'''{ "input": { "distance_miles": 0.5, "end_time": "2026-09-09T20:00:00-05:00", "latitude": 41.881943, "longitude": -87.630976, "start_time": "2026-09-09T16:00:00-05:00" }, "capability": "parkwhiz.parking.search" }''') 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))

{ "latitude": 41.881943, "locations": [ { "address": "122 W. Monroe St.", "available": true, "base_price": 50, "distance_meters": 149, "lat": 41.8807336078693, "location_id": 63898, "lon": -87.63175377622248, "name": "Kimpton Gray Chicago - Valet Kiosk", "quote_id": "884a6389-3cc7-4de4-b1af-1b309ee062d4", "site_url": "/p/chicago-parking/122-w-monroe-st-2", "total_price": 53.5 }, { "address": "35 S. Dearborn St.", "available": true, "base_price": 18, "distance_meters": 161, "lat": 41.88127251918902, "location_id": 11672, "lon": -87.62924820206537, "name": "30 W. Monroe St. Garage", "quote_id": "87c7e29d-1ec4-4ea1-b8e0-69c353a358d4", "site_url": "/p/chicago-parking/35-s-dearborn-st", "total_price": 21.06 }, { "address": "22 W. Monroe St.", "available": true, "base_price": 52, "distance_meters": 227, "lat": 41.880813221222844, "location_id": 64895, "lon": -87.62868046760559, "name": "Hampton Inn Majestic Chicago - Valet kiosk", "quote_id": "0d342b45-e20a-4703-ab16-6f657714f483", "site_url": "/p/chicago-parking/22-w-monroe-st", "total_price": 58.97 } ], "longitude": -87.630976, "scraped_at": "2026-08-30T12:44:18Z", "search_type": "transient" }