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

Zones

PreviousCurbsNextAreas

Last updated 3 months ago

A Curb Zone is a designated area along a curb that includes specific rules for vehicle use, such as parking or loading. Defined by cities, each Curb Zone must maintain a consistent regulation across its entire area, be located on a single street between the same cross streets, and not overlap with other zones that have the same validity times. Every Curb Zone is assigned a unique ID that stays the same unless the zone's physical boundaries change. The goal is to ensure that no vehicle can legally occupy two different zones simultaneously, unless required by other regulations.

Query Curb Zones

get

Get all the information about zones based on a specific location or time specified. Also specify the search radius and whether you only want information for curb zones on the same street. This API is useful if you are looking to get a better understanding of the curb regulations in front of a given address or location. All regulations will be provided around the location to help plan your curbside activity at your destination. Please note that either lat/long/radius or max_lat, max_lng, min_lat, min_lon must be entered as query parameters to search by position.

Query parameters
curbiq_tokenstringRequired

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

areastring · UUIDOptional

CDS
The ID of a Curb Area.
If specified, only return Curb Zones contained within this area.

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 Otherwise, the server should reply with 404 Not Found. Availability data (if supplied) will be returned as of this time.

Example: 1643130000000
include_geometrybooleanOptional

CDS
If the value is false, do not include the geometry field within the Curb Zone feature object.

city_namestringOptional

CCDS
Name of the city that is being queried

curb_zone_idstring · UUIDOptional

CCDS
The ID of a Curb Zone. If specified, only return the specified curb zone.

segment_idnumber · floatOptional

CCDS
The ID of the segment to be queried. If specified, only return the specified segment.

parking_anglestringOptional

CCDS
The angle in which passenger vehicles in this Curb Zone are meant to park.
May take one of the following values: parallel, perpendicular, angled

area_namestringOptional

CCDS
Name of the area being queried. If specified, only return Curb Zones contained within this area.

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 Zones.
application/json
400
Request failed.
get
GET /curbs/zones 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": "zones",
    "city_id": "768bbbf9-1ee2-45da-aafb-a44808461f86",
    "city_name": "arlington",
    "standard_time_offset": "UTC-5",
    "dst_time_offset": "UTC-4",
    "dst_start": "2024-03-10",
    "dst_end": "2024-11-03",
    "query_parameters": {
      "area": "a31cdc34-e2aa-4706-9c81-680245843203",
      "curbiq_token": "curbiq_token"
    }
  },
  "pages": {
    "total": 1,
    "current": 1
  },
  "data": [
    {
      "zones": [
        {
          "curb_zone_id": "00c291e4-2506-42cd-887e-8de1d3b3d0ca",
          "curb_policy_ids": [
            "348357c3-ee1c-44a2-acea-00fea37fae6c",
            "9ac86af0-b2b2-4391-a4db-08f723367a88"
          ],
          "prev_policies": null,
          "published_date": 1706044048915,
          "last_updated_date": 1706043881390,
          "prev_curb_zone_ids": null,
          "start_date": 1706044048915,
          "end_date": null,
          "location_references": null,
          "name": "NWAHIGAN",
          "user_zone_id": "375",
          "street_name": "WASHINGTON BOULEVARD",
          "cross_street_start_name": null,
          "cross_street_end_name": null,
          "length": null,
          "available_space_length": null,
          "availability_time": null,
          "width": null,
          "parking_angle": "parallel",
          "num_spaces": 10,
          "street_side": null,
          "median": null,
          "entire_roadway": null,
          "curb_area_ids": [
            null,
            "a31cdc34-e2aa-4706-9c81-680245843203"
          ],
          "curb_space_ids": null,
          "ccds_attributes": {
            "demand_monitor_id": "84404598-dff0-489c-aa0b-2bbea04ca4f8",
            "segment_id": "377",
            "curb_area_names": null
          }
        }
      ]
    }
  ]
}

Fetch Curb Zone

fetch

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

Path parameters
curb_zone_idstring · UUIDRequired

The unique identifier for the Curb Zone.

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 (in milliseconds).
Otherwise, the server should reply with 404 Not Found. Availability data (if supplied) will be returned as of this time.

Example: 1643130000000
show_historicbooleanOptional

CDS
Whether to return historic, retired curb zone data. Default is "false" to reduce payload size and complexity.

areastring · UUIDOptional

CCDS
The ID of a Curb Area.
If specified, only return Curb Zones contained within this area.

latnumber · floatOptional

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

lngnumber · floatOptional

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

radiusnumber · floatOptional

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

min_latnumber · floatOptional

CCDS
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

CCDS
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

CCDS
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

CCDS
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.

include_geometrybooleanOptional

CCDS
If the value is false, do not include the geometry field within the Curb Zone feature object.

city_namestringOptional

CCDS
Name of the city that is being queried

curb_zone_idstring · UUIDOptional

CCDS
The ID of a Curb Zone. If specified, only return the specified curb zone.

segment_idnumber · floatOptional

CCDS
The ID of the segment to be queried. If specified, only return the specified segment.

parking_anglestringOptional

CCDS
The angle in which passenger vehicles in this Curb Zone are meant to park.
May take one of the following values: parallel, perpendicular, angled

area_namestringOptional

CCDS
Name of the area being queried. If specified, only return Curb Zones contained within this area.

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 Zones.
application/json
400
Request failed.
fetch
FETCH /curbs/zones/{curb_zone_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": "zones",
    "city_id": "768bbbf9-1ee2-45da-aafb-a44808461f86",
    "city_name": "arlington",
    "standard_time_offset": "UTC-5",
    "dst_time_offset": "UTC-4",
    "dst_start": "2024-03-10",
    "dst_end": "2024-11-03",
    "query_parameters": {
      "curb_zone_id": "00aab68c-93d0-4e46-b30e-5eeb427db301",
      "curbiq_token": "curbiq_token"
    }
  },
  "pages": {
    "total": 1,
    "current": 1
  },
  "data": [
    {
      "zones": [
        {
          "curb_zone_id": "00c291e4-2506-42cd-887e-8de1d3b3d0ca",
          "curb_policy_ids": [
            "348357c3-ee1c-44a2-acea-00fea37fae6c",
            "9ac86af0-b2b2-4391-a4db-08f723367a88"
          ],
          "prev_policies": null,
          "published_date": 1706044048915,
          "last_updated_date": 1706043881390,
          "prev_curb_zone_ids": null,
          "start_date": 1706044048915,
          "end_date": null,
          "location_references": null,
          "name": "NWAHIGAN",
          "user_zone_id": "375",
          "street_name": "WASHINGTON BOULEVARD",
          "cross_street_start_name": null,
          "cross_street_end_name": null,
          "length": null,
          "available_space_length": null,
          "availability_time": null,
          "width": null,
          "parking_angle": "parallel",
          "num_spaces": 10,
          "street_side": null,
          "median": null,
          "entire_roadway": null,
          "curb_area_ids": [
            null,
            "a31cdc34-e2aa-4706-9c81-680245843203"
          ],
          "curb_space_ids": null,
          "ccds_attributes": {
            "demand_monitor_id": "84404598-dff0-489c-aa0b-2bbea04ca4f8",
            "segment_id": "377",
            "curb_area_names": null
          }
        }
      ]
    }
  ]
}
  • GETQuery Curb Zones
  • FETCHFetch Curb Zone