Skip to main content
GET
Get the market summary around a building

Authorizations

Authorization
string
header
required

API key gab_live_… or OAuth access token gat_….

Path Parameters

id
string
required

BDNB building id (batiment_groupe_id). Example: "bdnb-bg-CJ69-HW8G-PTTG".

Maximum string length: 40
Pattern: ^bdnb-[a-z]{2,4}-[A-Za-z0-9]{4}(-[A-Za-z0-9]{4})*$

Response

OK

data
object
required

Market summary around the building. Full series: GET /v1/zones/{level}/{code}/market.

meta
object
required

Empty for a single resource.