# Lime — 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.

> Access real-time availability data for Lime bikes and scooters, including station locations, vehicle status, system alerts, and geofencing zones across multiple cities. Monitor micromobility inventory and service information to find nearby vehicles or plan your trips effectively.

**Category:** Maps & Geospatial | **Website:** [data.lime.bike/](https://data.lime.bike/) | **Docs:** [parse.bot/marketplace/64941ac1-4ad3-48ba-9e53-98e2ff0a22a2/data-lime-bike-api](https://parse.bot/marketplace/64941ac1-4ad3-48ba-9e53-98e2ff0a22a2/data-lime-bike-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/lime/`
**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 free bike status

Returns real-time location and status of all available Lime bikes and scooters in a region. Each vehicle includes coordinates, reservation/disabled status, vehicle type, and rental URIs. Response can contain thousands of vehicles for large regions.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `region` | string | Yes | Lime region identifier (e.g. 'washington_dc', 'new_york', 'chicago'). |

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

### Get gbfs discovery

Get the GBFS auto-discovery feed for a specific region. Returns the list of available feed URLs (system_information, station_information, station_status, free_bike_status) with their endpoints. Use this to discover which feeds are available for a region before calling specific feed endpoints.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `region` | string | Yes | Lime region identifier (e.g. 'washington_dc', 'new_york', 'chicago'). |

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

### Get station information

Returns static information about logical stations (virtual stations for dockless vehicles). Each region typically has a single virtual station with coordinates representing the region center.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `region` | string | Yes | Lime region identifier (e.g. 'washington_dc', 'new_york', 'chicago'). |

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

### Get station status

Returns real-time operational status of each station in a region, including number of available vehicles, dock availability, installation status, and whether the station is currently renting/returning.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `region` | string | Yes | Lime region identifier (e.g. 'washington_dc', 'new_york', 'chicago'). |

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

### Get system information

Returns static metadata about a Lime system/region including system ID, name, timezone, language, license URL, and attribution organization. Useful for identifying the operator and locale settings of a region.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `region` | string | Yes | Lime region identifier (e.g. 'washington_dc', 'new_york', 'chicago'). |

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

## 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.