> ## Documentation Index > Fetch the complete documentation index at: https://docs.gabin.ai/llms.txt > Use this file to discover all available pages before exploring further. # Search buildings in an area > Buildings (BDNB) in one area, ordered by id: a bounding box (`bbox`, at most 4 km²), a circle (`lat`, `lon`, `radius` up to 1,000 m), a city (`insee`) or a district (`iris`). Optional filters: `usage`, `built_after`, `built_before`, `dpe`, `min_companies`. `format=geojson` returns a GeoJSON FeatureCollection in `data` (points, or footprints with `geometry=footprint`), ready for a map source; pagination stays in `meta`. The total is counted on the first page (up to 10,000) and carried by the cursor. A filtered search over a large city can take too long (`TIMEOUT`): use a bbox or a district. To draw many buildings on a map, use GET /v1/tiles/buildings/{z}/{x}/{y}.pbf. Next: GET /v1/buildings/{id}. ## OpenAPI ````yaml https://api.gabin.ai/v1/openapi.json get /v1/buildings openapi: 3.1.0 info: title: Gabin API version: 1.0.0 description: >- French company and real-estate data for builders: companies (SIRENE, RNE), establishments, officers, annual accounts, buildings (BDNB), parcels, addresses, zones, multi-criteria search, vector tiles, reference data. Guides: https://docs.gabin.ai. **Authentication.** Every endpoint except `/v1/health` and `/v1/openapi.json` requires `Authorization: Bearer `: an API key (`gab_live_…`, created at https://gabin.ai/compte/api) or an OAuth access token (`gat_…`, MCP connectors). **Limits (free plan).** 60 weighted requests per minute and 5,000 units per UTC day per account. A request weighs 1 unless its endpoint states otherwise. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`, `X-Quota-Remaining` and `X-Request-Id`. **Responses.** Success: `{ "data": …, "meta": { … } }`. Lists are paginated by an opaque cursor (`meta.page.next_cursor`, up to 100 per page and 10,000 results per query). Errors: `{ "error": { "code", "message", "docs_url" } }`. Dates are ISO 8601, amounts in euros, areas in m², coordinates WGS84 `[lon, lat]`. **Data rules.** Companies under SIRENE partial diffusion are returned without the person's name, street address, position or building. Officers come from public registers only (name, first names, month and year of birth, mandates), without contact details. No contact data is exposed. contact: name: Gabin url: https://gabin.ai servers: - url: https://api.gabin.ai security: - bearerAuth: [] tags: - name: Companies description: >- Companies (SIRENE legal units): search with filters, profile, establishments, officers, annual accounts. - name: Establishments description: Establishments (SIRENE), by SIRET. - name: Officers description: >- Company officers from public registers (RNE): search by name, mandates, relationships. - name: Reference data description: >- Values accepted by the filters: NAF activities, legal form families, headcount ranges. - name: Account description: 'The account behind the API key: plan, limits, remaining quota.' - name: Meta description: Service status and OpenAPI document. No authentication. - name: Buildings description: >- French buildings (BDNB): profile, linked companies, sections (energy, transactions, owners, condominium, parcels, parking, permits, fiber, planning, market) and geographic search. - name: Parcels description: 'Cadastral parcels: boundary, area, buildings.' - name: Addresses description: >- Address geocoding (Base Adresse Nationale) with the BDNB building at the address, and named places. - name: Zones description: >- Cities, districts (merged IRIS), departments, and market figures of a zone (prices, rents, demography, income). - name: Search description: >- Multi-criteria search on buildings or companies in a zone: a catalog of fields, AND conditions, OR groups. - name: Tiles description: Vector tiles (Mapbox Vector Tile) of the gabin.ai map layers. paths: /v1/buildings: get: tags: - Buildings summary: Search buildings in an area description: >- Buildings (BDNB) in one area, ordered by id: a bounding box (`bbox`, at most 4 km²), a circle (`lat`, `lon`, `radius` up to 1,000 m), a city (`insee`) or a district (`iris`). Optional filters: `usage`, `built_after`, `built_before`, `dpe`, `min_companies`. `format=geojson` returns a GeoJSON FeatureCollection in `data` (points, or footprints with `geometry=footprint`), ready for a map source; pagination stays in `meta`. The total is counted on the first page (up to 10,000) and carried by the cursor. A filtered search over a large city can take too long (`TIMEOUT`): use a bbox or a district. To draw many buildings on a map, use GET /v1/tiles/buildings/{z}/{x}/{y}.pbf. Next: GET /v1/buildings/{id}. operationId: listBuildings parameters: - name: cursor in: query required: false description: >- Cursor returned in `meta.page.next_cursor` by the previous page. Keep the same filters; the page size is the one of the first page. schema: type: string maxLength: 300 - name: limit in: query required: false description: Results per page, 1 to 100. Default 20. schema: default: 20 type: integer minimum: 1 maximum: 100 - name: bbox in: query required: false description: >- Bounding box "minLon,minLat,maxLon,maxLat" (WGS84), at most 4 km² (2 km × 2 km). Example: "4.876,45.765,4.886,45.771". schema: type: string maxLength: 120 - name: lat in: query required: false description: >- Latitude of the center of a circle search (WGS84), with `lon` and `radius`. schema: type: number minimum: -90 maximum: 90 - name: lon in: query required: false description: >- Longitude of the center of a circle search (WGS84), with `lat` and `radius`. schema: type: number minimum: -180 maximum: 180 - name: radius in: query required: false description: 'Radius of the circle search, in meters, 1 to 1,000. Example: 300.' schema: type: number minimum: 1 maximum: 1000 - name: insee in: query required: false description: 'INSEE code of a city or arrondissement. Example: "69266".' schema: type: string pattern: ^(\d{5}|2[AaBb]\d{3})$ - name: iris in: query required: false description: 'IRIS code of a district (9 characters). Example: "692660101".' schema: type: string pattern: ^(\d{5}|2[AaBb]\d{3})\d{4}$ - name: usage in: query required: false description: >- Main uses, comma-separated: residential, tertiary, industrial, mixed. Example: "residential,mixed". schema: type: string maxLength: 80 - name: built_after in: query required: false description: 'Built in or after this year. Example: 1990.' schema: type: integer minimum: 1000 maximum: 2100 - name: built_before in: query required: false description: 'Built in or before this year. Example: 1974.' schema: type: integer minimum: 1000 maximum: 2100 - name: dpe in: query required: false description: 'Energy classes, comma-separated. Example: "F,G".' schema: type: string maxLength: 20 - name: min_companies in: query required: false description: >- At least this many linked companies (same count as `companies_count`). Example: 1. schema: type: integer minimum: 1 maximum: 1000 - name: format in: query required: false description: >- `json` (default): a list of objects in `data`. `geojson`: `data` is a GeoJSON FeatureCollection (same pagination in `meta`). schema: default: json type: string enum: - json - geojson - name: geometry in: query required: false description: >- With `format=geojson`: `point` (default, the building center) or `footprint` (polygon). schema: default: point type: string enum: - point - footprint responses: '200': description: OK headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Quota-Remaining: $ref: '#/components/headers/X-Quota-Remaining' content: application/json: schema: type: object required: - data - meta properties: data: anyOf: - type: array items: $ref: '#/components/schemas/BuildingSummary' - type: object properties: type: type: string const: FeatureCollection features: type: array items: type: object properties: type: type: string const: Feature id: type: string description: Same as `properties.id`. geometry: anyOf: - type: object properties: type: type: string const: Point coordinates: type: array prefixItems: - type: number - type: number items: false minItems: 2 maxItems: 2 description: >- WGS84 coordinates `[lon, lat]`. Example: [4.8795, 45.7665]. required: - type - coordinates description: GeoJSON Point, WGS84. - type: object properties: type: type: string enum: - Polygon - MultiPolygon coordinates: type: array items: {} description: >- GeoJSON coordinates: rings of `[lon, lat]` positions (WGS84). required: - type - coordinates description: GeoJSON Polygon or MultiPolygon, WGS84. description: >- GeoJSON geometry (Point, Polygon or MultiPolygon), WGS84. properties: $ref: '#/components/schemas/BuildingSummary' required: - type - id - geometry - properties required: - type - features description: >- Buildings as a GeoJSON FeatureCollection; `properties` is a building summary. description: >- A list of building summaries, or a FeatureCollection with `format=geojson`. meta: $ref: '#/components/schemas/PageMeta' example: data: - id: bdnb-bg-CJ69-HW8G-PTTG gabin_url: >- https://gabin.ai/batiment/40-rue-de-bruxelles-69100-villeurbanne-bdnb-bg-CJ69-HW8G-PTTG address: 40 Rue de Bruxelles, 69100 Villeurbanne insee: '69266' iris: '692660101' usage: residential construction_year: 1934 levels: 7 housing_units: 42 ground_area_m2: 612 dpe_class: D companies_count: 2 center: - 4.8795 - 45.7665 meta: page: next_cursor: null limit: 20 total: 1 total_kind: exact '400': description: INVALID, PAGINATION_LIMIT headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID: value: error: code: INVALID message: 'limit: Too big: expected number to be <=100' docs_url: https://docs.gabin.ai/errors#invalid PAGINATION_LIMIT: value: error: code: PAGINATION_LIMIT message: >- At most 10,000 results can be reached for one query. Narrow the filters. docs_url: https://docs.gabin.ai/errors#pagination_limit '401': description: UNAUTHENTICATED headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/Error' examples: UNAUTHENTICATED: value: error: code: UNAUTHENTICATED message: Invalid or revoked API key. docs_url: https://docs.gabin.ai/errors#unauthenticated '429': description: RATE_LIMITED, QUOTA_EXCEEDED headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMITED: value: error: code: RATE_LIMITED message: >- Rate limit reached (60 weighted requests per minute). Retry in 12 s. docs_url: https://docs.gabin.ai/errors#rate_limited QUOTA_EXCEEDED: value: error: code: QUOTA_EXCEEDED message: >- Daily quota reached (5000 units per UTC day). It resets at 00:00 UTC. docs_url: https://docs.gabin.ai/errors#quota_exceeded '503': description: TIMEOUT, BUSY headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/Error' examples: TIMEOUT: value: error: code: TIMEOUT message: The query took too long. Narrow it down and retry. docs_url: https://docs.gabin.ai/errors#timeout BUSY: value: error: code: BUSY message: >- The API is serving too many database requests right now. Retry in 1 s. docs_url: https://docs.gabin.ai/errors#busy components: headers: X-Request-Id: description: Unique id of the request; quote it when contacting support. schema: type: string X-RateLimit-Limit: description: Weighted requests allowed per minute for the account. schema: type: integer X-RateLimit-Remaining: description: Weighted requests left in the current minute. schema: type: integer X-RateLimit-Reset: description: Seconds until the per-minute window resets. schema: type: integer X-Quota-Remaining: description: Units left in the daily quota (UTC day). schema: type: integer Retry-After: description: Seconds to wait before retrying. schema: type: integer schemas: BuildingSummary: type: object properties: id: type: string maxLength: 40 pattern: ^bdnb-[a-z]{2,4}-[A-Za-z0-9]{4}(-[A-Za-z0-9]{4})*$ description: >- BDNB building id (`batiment_groupe_id`). Example: "bdnb-bg-CJ69-HW8G-PTTG". gabin_url: type: string description: Page of the building on the gabin.ai map. address: description: Main address (BAN); null when the building has none. type: - string - 'null' insee: description: INSEE code of the city. type: - string - 'null' iris: description: IRIS code (INSEE statistical unit) of the building. type: - string - 'null' usage: anyOf: - type: string enum: - residential - tertiary - industrial - mixed - type: 'null' description: >- Main use (BDNB): residential, tertiary (offices, shops, public facilities), industrial (industry, warehouses), mixed. Null when unknown or for outbuildings and farm buildings. construction_year: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Construction year (land files). levels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Number of levels (land files). housing_units: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Number of dwellings (land files). ground_area_m2: description: Footprint area, in m². type: - number - 'null' dpe_class: anyOf: - type: string enum: - A - B - C - D - E - F - G - type: 'null' description: >- Energy class (DPE) of the representative housing certificate, A to G. Null when none. companies_count: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Legal entities whose establishment is matched to the building by exact address. Can be lower than the list of GET /v1/buildings/{id}/companies, which also uses position matches and owners. center: type: array prefixItems: - type: number - type: number items: false minItems: 2 maxItems: 2 description: A point inside the footprint, WGS84 `[lon, lat]`. required: - id - gabin_url - address - insee - iris - usage - construction_year - levels - housing_units - ground_area_m2 - dpe_class - companies_count - center description: A building in a list. PageMeta: type: object properties: page: type: object properties: next_cursor: description: >- Opaque cursor for the next page: pass it as `cursor` with the same filters. Null on the last page or once 10,000 results have been reached. type: - string - 'null' limit: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Page size used for this response. required: - next_cursor - limit total: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Number of matching results, qualified by `total_kind`. Example: 8337. total_kind: type: string enum: - exact - lower_bound - estimate description: >- `exact`: counted. `lower_bound`: at least this many (counting stopped). `estimate`: database planner estimate, can be off by a few percent. required: - page - total - total_kind description: Pagination metadata of a list response. Error: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHENTICATED - FORBIDDEN - NOT_FOUND - INVALID - ZONE_REQUIRED - PAGINATION_LIMIT - RATE_LIMITED - QUOTA_EXCEEDED - TIMEOUT - BUSY - INTERNAL description: Stable machine-readable code. message: type: string description: Human-readable explanation, in English. docs_url: type: string description: Documentation page for this error code. required: - code - message - docs_url required: - error description: Error body. The HTTP status matches `error.code`. securitySchemes: bearerAuth: type: http scheme: bearer description: API key `gab_live_…` or OAuth access token `gat_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.