Run a multi-criteria search
curl --request POST \
--url https://api.gabin.ai/v1/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conditions": [],
"any_of": [],
"limit": 20,
"cursor": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({conditions: [], any_of: [], limit: 20, cursor: '<string>'})
};
fetch('https://api.gabin.ai/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gabin.ai/v1/search"
payload = {
"conditions": [],
"any_of": [],
"limit": 20,
"cursor": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": [
{
"type": "building",
"id": "<string>",
"address": "<string>",
"city": "<string>",
"usage": "<string>",
"construction_year": 0,
"housing_units": 0,
"dpe_class": "A",
"gabin_url": "<string>"
}
],
"meta": {
"page": {
"next_cursor": "<string>",
"limit": 0
},
"total": 0,
"total_kind": "exact"
}
}Search
Run a multi-criteria search
Lists the buildings or companies (registered offices) matching a search, in a stable order, paginated by cursor (pass `meta.page.next_cursor` as `cursor` with the same filters). `meta.total` is a lower bound while pages remain: POST /v1/search/count gives the total.
A search has a `target` (`buildings` or `companies`), a `zone` (city, district, postal code; department for buildings only), `conditions` that all apply (AND) and optional `any_of` groups (at least one condition of each group applies). Each condition names a field from GET /v1/search/fields and gives `values`, or `min`/`max`, according to the field's `operator`.
Example: {"target": "buildings", "zone": {"type": "city", "code": "69266"}, "conditions": [{"field": "batiment.annee_construction", "max": 1974}, {"field": "dpe.classe", "values": ["F", "G"]}]}
Weight: 5 (counts 5× against the rate limit and the daily quota).
POST
/
v1
/
search
Run a multi-criteria search
curl --request POST \
--url https://api.gabin.ai/v1/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conditions": [],
"any_of": [],
"limit": 20,
"cursor": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({conditions: [], any_of: [], limit: 20, cursor: '<string>'})
};
fetch('https://api.gabin.ai/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gabin.ai/v1/search"
payload = {
"conditions": [],
"any_of": [],
"limit": 20,
"cursor": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": [
{
"type": "building",
"id": "<string>",
"address": "<string>",
"city": "<string>",
"usage": "<string>",
"construction_year": 0,
"housing_units": 0,
"dpe_class": "A",
"gabin_url": "<string>"
}
],
"meta": {
"page": {
"next_cursor": "<string>",
"limit": 0
},
"total": 0,
"total_kind": "exact"
}
}Authorizations
API key gab_live_… or OAuth access token gat_….
Body
application/json
buildings returns BDNB buildings; companies returns registered offices.
Available options:
buildings, companies All conditions apply (AND). Empty: everything in the zone.
Maximum array length:
12Show child attributes
Show child attributes
OR groups: at least one condition of each group applies. Up to 4 groups, 12 conditions in total.
Maximum array length:
4Show child attributes
Show child attributes
Results per page, 1 to 100. Default 20.
Required range:
1 <= x <= 100Area searched. Required: without it (whole France), and for companies in a whole department, the search is refused with ZONE_REQUIRED.
Show child attributes
Show child attributes
meta.page.next_cursor of the previous page, with the same filters.
Maximum string length:
400⌘I