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, A Tomahawk Support agent must generate an authentication token with the correct structural permissions assigned. Once this token is generated for you, it will be sent securely to you, and you can use this API key in the body of a get request, sent to this endpoint:

https://controller.preview.operationscommander.io/api/[YOUR CLIENT ID]/v1/permits/lot-values

This is how the body should be formatted to receive lot values in return;

{
    "apiToken": "0d2bef1a-4819-4c6a-b552-1b9e3d936333"
}

No other information is required in the body, this get request will return a list of the values of each lot in order of lot ID.

Using this Feature

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

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. The API token must be exactly as it appears when it was sent to you by OPSCOM. It is your information's password.

  • Match pull frequencies to operational needs. This API should not need to be polled more than once an hour.