getOriginDataForDestinationZIPCode
get
getOriginDataForDestinationZIPCode
Resource URL
https://api-sandbox.arity.com/shared-mobility-insights/v1/zip-codes/{zipCode}/origin-zip-codes
Query Parameters
| Name | Values | Description |
|---|---|---|
|
tripType
(required) |
Type of transportation (taxi data at ZIP level is only available in Chicago and 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 destination of trips (e.g., 60607) 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 |
|---|---|---|
| destinationZipCode .zipCode | string | 5-digit ZIP code to specify where trips end (e.g., 60654) |
| destinationZipCode .relativityScore | number | Value showing relative popularity of the destination ZIP code compared to other ZIP codes in the metro area based on number of trips ending there. A value of 2 signifies that about twice as many trips end in this ZIP compared to the average ZIP, while a value of .5 signifies that about half as many do, during the requested time window. |
| destinationZipCode .averageTripMiles | number | Average length of all trips ending in this ZIP during the requested time window |
| destinationZipCode .averageTripDuration | number | Average duration, in minutes, of all trips ending in this ZIP during the requested time window |
| originZipCodes | array | List of origin zip codes with traffic patterns going to the specified destination zip code. |
| originZipCodes[] .zipCode | string | 5-digit ZIP code to specify the origin of trips (e.g., 60606) |
| originZipCodes[] .tripPercentage | number | For the specified time window, percentage of all trips ending in the supplied destination ZIP code that started in this origin ZIP code. Percentages are expressed as decimals (e.g., 0.12 = 12%) |
| originZipCodes[] .averageTripMiles | number | Average length of all trips beginning in this ZIP and ending in the specified destination ZIP during the requested time window |
| originZipCodes[] .averageTripDuration | number | Average duration, in minutes, of all trips beginning in this ZIP and ending in the specified destination ZIP during the requested time window |
Working...