Skip to main content

Lot Value API

The Lot Value API provides administrators with a programmatic version of the existing Lot Value Report. Its primary purpose is to retrieve real-time parking lot occupancy, valuation, and capacity data directly from the OPSCOM Controller, allowing organizations to independently ingest this information into their own custom data dashboards or third-party reporting tools.

Setup and Configuration

Before querying the endpoint, administrators must generate an authentication token with the correct structural permissions assigned.

Admin Side Configuration

  1. Hover over System Administration, click Security, and select API Tokens.

  2. Click the Create Token button or select an existing token from the list to edit its properties.

  3. Enable the lot values checkbox within the permissions matrix to authorize data access for this key.

  4. Click the Save button to commit the security changes.

  5. Copy the generated alphanumeric token string to your clipboard for use in your API client.

Using this Feature

The endpoint mimics the data structure of the standard system report but delivers it as a structured payload for external integration.

Accessing the API

  1. Open Postman and navigate to your workspace.

  2. Open the Shared folder, expand the Controller APIs collection, and select the pre-saved Lot Value API call.

  3. Select the Body tab within the Postman request panel.

  4. Input your copied system token into the designated apiToken field within the request body object.

  5. Click the Send button to dispatch the request to the Controller.

Expected API Responses

A successful request returns a structured JSON payload containing real-time data for all configured parking lots. The output includes individual lot identifiers, total capacities, active permit counts, current vehicle volume calculations, and the monetary value assigned to the spaces.

If an unauthenticated or incorrectly configured key is passed into the request body, the server rejects the connection.

If an incorrect token is provided, or if the token used lacks the explicit lot values permission checkbox validation, the API returns a standard authentication error message and blocks data retrieval.

Best Practices and Considerations

  • Verify token scopes before deployment. If your dashboard integration suddenly reports authorization failures, navigate back to the API Tokens page to verify that the lot values checkbox has not been accidentally disabled.

  • Match pull frequencies to operational needs. Because this API calculates real-time lot values and occupancy data directly from active database rows, avoid aggressive polling intervals (such as multiple requests per second) to prevent unnecessary processing load on your tracking Controller.

  • Align API outputs with internal dashboard names. Ensure your custom reporting tools map directly to the system lot string identifiers returned in the payload. If you modify a lot name on the Lot Administration page, the API will instantly reflect that change in its next data transmission.

Back to top