Skip to main content
GET
List establishments in an area

Authorizations

Authorization
string
header
required

API key gab_live_… or OAuth access token gat_….

Query Parameters

cursor
string

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.

Maximum string length: 300
limit
integer
default:20

Results per page, 1 to 100. Default 20.

Required range: 1 <= x <= 100
insee
string

INSEE code of a city or of a Paris, Lyon or Marseille arrondissement; the city code of Paris (75056), Lyon (69123) or Marseille (13055) covers all its arrondissements. Example: "69266".

Pattern: ^(\d{5}|2[AaBb]\d{3})$
department
string

Department code. Example: "69", "2A", "974".

Pattern: ^(\d{2,3}|2[AaBb])$
iris
string

IRIS code of a district (9 characters). Example: "692660101".

Pattern: ^(\d{5}|2[AaBb]\d{3})\d{4}$
bbox
string

Bounding box "minLon,minLat,maxLon,maxLat" (WGS84), at most 4 km² (2 km × 2 km). Example: "4.876,45.765,4.886,45.771".

Maximum string length: 120
lat
number

Latitude of the center of a circle (WGS84), with lon and radius.

Required range: -90 <= x <= 90
lon
number

Longitude of the center of a circle (WGS84), with lat and radius.

Required range: -180 <= x <= 180
radius
number

Radius of the circle, in meters, 1 to 1,000. Example: 300.

Required range: 1 <= x <= 1000
naf
string

Activities of the establishment, comma-separated, up to 20: NAF rev. 2 sub-classes ("43.29A"), divisions ("47") or sections ("G"). See GET /v1/naf. Example: "43.22A,43.22B".

Maximum string length: 200
headcount
enum<string>

INSEE headcount range code of the establishment. See GET /v1/headcount-ranges. Example: "11" (10 to 19 employees).

Available options:
11,
12,
21,
22,
31,
32,
41,
42,
51,
52,
53,
NN,
00,
01,
02,
03
headquarters_only
enum<string>

Registered offices only. Default false.

Available options:
0,
1,
true,
false
include_closed
enum<string>

Include closed establishments. Default false: open establishments only.

Available options:
0,
1,
true,
false
format
enum<string>
default:json

json (default): a list of objects in data. geojson: data is a GeoJSON FeatureCollection (same pagination in meta).

Available options:
json,
geojson

Response

OK

data
object
required

An establishment in an area, with the name and legal form of its company.

meta
object
required

Pagination metadata of a list response.