CDS Endpoints

Returns Curb Zones based on given specific parameters.

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.

GETyzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/zones

Authorization

api_key

Query parameters

Response

200400

A successful response containing Curb Zones.

Body

application/json

versionstring

Example: "1.0.1"

time_zonestring

Example: "US/Eastern"

currencystring

Example: "USD"

authorstring

Example: "CurbIQ"

typestring

Example: "curbiq_api_response"

request_typestring

Example: "zones"

city_idstring

Example: "768bbbf9-1ee2-45da-aafb-a44808461f86"

city_namestring

Example: "arlington"

licence_urlstring

standard_time_offsetstring

Example: "UTC-5"

dst_time_offsetstring

Example: "UTC-4"

dst_startstring

Example: "2024-03-10"

dst_endstring

Example: "2024-11-03"

query_parametersobject

pagesobject

dataarray of object

Request

JavaScriptCurlPython

const response = await fetch('yzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/zones?curbiq_token=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "version": "1.0.1",
  "time_zone": "US/Eastern",
  "currency": "USD",
  "author": "CurbIQ",
  "type": "curbiq_api_response",
  "request_type": "zones",
  "city_id": "768bbbf9-1ee2-45da-aafb-a44808461f86",
  "city_name": "arlington",
  "licence_url": null,
  "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": "cbca3a68-9511-4305-9278-4f84e73de5ac"
  },
  "pages": {
    "total": 1,
    "current": 1
  },
  "data": [
    {
      "zones": [
        {
          "city_id": "768bbbf9-1ee2-45da-aafb-a44808461f86",
          "city_name": "arlington",
          "last_updated": 1706043881390,
          "curb_zone_id": "00c291e4-2506-42cd-887e-8de1d3b3d0ca",
          "demand_monitor_id": "84404598-dff0-489c-aa0b-2bbea04ca4f8",
          "segment_id": "377",
          "published_date": 1706044048915,
          "last_updated_date": 1706044048915,
          "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,
          "cellzone": "54651",
          "MetroArea": "Clarendon",
          "PaymentArea": "124 - Payment Zone",
          "MeterIDs": [
            "WA03001N"
          ],
          "prev_policies": null,
          "curb_policy_ids": [
            "348357c3-ee1c-44a2-acea-00fea37fae6c",
            "9ac86af0-b2b2-4391-a4db-08f723367a88"
          ],
          "curb_area_names": [
            "Payment Area 6A",
            "124 - Payment Zone"
          ]
        }
      ]
    }
  ]
}

Curb Zone Policy API - FETCH zone by id

Fetch all the information about a zone using its CDS curb_zone_id or its CurbIQ-specific segment_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.

FETCHyzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/zones/{curb_zone_id}

Path parameters

curb_zone_id*string

The unique identifier for the Curb Zone.

Query parameters

Response

200400

A successful response containing Curb Zones.

Body

application/json

typestring

Example: "curbiq_api_response"

request_typestring

Example: "search_by_zone"

request_parametersobject

responsesarray of object

Request

JavaScriptCurlPython

const response = await fetch('yzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/zones/{curb_zone_id}', {
    method: 'FETCH',
    headers: {},
});
const data = await response.json();

Response

200

{
  "type": "curbiq_api_response",
  "request_type": "search_by_zone",
  "request_parameters": {
    "curb_zone_id": "0685fe51-269e-4953-914c-d040a1304a5d"
  },
  "responses": [
    {
      "curb_zone_id": "0685fe51-269e-4953-914c-d040a1304a5d",
      "city_id": "7010923a-7669-4980-aebe-057c656a7574",
      "segment_id": 1484,
      "geometry": {
        "type": "MultiLineString",
        "coordinates": [
          [
            [
              -6.265070794661474,
              53.34576206629382
            ],
            [
              -6.265095394443243,
              53.34575908626552
            ]
          ]
        ]
      },
      "published_date": 1682629822200,
      "last_updated_date": 1682629822200,
      "start_date": 1682629822200,
      "user_zone_id": 1229,
      "street_name": "WELLINGTON QUAY",
      "parking_angle": "parallel",
      "num_spaces": 5,
      "policies": [
        {
          "curb_policy_id": "036253dc-bbe3-48e9-88dd-cf059e02797c",
          "regulation_id": 1122,
          "published_date": 1682631244223,
          "priority": 100,
          "rules": [
            {
              "rule_id": "9c6ec3cd-18d7-44a0-a05c-f05b3dfc07b6",
              "curb_policy_id": "036253dc-bbe3-48e9-88dd-cf059e02797c",
              "activity": "no stopping",
              "user_classes": [
                "curb cut"
              ],
              "rates": [
                {
                  "rate_id": "7d995f5e-823b-4c22-b14f-6c93ed93e656",
                  "rule_id": "9c6ec3cd-18d7-44a0-a05c-f05b3dfc07b6",
                  "rate": 0,
                  "rate_unit": "hour",
                  "rate_unit_period": "rolling"
                }
              ]
            }
          ],
          "timespans": [
            {
              "timespan_id": "1376e5db-1eef-4d24-b17b-4ca719efa125",
              "curb_policy_id": "036253dc-bbe3-48e9-88dd-cf059e02797c",
              "days_of_week": [
                "mon",
                "tue",
                "wed",
                "thu",
                "fri",
                "sat",
                "sun"
              ],
              "time_of_day_start": "00:00",
              "time_of_day_end": "23:59"
            }
          ]
        }
      ]
    }
  ]
}