v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB
Demand Surge API

Get Demand Surges

get/v1/demand-surge/

Query parameters

min_surge_intensity's' | 'm' | 'l' | 'xl' required

Filters out demand surges smaller than the minimum surge intensity provided.

E.g. ?min_surge_intensity=m

date_fromstring date required

The beginning of the demand surge search window. The demand surge will be looked up over the next 90 days after the date you provide for the date_from parameter.

The accepted format for this parameter is YYYY-MM-DD

E.g. ?date_from=2021-05-12

location.place_idstring[]

A comma-separated list in the format representing the place ids of a location in the format <place_id1>,<place_id2> . It cannot be used with origin or radius suffixes.

E.g. ?location.place_id=2643743,2643744

location.originstring[]

A comma-separated coordinate (<lat>,<lon>) representing the centroid of a location. It must be used with location.radius and cannot be used with location.place_id.

E.g. ?location.origin=40.7128,74.0060

location.radiusstring

A string representing the radius for the demand surge, in the format <radius_value><radius_unit>, where <radius_value> is an integer or a float number up to 2 decimal places and <radius_unit> is one of:

  • m - meters
  • km - kilometers
  • ft - feet
  • mi - miles

E.g. ?location.radius=100mi

Response

Successful Response

countinteger required

The number of identified demand surges given the search criteria.