lyft · Schema

Lyft Cost Estimate

An estimated cost, distance, and duration for a Lyft ride between two locations for a specific ride type.

Properties

Name	Type	Description
ride_type	string	Identifier for the type of Lyft ride.
display_name	string	Human-readable name for the ride type.
currency	string	ISO 4217 currency code.
estimated_cost_cents_min	integer	Lower bound of the estimated cost in cents.
estimated_cost_cents_max	integer	Upper bound of the estimated cost in cents.
estimated_distance_miles	number	Estimated distance of the ride in miles.
estimated_duration_seconds	integer	Estimated duration of the ride in seconds.
primetime_percentage	string	Current Prime Time percentage applied to the cost estimate, formatted as a percentage string such as 25%.
primetime_confirmation_token	string	A token that must be included when requesting a ride during Prime Time pricing.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://lyft.com/schemas/lyft/cost-estimate.json",
  "title": "Lyft Cost Estimate",
  "description": "An estimated cost, distance, and duration for a Lyft ride between two locations for a specific ride type.",
  "type": "object",
  "required": ["ride_type", "estimated_cost_cents_min", "estimated_cost_cents_max"],
  "properties": {
    "ride_type": {
      "type": "string",
      "description": "Identifier for the type of Lyft ride.",
      "enum": ["lyft", "lyft_line", "lyft_plus", "lyft_premier", "lyft_lux", "lyft_luxsuv"]
    },
    "display_name": {
      "type": "string",
      "description": "Human-readable name for the ride type."
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code.",
      "pattern": "^[A-Z]{3}$"
    },
    "estimated_cost_cents_min": {
      "type": "integer",
      "description": "Lower bound of the estimated cost in cents.",
      "minimum": 0
    },
    "estimated_cost_cents_max": {
      "type": "integer",
      "description": "Upper bound of the estimated cost in cents.",
      "minimum": 0
    },
    "estimated_distance_miles": {
      "type": "number",
      "description": "Estimated distance of the ride in miles.",
      "minimum": 0
    },
    "estimated_duration_seconds": {
      "type": "integer",
      "description": "Estimated duration of the ride in seconds.",
      "minimum": 0
    },
    "primetime_percentage": {
      "type": "string",
      "description": "Current Prime Time percentage applied to the cost estimate, formatted as a percentage string such as 25%."
    },
    "primetime_confirmation_token": {
      "type": "string",
      "description": "A token that must be included when requesting a ride during Prime Time pricing."
    }
  }
}