# Lyft — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Check real-time Lyft availability across cities, compare ride types and pricing, and see estimated arrival times for nearby drivers. Get detailed information about Lyft's service areas and instantly calculate trip costs before you book.

**Category:** Travel | **Website:** [lyft.com/](https://lyft.com/) | **Docs:** [parse.bot/marketplace/5830de95-6527-4164-afd7-167aae9388ae/lyft-com-api](https://parse.bot/marketplace/5830de95-6527-4164-afd7-167aae9388ae/lyft-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/lyft/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get cities

Returns the complete directory of cities where Lyft operates, organized by country code (US, CA). Each country contains an array of states/provinces, each with an array of cities carrying a display name and a slug usable with get_city_details. The response is a single directory object, not a paginated list.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lyft/get-cities \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get city details

Returns details about a specific Lyft city including its region code, service area geometry (GeoJSON), available ride type flags, and pricing disclaimers. The slug parameter comes from the get_cities directory.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | City slug from get_cities results (e.g. 'los-angeles-ca', 'phoenix-az', 'birmingham-al') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lyft/get-city-details \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### Get nearby drivers

Returns availability and estimated costs for each ride type at a given location. Shows which ride types are currently available, their ETA in seconds, and min/max cost range in cents. Coordinates should be within a Lyft service area.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `lat` | number | Yes | Latitude of the location |
| `lng` | number | Yes | Longitude of the location |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lyft/get-nearby-drivers \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"lat":"<number>","lng":"<number>"}'
```

### Get ride estimates

Returns price and duration estimates for all available ride types between two geographic points. Each estimate includes min/max cost in cents and estimated duration in seconds. Coordinates should be within a Lyft service area for valid estimates.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `end_lat` | number | Yes | Destination latitude |
| `end_lng` | number | Yes | Destination longitude |
| `start_lat` | number | Yes | Pickup latitude |
| `start_lng` | number | Yes | Pickup longitude |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lyft/get-ride-estimates \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"end_lat":"<number>","end_lng":"<number>","start_lat":"<number>","start_lng":"<number>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.