# French Bike-Share & Shared Mobility Live (GBFS) (`vigilant_jasmine/french-gbfs-shared-mobility-live`) Actor

Live station availability for Velib and any GBFS bike or scooter sharing system. Get bikes, e-bikes, free docks, capacity and coordinates per station in real time from official GBFS feeds. Free and key-free - ideal for mobility apps, dashboards and monitoring.

- **URL**: https://apify.com/vigilant\_jasmine/french-gbfs-shared-mobility-live.md
- **Developed by:** [DEV DEV](https://apify.com/vigilant_jasmine) (community)
- **Categories:** Travel, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## French Bike-Share & Shared Mobility Live (GBFS)

### What it does

**French Bike-Share & Shared Mobility Live** reads any **GBFS** feed (General Bikeshare Feed Specification) and returns **real-time station availability**: how many bikes, e-bikes and free docks are available at each station, right now. It ships preconfigured for **Vélib' Métropole** (Paris *vélos en libre-service*) but works with any GBFS v1/v2/v3 system — bikes, e-bikes or scooters — across France and the EU. No API key, no scraping: GBFS is the open, official standard published by the operators themselves. This actor is **free** — you only pay for your own Apify platform usage.

### Input

| Field | Type | Description |
|---|---|---|
| `systems` | array of strings | GBFS auto-discovery URLs (each system's `gbfs.json`). |
| `onlyWithBikes` | boolean | If true, skip stations that currently have 0 bikes. Default `false`. |
| `maxResults` | integer | Max station records across all systems (default 5000). |

```json
{
  "systems": ["https://velib-metropole-opendata.smovengo.cloud/opendata/Velib_Metropole/gbfs.json"],
  "onlyWithBikes": false,
  "maxResults": 60
}
````

### Output

One dataset item per station. Example:

```json
{
  "system": "https://velib-metropole-opendata.smovengo.cloud/opendata/Velib_Metropole/gbfs.json",
  "status": "found",
  "station_id": 213688169,
  "name": "Benjamin Godard - Victor Hugo",
  "lat": 48.865983,
  "lon": 2.275725,
  "capacity": 35,
  "bikes_available": 4,
  "docks_available": 30,
  "ebikes_available": 1,
  "mechanical_available": 3,
  "is_renting": true,
  "is_returning": true,
  "is_installed": true,
  "last_reported": "2026-07-11T08:41:26.000Z"
}
```

Unreachable systems return `{"status": "error"}` with a message; empty systems return `{"status": "not_found"}` — the actor never crashes on one bad feed.

### Use cases

- Monitor live bike/scooter availability for a mobility app, dashboard or alert.
- Build a historical time-series by scheduling this actor every few minutes.
- Compare availability and capacity across stations, cities or operators.
- Feed routing / trip-planning tools with up-to-the-minute supply data.

### Limitations & fair use

- Availability freshness depends on each operator's GBFS `ttl`; poll responsibly.
- Station names/coordinates come from `station_information`; systems without it still return live counts.
- The actor adds a short delay between systems to stay polite to the feeds.

### More actors by this developer

Part of a family of French open-data actors (SIRENE companies, BAN addresses, IGN cadastre, fuel prices, and more). See **[all actors by vigilant\_jasmine](https://apify.com/vigilant_jasmine)**.

# Actor input Schema

## `systems` (type: `array`):

List of GBFS auto-discovery URLs (the gbfs.json of each system). Works with Velib Metropole and any GBFS v1/v2/v3 bike or scooter sharing feed.

## `onlyWithBikes` (type: `boolean`):

If enabled, skip stations that currently have 0 bikes available.

## `maxResults` (type: `integer`):

Maximum number of station records to return across all systems.

## Actor input object example

```json
{
  "systems": [
    "https://velib-metropole-opendata.smovengo.cloud/opendata/Velib_Metropole/gbfs.json"
  ],
  "onlyWithBikes": false,
  "maxResults": 5000
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "systems": [
        "https://velib-metropole-opendata.smovengo.cloud/opendata/Velib_Metropole/gbfs.json"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("vigilant_jasmine/french-gbfs-shared-mobility-live").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "systems": ["https://velib-metropole-opendata.smovengo.cloud/opendata/Velib_Metropole/gbfs.json"] }

# Run the Actor and wait for it to finish
run = client.actor("vigilant_jasmine/french-gbfs-shared-mobility-live").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "systems": [
    "https://velib-metropole-opendata.smovengo.cloud/opendata/Velib_Metropole/gbfs.json"
  ]
}' |
apify call vigilant_jasmine/french-gbfs-shared-mobility-live --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=vigilant_jasmine/french-gbfs-shared-mobility-live",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "French Bike-Share & Shared Mobility Live (GBFS)",
        "description": "Live station availability for Velib and any GBFS bike or scooter sharing system. Get bikes, e-bikes, free docks, capacity and coordinates per station in real time from official GBFS feeds. Free and key-free - ideal for mobility apps, dashboards and monitoring.",
        "version": "0.0",
        "x-build-id": "ie9EUINFxbdhQy9iZ"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/vigilant_jasmine~french-gbfs-shared-mobility-live/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-vigilant_jasmine-french-gbfs-shared-mobility-live",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/vigilant_jasmine~french-gbfs-shared-mobility-live/runs": {
            "post": {
                "operationId": "runs-sync-vigilant_jasmine-french-gbfs-shared-mobility-live",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/vigilant_jasmine~french-gbfs-shared-mobility-live/run-sync": {
            "post": {
                "operationId": "run-sync-vigilant_jasmine-french-gbfs-shared-mobility-live",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "systems"
                ],
                "properties": {
                    "systems": {
                        "title": "GBFS systems",
                        "type": "array",
                        "description": "List of GBFS auto-discovery URLs (the gbfs.json of each system). Works with Velib Metropole and any GBFS v1/v2/v3 bike or scooter sharing feed.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "onlyWithBikes": {
                        "title": "Only stations with bikes available",
                        "type": "boolean",
                        "description": "If enabled, skip stations that currently have 0 bikes available.",
                        "default": false
                    },
                    "maxResults": {
                        "title": "Max stations",
                        "minimum": 1,
                        "type": "integer",
                        "description": "Maximum number of station records to return across all systems.",
                        "default": 5000
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
