CurbIQ API Documentation
  • 🗺️Getting Started
  • Authentication
  • Curbs
    • Zones
    • Areas
    • Spaces
    • Policies
  • Events
    • Events
    • Status
  • Metrics
    • Aggregates
Powered by GitBook
On this page
  1. Curbs

Spaces

PreviousAreasNextPolicies

Last updated 3 months ago

A Curb Space refers to an individual, demarcated area within a Curb Zone designated for specific vehicle use, such as parking. Each Curb Space must be entirely contained within a single Curb Zone and cannot overlap with other Curb Spaces to maintain clear regulations. Unlike Curb Zones, which have fixed boundaries, Curb Spaces can be updated as needed, allowing cities to assign a new curb_space_id to reflect changes. This flexibility ensures that parking regulations can adapt to evolving urban needs while keeping the management of curb space organized and efficient.

  • GETQuery Curb Spaces
  • FETCHFetch Curb Space

Fetch Curb Space

fetch

Fetch all the information about a space using its CDS curb_space_id. This API is useful if you know exactly what curb space you need information for. A quick query will return all the relevant regulation data for the specified curb space.

Path parameters
curb_space_idstring · UUIDRequired

The unique identifier for the Curb Space.

Query parameters
curbiq_tokenstringRequired

The CurbIQ token provided to you when you registered for the API.

timeinteger · int64Optional

CDS
The Curb Zone object will only be returned if its validity period includes this time.
This parameter takes a time in the Timestamp format in milliseconds Otherwise, the server should reply with 404 Not Found. Availability data (if supplied) will be returned as of this time.

Example: 1643130000000
response_sizeintegerOptional

CCDS
Default is 100. The maximum response size is 250.

page_numintegerOptional

CCDS
Page number for paginated responses, default is 1.

Responses
200
A successful response containing Curb Spaces.
application/json
400
Bad request. Error in the query parameters such as an invalid token.
fetch
FETCH /curbs/spaces/{curb_space_id} HTTP/1.1
Host: v2.curbiq-curb-api.io
Accept: */*
{
  "version": "1.0.1",
  "time_zone": "US/Eastern",
  "last_updated": 1706043881390,
  "currency": "USD",
  "author": "CurbIQ",
  "licence_url": null,
  "ccds_attributes": {
    "type": "curbiq_api_response",
    "request_type": "spaces",
    "query_parameters": {
      "curbiq_token": "curbiq_token",
      "curb_space_id": "2f247f37-8775-4ca1-a7a8-3bbb635371ee"
    }
  },
  "pages": {
    "total": 1,
    "current": 1
  },
  "data": [
    {
      "spaces": [
        {
          "curb_space_id": "2f247f37-8775-4ca1-a7a8-3bbb635371ee",
          "name": "arlington_area_1",
          "published_date": 1706044048915,
          "last_updated_date": 1706043881390,
          "curb_zone_id": [
            "00c291e4-2506-42cd-887e-8de1d3b3d0ca"
          ],
          "space_number": 1,
          "length": null,
          "width": null,
          "available": false,
          "availability_time": null
        }
      ]
    }
  ]
}

Query Curb Spaces

get
Query parameters
curbiq_tokenstringRequired

The CurbIQ token provided to you when you registered for the API.

zonestring · UUIDOptional

CDS
The ID of a Curb Zone. If specified, only return Curb Spaces contained within this zone.

latnumber · floatOptional

CDS
Latitude at the center of the search circle.
This parameter is conditionally required if either 'lng' or 'radius' is specified.

lngnumber · floatOptional

CDS
Longitude at the center of the search circle.
This parameter is conditionally required if either 'lng' or 'radius' is specified.

radiusnumber · floatOptional

CDS
Radius of the search circle.
This parameter is conditionally required if either 'lng' or 'radius' is specified.

min_latnumber · floatOptional

CDS
For querying policies associated with all zones within a bounding box.
If any of 'min_lat', 'min_lng', 'max_lat', or 'max_lng' are specified, all must be.
If specified only return Curb Zones that intersect the supplied bounding box.

min_lngnumber · floatOptional

CDS
For querying policies associated with all zones within a bounding box.
If any of 'min_lat', 'min_lng', 'max_lat', or 'max_lng' are specified, all must be.
If specified only return Curb Zones that intersect the supplied bounding box.

max_latnumber · floatOptional

CDS
For querying policies associated with all zones within a bounding box.
If any of 'min_lat', 'min_lng', 'max_lat', or 'max_lng' are specified, all must be.
If specified only return Curb Zones that intersect the supplied bounding box.

max_lngnumber · floatOptional

CDS
For querying policies associated with all zones within a bounding box.
If any of 'min_lat', 'min_lng', 'max_lat', or 'max_lng' are specified, all must be.
If specified only return Curb Zones that intersect the supplied bounding box.

timeinteger · int64Optional

CDS
The Curb Zone object will only be returned if its validity period includes this time.
This parameter takes a time in the Timestamp format in milliseconds. Otherwise, the server should reply with 404 Not Found. Availability data (if supplied) will be returned as of this time.

Example: 1643130000000
response_sizeintegerOptional

CCDS
Default is 100. The maximum response size is 250.

page_numintegerOptional

CCDS
Page number for paginated responses, default is 1.

Responses
200
A successful response containing Curb Spaces.
application/json
400
Bad request. Error in the query parameters such as an invalid token.
get
GET /curbs/spaces HTTP/1.1
Host: v2.curbiq-curb-api.io
Accept: */*
{
  "version": "1.0.1",
  "time_zone": "US/Eastern",
  "last_updated": 1706043881390,
  "currency": "USD",
  "author": "CurbIQ",
  "licence_url": null,
  "ccds_attributes": {
    "type": "curbiq_api_response",
    "request_type": "spaces",
    "query_parameters": {
      "curbiq_token": "curbiq_token"
    }
  },
  "pages": {
    "total": 1,
    "current": 1
  },
  "data": [
    {
      "spaces": [
        {
          "curb_space_id": "348357c3-ee1c-44a2-acea-00fea37fae6c",
          "name": "arlington_area_1",
          "published_date": 1706044048915,
          "last_updated_date": 1706043881390,
          "curb_zone_id": [
            "00c291e4-2506-42cd-887e-8de1d3b3d0ca"
          ],
          "space_number": 1,
          "length": null,
          "width": null,
          "available": false,
          "availability_time": null
        }
      ]
    }
  ]
}