Areas

A Curb Area represents a specific neighborhood or area of interest in a city that includes one or more Curb Zones. Unlike Curb Zones, Curb Areas can overlap with each other, and the same Curb Zone can be part of multiple Curb Areas. These areas are intended to focus on specific regions within a city rather than covering the entire city. Curb Areas can be updated as needed, with cities optionally assigning a new curb_area_id when changes occur.

Query Curb Areas

get

Query parameters

curbiq_tokenstringRequired

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

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 (in centimeters).
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.

curb_area_idstring · uuidOptional

CCDS
The ID of a Curb Area. If specified, only return the specified curb area.

namestringOptional

CCDS
Name of the area being queried. If specified, only return the specified curb 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 Areas.

application/json

versionstringOptionalExample: 1.0.1

time_zonestringOptionalExample: US/Eastern

last_updatednumberOptionalExample: 1706043881390

currencystringOptionalExample: USD

authorstringOptionalExample: CurbIQ

licence_urlstring · nullableOptional

400

Bad request. Error in the query parameters such as an invalid token.

get

/curbs/areas

HTTPcURLJavaScriptPython

GET /curbs/areas?curbiq_token=text 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": "areas",
    "query_parameters": {
      "curbiq_token": "curbiq_token"
    }
  },
  "pages": {
    "total": 1,
    "current": 1
  },
  "data": [
    {
      "areas": [
        {
          "curb_area_id": "348357c3-ee1c-44a2-acea-00fea37fae6c",
          "name": "arlington_area_1",
          "published_date": 1706044048915,
          "last_updated_date": 1706043881390,
          "curb_zone_ids": [
            "00c291e4-2506-42cd-887e-8de1d3b3d0ca"
          ]
        }
      ]
    }
  ]
}

Fetch Curb Area

get

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

Path parameters

curb_area_idstring · uuidRequired

The unique identifier for the Curb Area.

Query parameters

curbiq_tokenstringRequired

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

latnumber · floatOptional

Latitude at the center of the search circle.

lngnumber · floatOptional

Longitude at the center of the search circle.

radiusnumber · floatOptional

Radius of the search circle (in centimeters).

min_latnumber · floatOptional

Min latitude for bounding box search. If any of min_lat, min_lng, max_lat, max_lng are specified, all must be.

min_lngnumber · floatOptional

Min longitude for bounding box search. If any of min_lat, min_lng, max_lat, max_lng are specified, all must be.

max_latnumber · floatOptional

Max latitude for bounding box search. If any of min_lat, min_lng, max_lat, max_lng are specified, all must be.

max_lngnumber · floatOptional

Max longitude for bounding box search. If any of min_lat, min_lng, max_lat, max_lng are specified, all must be.

namestringOptional

Name of the curb area.

response_sizeintegerOptional

Default is 100. Max is 250.

Default: 100

page_numintegerOptional

Page number for paginated responses.

Default: 1

Responses

200

A successful response containing Curb Areas.

application/json

versionstringOptionalExample: 1.0.1

time_zonestringOptionalExample: US/Eastern

last_updatednumberOptionalExample: 1706043881390

currencystringOptionalExample: USD

authorstringOptionalExample: CurbIQ

licence_urlstring · nullableOptional

400

Request failed.

get

/curbs/areas/{curb_area_id}

HTTPcURLJavaScriptPython

GET /curbs/areas/{curb_area_id}?curbiq_token=text 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": "areas",
    "query_parameters": {
      "curb_area_id": "a31cdc34-e2aa-4706-9c81-680245843203",
      "curbiq_token": "curbiq_token",
      "include_geometry": true
    }
  },
  "pages": {
    "total": 1,
    "current": 1
  },
  "data": [
    {
      "areas": [
        {
          "curb_area_id": "a31cdc34-e2aa-4706-9c81-680245843203",
          "geometry": [
            [
              null
            ]
          ],
          "name": "124 - Payment Zone",
          "published_date": 1706044048915,
          "last_updated_date": 1706043881390,
          "curb_zone_ids": [
            "00c291e4-2506-42cd-887e-8de1d3b3d0ca"
          ]
        }
      ]
    }
  ]
}