RepromptDocs

Entrances API

Get entrances, access points, and building data for any address

Overview

Given an address, the Entrances API returns the exact location of every entrance, what access points you need to pass through, and the building and compound context.

Response
├── place_name, address, lat/lng
├── entrances[]         shared and unit entrances to the place
├── access_points[]     gates / checkpoints to reach it
├── building {}         type, geofence, floor count
└── compound {} | null  compound context, if inside one

Most responses have compound: null — the address maps to a standalone building. When the building sits inside a compound (mall, campus, gated community), the compound field provides the boundary, type, and ID you can use to fetch the full compound view.


Request

POST /v1/entrances
curl -X POST \
  'https://api.repromptai.com/v1/entrances' \
  -H 'Authorization: Bearer {YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "7 Carmine St, New York, NY 10014",
    "name": "Joes Pizza",
    "latitude": 40.7359,
    "longitude": -73.9911
  }'

Request Fields

FieldTypeRequiredDescription
addressstringYesFull street address
namestringNoPlace or business name — helps locate the right building within a compound
latitudenumberNoLatitude (-90 to 90) — improves geocoding accuracy
longitudenumberNoLongitude (-180 to 180) — improves geocoding accuracy

Response Example

{
  "place_name": "Joes Pizza",
  "address": "7 Carmine St, New York, NY 10014",
  "latitude": 40.7359,
  "longitude": -73.9911,
  "entrances": [
    {
      "entrance_id": "ent_main_01",
      "entrance_type": "MAIN",
      "entrance_scope": "SHARED",
      "latitude": 40.7359,
      "longitude": -73.9911,
      "name": "Front entrance",
      "floor": 0,
      "tags": ["wheelchair_accessible"],
      "preferred_parking": [],
      "unit": null
    },
    {
      "entrance_id": "ent_svc_01",
      "entrance_type": "SERVICE",
      "entrance_scope": "UNIT",
      "latitude": 40.7358,
      "longitude": -73.9913,
      "name": "Service entrance",
      "floor": 0,
      "tags": [],
      "preferred_parking": [],
      "unit": "Suite 1A"
    }
  ],
  "access_points": [
    {
      "access_point_id": "ap_001",
      "access_type": "VEHICLE_ENTRY",
      "access_control": "OPEN",
      "latitude": 40.7358,
      "longitude": -73.9912,
      "name": "Main parking entrance",
      "operating_hours": { "open": "06:00", "close": "23:00" },
      "tags": ["parking"]
    },
    {
      "access_point_id": "ap_002",
      "access_type": "PEDESTRIAN_ENTRY",
      "access_control": "OPEN",
      "latitude": 40.7360,
      "longitude": -73.9910,
      "name": "Carmine St pedestrian entrance",
      "operating_hours": null,
      "tags": []
    }
  ],
  "building": {
    "building_type": "COMMERCIAL",
    "building_geofence": {
      "type": "Polygon",
      "coordinates": [[[-73.9913, 40.7358], [-73.9909, 40.7358], [-73.9909, 40.7361], [-73.9913, 40.7361], [-73.9913, 40.7358]]]
    },
    "floor_count": 2
  },
  "compound": {
    "compound_id": "cmp_abc123",
    "compound_name": "Carmine Street Plaza",
    "compound_type": "MIXED_USE_COMPLEX",
    "compound_geofence": {
      "type": "Polygon",
      "coordinates": [[[-73.9915, 40.7356], [-73.9907, 40.7356], [-73.9907, 40.7362], [-73.9915, 40.7362], [-73.9915, 40.7356]]]
    }
  }
}

Compound View

Retrieve all buildings, entrances, and access points within a compound.

GET /v1/compounds/{compound_id}

Returns the full compound hierarchy: every building, entrance, and access point within the compound boundary. The compound_id is returned in the entrances response above.


Schema Reference

Top-Level Response

FieldTypeDescription
place_namestringResolved place or address name
addressstringFull street address
latitudenumberLatitude of the place
longitudenumberLongitude of the place
entrancesEntrance[]Entrances to this place
access_pointsAccessPoint[]Gates and checkpoints to reach this place
buildingBuildingBuilding metadata
compoundCompound | nullCompound context, if the building is inside one

Entrance

FieldTypeDescription
entrance_idstringUnique identifier
entrance_typeenumMAIN, SECONDARY, SERVICE, EMERGENCY, GATE
entrance_scopeenumUNIT (specific unit) or SHARED (common entrance)
latitudenumberEntrance latitude
longitudenumberEntrance longitude
namestring | nullHuman-readable label
floornumber | nullFloor level (0 = ground)
tagsstring[]Descriptive tags (e.g. wheelchair_accessible)
preferred_parkingParkingZone[]Nearby parking areas
unitstring | nullUnit number (when scope is UNIT)

Access Point

FieldTypeDescription
access_point_idstringUnique identifier
access_typeenumHow you physically enter (see below)
access_controlenumWhat controls entry (see below)
latitudenumberAccess point latitude
longitudenumberAccess point longitude
namestring | nullHuman-readable label
operating_hoursobject | null{ "open": "HH:MM", "close": "HH:MM" }
tagsstring[]Descriptive tags

Access Types

ValueDescription
GATEPhysical gate
VEHICLE_ENTRYVehicle-only entrance
PEDESTRIAN_ENTRYPedestrian-only entrance
SECURITY_CHECKPOINTStaffed security checkpoint
LOADING_DOCK_ENTRYLoading dock or service entrance

Access Control

ValueDescription
OPENNo restriction
BUZZERBuzzer/doorbell system
KEY_CODEKeypad code required
GUARDSecurity guard
RFIDRFID badge or fob
CALL_BOXCall box to contact tenant
INTERCOMIntercom system
NONENo access control present

Building

FieldTypeDescription
building_typeenumCategory of building (see below)
building_geofenceGeoJSON Polygon | nullBuilding footprint
floor_countnumber | nullNumber of floors

Building Types

RESIDENTIAL · COMMERCIAL · INDUSTRIAL · CIVIC · EDUCATION · MEDICAL · ENTERTAINMENT · RELIGIOUS · TRANSPORTATION · HOSPITALITY · MIXED_USE · AGRICULTURAL · MILITARY · UTILITY

Compound

FieldTypeDescription
compound_idstringUnique identifier (use with /v1/compounds/{compound_id})
compound_namestringDisplay name
compound_typeenumCategory of compound (see below)
compound_geofenceGeoJSON PolygonBoundary of the compound

Compound Types

ValueDescription
APARTMENT_COMPLEXResidential apartment complex
SHOPPING_MALLEnclosed shopping mall
STRIP_MALLOpen-air strip mall
OFFICE_PARKOffice park or business campus
HOSPITAL_CAMPUSHospital or medical campus
UNIVERSITY_CAMPUSUniversity or college campus
GATED_COMMUNITYGated residential community
MIXED_USE_COMPLEXMixed residential/commercial complex
INDUSTRIAL_PARKIndustrial or warehouse park

Parking Zone

FieldTypeDescription
parking_idstringUnique identifier
geometryGeoJSON Polygon | LineStringParking area boundary or curb line
notesstring | nullAdditional info (e.g. "2-hour limit")

On this page