getOriginDataForDestinationZIPCode

get

getOriginDataForDestinationZIPCode

Get data about trips to a destination, organized by where trips are starting from.

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.

Request Body

zipCode 5-digit ZIP code to specify the destination of trips (e.g., 60607) true

HTTP Basic

OAuth 2.0

API Key

Reset

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 Code
    Error Code
    Description
  • 400
    400

    Bad Request response

  • 401
    401

    Unauthorized response

  • 500
    500

    Server Error response

Resource Summary

Security

Category

Mobility Trends

Name Type Description
Name Type Description

Working...

© 2019 Arity, LLC. All rights reserved.  | Privacy Policy | Terms of Use | Legacy APIs