getOriginBlockDataWithinZIPCode
get
getOriginBlockDataWithinZIPCode
Resource URL
https://api-sandbox.arity.com/shared-mobility-insights/v1/zip-codes/{zipCode}/origin-blocks
Query Parameters
| Name | Values | Description |
|---|---|---|
|
tripType
(required) |
Type of transportation (taxi data at block level is only available in New York City) |
|
|
startDayOfWeek
(required) |
Day of week marking start of time window |
|
|
startHour
(required) |
Integer from 0-23, with 0 representing 12 AM and 23 representing 11 PM |
|
| duration |
Length of time window in hours. Integer from 1 to 168 allowed. For example, a startHour of 21 and duration of 4 will return data from 9 PM on the startDayOfWeek to 1 AM the next day. If no duration is entered, the default will be 1 |
Header Parameters
| Name | Values | Description |
|---|---|---|
|
Authorization
(required) |
Value should be the word Bearer followed by a space and then the token (e.g., Bearer CW8abh5JkxZ5KYdAQQH0p9fTAicq). To generate a token, use the OAuth API. |
zipCode 5-digit ZIP code to specify the origin of trips (e.g., 60632) true
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Response Error Details
-
HTTP CodeError CodeDescription
-
400400
Bad Request response
-
401401
Unauthorized response
-
500500
Server Error response
Resource Summary |
|
|
Security |
None |
|
Category |
Mobility Trends |
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|---|---|
| originBlocks | array | List of origin blocks with traffic patterns within specified origin zip code. |
| originBlocks[] .blockCode | string | 15-digit FIPS code identifying the census block from where trips start |
| originBlocks[] .tripPercentage | number | Count of trips during requested time window starting from the census block as a percentage of all trips starting from the specified zip code. Percentages are expressed as decimals. |
| originBlocks[] .averageTripMiles | number | Average length of trips starting from the census block during the requested time window. |
| originBlocks[] .averageTripDuration | number | Average duration, in minutes, of trips starting from the census block during the requested time window. |
| originBlocks[] .centroid .lat | number | Latitude of the geographic center of the region |
| originBlocks[] .centroid .lng | number | Longitude of the geographic center of the region |
Working...