Location Types
A location is a physical site where Bikeep hardware is installed. The location’s type determines what kind of devices it contains and how they behave together. Understanding location types is essential for querying the right devices and building the correct user flows.
Overview
Bikeep locations fall into two categories: parking (devices that secure a user’s vehicle) and enclosed spaces (shared rooms with controlled access). Every location type includes at least one GUARD device — the IoT gateway that provides cloud connectivity and distributes allowlists to all child devices at the location.
Parking Locations
| Location Type | Devices Inside | Description |
|---|---|---|
BIKE_LOCKERS |
GUARD + one or more LOCKER |
Individual enclosed lockers |
BIKE_DOCKS |
GUARD + one or more BIKE_DOCK |
Outdoor bicycle parking docks |
SCOOTER_DOCKS |
GUARD + one or more SCOOTER_DOCK |
Outdoor scooter parking docks |
SCOOTER_DOCKS_V2 |
GUARD + one or more SCOOTER_DOCK |
Newer-generation outdoor scooter parking docks |
Enclosed Space Locations
| Location Type | Devices Inside | Description |
|---|---|---|
BIKE_HOUSE |
GUARD + one or more BIKE_HOUSE_DOOR + LOCKER or BIKE_DOCK |
Enclosed bike room with gateway, one or more entrance doors, and optional interior devices (lockers or bike docks) |
BIKE_HOUSE_DOCKLESS |
GUARD + one or more BIKE_HOUSE_DOOR |
Enclosed room with gateway and one or more entrance doors, no interior docks or lockers |
BIKE_HANGAR |
GUARD + BIKE_HOUSE_DOOR |
Outdoor enclosed structure (hangar) with gateway and typically one door |
BIKE_LOCKERS
Individual enclosed lockers, each controlled independently. This is the most common type for secure bicycle storage.
Physical description: A row or bank of metal lockers, each large enough for a bicycle. Each locker has its own electronic lock and RFID reader.
Devices: Each locker is a LOCKER device. A location with 20 lockers has 20 devices.
Key behaviors:
- Each locker operates independently — locking one doesn’t affect others
- RFID cards can be whitelisted per-guard (effectively per-location)
- Supports booking with configurable timeout
Typical API flow: See Locker & Dock Integration.
BIKE_HOUSE
An enclosed bike room secured by one or more electronically controlled doors, optionally containing individual lockers inside.
Physical description: A room or container-like structure with walls, a roof, and one or more entry doors. Inside, there may be individual lockers, bike docks, or simply open floor space with bike racks.
Devices:
GUARD— IoT gateway (parent controller, allowlist storage and distribution)BIKE_HOUSE_DOOR— entrance door (RFID reader + electronic lock, supportsunlockcommand)LOCKER— individual lockers inside the room (optional)BIKE_DOCK— mechanical parking arms inside the room (optional, alternative to LOCKERs)
Key behaviors:
- The entrance door (
BIKE_HOUSE_DOOR) supports both RFID card access and/or APIunlockcommands - Allowlists target the GUARD (or location), and the GUARD distributes keys to all children (BIKE_HOUSE_DOORs + interior devices)
- If the bike house contains interior devices (LOCKERs or BIKE_DOCKs), users first open the door, then interact with individual devices
Typical API flow: See Bike House (with Docks/Lockers) Integration.
BIKE_HOUSE_DOCKLESS
An enclosed room with door access control but no interior storage devices. Users park their bikes freely on the floor or in non-electronic racks.
Devices: GUARD (IoT gateway) + one or more BIKE_HOUSE_DOOR (entrances).
Key difference from BIKE_HOUSE: There are no interior storage devices — the only user-facing devices are the BIKE_HOUSE_DOOR(s).
Typical API flow: See Bike House (Dockless) Integration.
BIKE_HANGAR
An outdoor enclosed structure (like a shipping container or shelter) with controlled door access. Functionally similar to BIKE_HOUSE_DOCKLESS but designed for outdoor installation.
Devices: GUARD (IoT gateway) + one or more BIKE_HOUSE_DOOR (entrances).
Typical API flow: See Bike House (Dockless) Integration.
BIKE_DOCKS
Outdoor bicycle parking docks — the classic Bikeep product. Each dock is an individual BIKE_DOCK device with a mechanical locking arm.
Physical description: A row of outdoor parking stations, each with a locking arm that secures a bicycle’s wheel or frame.
Devices: Each dock is a BIKE_DOCK device.
Key behaviors:
- Docks support
lock,unlock,book, andcancel-booking - Same RFID and whitelist behavior as lockers
SCOOTER_DOCKS
Outdoor scooter parking docks. Physically adapted for scooter form factors but functionally similar to BIKE_DOCKS.
Devices: Each dock is a SCOOTER_DOCK device.
SCOOTER_DOCKS_V2
Newer-generation outdoor scooter parking. Uses the same SCOOTER_DOCK device type with the same commands (lock, unlock, book) and state machine as SCOOTER_DOCKS. The V2 designation refers to the hardware generation, not API differences — your integration code handles both location types identically.
Devices: Each dock is a SCOOTER_DOCK device.
Location Response Fields
When you query a location, these fields help you understand its configuration:
| Field | Description |
|---|---|
id |
UUID identifier |
name |
Display name for the location (built from code + label) — the primary field to show end users |
label |
Human-readable label component of the name |
code |
Short location code component of the name (useful for support/reference) |
type |
One of the location types above |
status |
Operational status (see table below) |
connection |
Connectivity (online, partially_online, offline, unknown) |
offline_since |
RFC 3339 timestamp of when the location went offline (null if online) — useful for monitoring and alerting |
devices.total |
Total number of devices at the location |
devices.available |
Number of usable devices (available AND online) |
devices.online |
Number of devices with connectivity |
has_access_lists |
Whether access lists have been configured |
booking_available |
Whether booking is enabled — useful for showing/hiding booking UI in your app * |
free_of_charge |
Whether usage is free — useful for showing/hiding payment UI in your app * |
address |
Physical street address |
latitude, longitude |
GPS coordinates |
*
booking_availableandfree_of_chargeare available on the single-location endpoint (GET /locations/{id}) but not the list endpoint (GET /locations).
Location Status Values
| Status | Description |
|---|---|
IN_HOUSE |
Not yet deployed — still at Bikeep’s facility |
IN_DELIVERY |
In transit / shipped out from Bikeep |
INSTALLED |
Physically installed but not yet launched |
DEMO |
Demonstration unit for evaluation purposes |
LAUNCHED |
Operational — the primary status integrators will see |
LAUNCHED_OFFLINE |
Bikeep Lite station — operates without internet connectivity (RFID-only, no API control) |
MAINTENANCE |
Under maintenance — temporarily out of service |
OBSOLETE |
Decommissioned — no longer in service |
Note: Most integrators will primarily encounter
LAUNCHEDandMAINTENANCElocations. Filter forLAUNCHEDto show only active, operational locations to end users.