{
  "openapi": "3.0.1",
  "info": {
    "title": "French Companies by Area - Official Sirene B2B Lists",
    "description": "Lists French companies from the official Sirene register (API Recherche d'entreprises) by postcode, city, department, region or radius, NAF code, headcount or creation date, returning SIREN, head office SIRET, address, GPS, NAF and size without personal data, charged per company listed.",
    "version": "1.0",
    "x-build-id": "SUVo7kUkhugLNtjML"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/edgarfinance~france-companies-by-area/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-edgarfinance-france-companies-by-area",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/edgarfinance~france-companies-by-area/runs": {
      "post": {
        "operationId": "runs-sync-edgarfinance-france-companies-by-area",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/edgarfinance~france-companies-by-area/run-sync": {
      "post": {
        "operationId": "run-sync-edgarfinance-france-companies-by-area",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "postalCodes": {
            "title": "Postcodes",
            "maxItems": 200,
            "type": "array",
            "description": "French postcodes (5 digits), for example 69003 or 88400. Use only one kind of area per run. Up to 200 postcodes.",
            "items": {
              "type": "string",
              "pattern": "^\\d{5}$"
            }
          },
          "cityCodes": {
            "title": "INSEE city codes",
            "maxItems": 200,
            "type": "array",
            "description": "INSEE commune codes (code officiel géographique, 5 characters), not postcodes: for example 69123 for Lyon, 75056 for Paris, 2A004 for Ajaccio. Paris, Lyon and Marseille codes include all their districts. Up to 200 codes.",
            "items": {
              "type": "string",
              "pattern": "^(\\d{5}|2[ABab]\\d{3})$"
            }
          },
          "departments": {
            "title": "Departments",
            "type": "array",
            "description": "French departments, by official code (01 to 95, 2A, 2B, 971 to 976). A whole department can hold tens of thousands of companies: combine it with an activity filter or set maxItems.",
            "items": {
              "type": "string",
              "enum": [
                "01",
                "02",
                "03",
                "04",
                "05",
                "06",
                "07",
                "08",
                "09",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "2A",
                "2B",
                "21",
                "22",
                "23",
                "24",
                "25",
                "26",
                "27",
                "28",
                "29",
                "30",
                "31",
                "32",
                "33",
                "34",
                "35",
                "36",
                "37",
                "38",
                "39",
                "40",
                "41",
                "42",
                "43",
                "44",
                "45",
                "46",
                "47",
                "48",
                "49",
                "50",
                "51",
                "52",
                "53",
                "54",
                "55",
                "56",
                "57",
                "58",
                "59",
                "60",
                "61",
                "62",
                "63",
                "64",
                "65",
                "66",
                "67",
                "68",
                "69",
                "70",
                "71",
                "72",
                "73",
                "74",
                "75",
                "76",
                "77",
                "78",
                "79",
                "80",
                "81",
                "82",
                "83",
                "84",
                "85",
                "86",
                "87",
                "88",
                "89",
                "90",
                "91",
                "92",
                "93",
                "94",
                "95",
                "971",
                "972",
                "973",
                "974",
                "976"
              ],
              "enumTitles": [
                "01 Ain",
                "02 Aisne",
                "03 Allier",
                "04 Alpes-de-Haute-Provence",
                "05 Hautes-Alpes",
                "06 Alpes-Maritimes",
                "07 Ardèche",
                "08 Ardennes",
                "09 Ariège",
                "10 Aube",
                "11 Aude",
                "12 Aveyron",
                "13 Bouches-du-Rhône",
                "14 Calvados",
                "15 Cantal",
                "16 Charente",
                "17 Charente-Maritime",
                "18 Cher",
                "19 Corrèze",
                "2A Corse-du-Sud",
                "2B Haute-Corse",
                "21 Côte-d'Or",
                "22 Côtes-d'Armor",
                "23 Creuse",
                "24 Dordogne",
                "25 Doubs",
                "26 Drôme",
                "27 Eure",
                "28 Eure-et-Loir",
                "29 Finistère",
                "30 Gard",
                "31 Haute-Garonne",
                "32 Gers",
                "33 Gironde",
                "34 Hérault",
                "35 Ille-et-Vilaine",
                "36 Indre",
                "37 Indre-et-Loire",
                "38 Isère",
                "39 Jura",
                "40 Landes",
                "41 Loir-et-Cher",
                "42 Loire",
                "43 Haute-Loire",
                "44 Loire-Atlantique",
                "45 Loiret",
                "46 Lot",
                "47 Lot-et-Garonne",
                "48 Lozère",
                "49 Maine-et-Loire",
                "50 Manche",
                "51 Marne",
                "52 Haute-Marne",
                "53 Mayenne",
                "54 Meurthe-et-Moselle",
                "55 Meuse",
                "56 Morbihan",
                "57 Moselle",
                "58 Nièvre",
                "59 Nord",
                "60 Oise",
                "61 Orne",
                "62 Pas-de-Calais",
                "63 Puy-de-Dôme",
                "64 Pyrénées-Atlantiques",
                "65 Hautes-Pyrénées",
                "66 Pyrénées-Orientales",
                "67 Bas-Rhin",
                "68 Haut-Rhin",
                "69 Rhône",
                "70 Haute-Saône",
                "71 Saône-et-Loire",
                "72 Sarthe",
                "73 Savoie",
                "74 Haute-Savoie",
                "75 Paris",
                "76 Seine-Maritime",
                "77 Seine-et-Marne",
                "78 Yvelines",
                "79 Deux-Sèvres",
                "80 Somme",
                "81 Tarn",
                "82 Tarn-et-Garonne",
                "83 Var",
                "84 Vaucluse",
                "85 Vendée",
                "86 Vienne",
                "87 Haute-Vienne",
                "88 Vosges",
                "89 Yonne",
                "90 Territoire de Belfort",
                "91 Essonne",
                "92 Hauts-de-Seine",
                "93 Seine-Saint-Denis",
                "94 Val-de-Marne",
                "95 Val-d'Oise",
                "971 Guadeloupe",
                "972 Martinique",
                "973 Guyane",
                "974 La Réunion",
                "976 Mayotte"
              ]
            }
          },
          "regions": {
            "title": "Regions",
            "type": "array",
            "description": "French regions, by official code (for example 11 = Ile-de-France, 84 = Auvergne-Rhone-Alpes).",
            "items": {
              "type": "string",
              "enum": [
                "01",
                "02",
                "03",
                "04",
                "06",
                "11",
                "24",
                "27",
                "28",
                "32",
                "44",
                "52",
                "53",
                "75",
                "76",
                "84",
                "93",
                "94"
              ],
              "enumTitles": [
                "01 Guadeloupe",
                "02 Martinique",
                "03 Guyane",
                "04 La Réunion",
                "06 Mayotte",
                "11 Île-de-France",
                "24 Centre-Val de Loire",
                "27 Bourgogne-Franche-Comté",
                "28 Normandie",
                "32 Hauts-de-France",
                "44 Grand Est",
                "52 Pays de la Loire",
                "53 Bretagne",
                "75 Nouvelle-Aquitaine",
                "76 Occitanie",
                "84 Auvergne-Rhône-Alpes",
                "93 Provence-Alpes-Côte d'Azur",
                "94 Corse"
              ]
            }
          },
          "latitude": {
            "title": "Latitude (radius search)",
            "minimum": -90,
            "maximum": 90,
            "type": "number",
            "description": "Latitude of the centre point in decimal degrees (WGS84), for example 45.7578. Use with longitude and radiusKm instead of the other area fields."
          },
          "longitude": {
            "title": "Longitude (radius search)",
            "minimum": -180,
            "maximum": 180,
            "type": "number",
            "description": "Longitude of the centre point in decimal degrees (WGS84), for example 4.8320."
          },
          "radiusKm": {
            "title": "Radius in km",
            "minimum": 0.1,
            "maximum": 50,
            "type": "number",
            "description": "Search radius around the point, from 0.1 to 50 km (limit of the public API). 5 km when left empty. Only with latitude and longitude."
          },
          "locationMatch": {
            "title": "Which address must be in the area",
            "enum": [
              "headOffice",
              "anyEstablishment"
            ],
            "type": "string",
            "description": "headOffice (default): list companies whose head office (siege) is in the area. anyEstablishment: also list companies based elsewhere that have an establishment in the area; that local establishment is returned in the localEstablishment* fields.",
            "default": "headOffice"
          },
          "nafCodes": {
            "title": "Activity codes (NAF / APE)",
            "maxItems": 100,
            "type": "array",
            "description": "French NAF rev. 2 activity codes. Accepts a subclass (56.10A or 5610A), a class (56.10), a group (56.1) or a division (56); broader codes are expanded to all their subclasses. Examples: 56.10A restaurants, 62.01Z software development, 43.22A plumbing, 86.23Z dentists. List: https://www.insee.fr/fr/information/2406147",
            "items": {
              "type": "string",
              "pattern": "^\\s*\\d{2}(\\.?\\d{1,2}[A-Za-z]?)?\\s*$"
            }
          },
          "nafSections": {
            "title": "Activity sections",
            "type": "array",
            "description": "Broad NAF sections (letters A to U). Ignored for codes already given in nafCodes, except that nafCodes outside these sections are dropped.",
            "items": {
              "type": "string",
              "enum": [
                "A",
                "B",
                "C",
                "D",
                "E",
                "F",
                "G",
                "H",
                "I",
                "J",
                "K",
                "L",
                "M",
                "N",
                "O",
                "P",
                "Q",
                "R",
                "S",
                "T",
                "U"
              ],
              "enumTitles": [
                "A Agriculture, forestry and fishing",
                "B Mining and quarrying",
                "C Manufacturing",
                "D Electricity, gas, steam and air conditioning supply",
                "E Water supply, sewerage, waste management",
                "F Construction",
                "G Wholesale and retail trade, repair of motor vehicles",
                "H Transportation and storage",
                "I Accommodation and food service",
                "J Information and communication",
                "K Financial and insurance activities",
                "L Real estate activities",
                "M Professional, scientific and technical activities",
                "N Administrative and support service activities",
                "O Public administration",
                "P Education",
                "Q Human health and social work",
                "R Arts, entertainment and recreation",
                "S Other service activities",
                "T Activities of households as employers",
                "U Extraterritorial organisations"
              ]
            }
          },
          "employeeRanges": {
            "title": "Headcount ranges",
            "type": "array",
            "description": "INSEE salaried headcount ranges (tranche d'effectif salarie), as declared in the register. NN means no salaried employee reported or unknown, which covers most very small companies.",
            "items": {
              "type": "string",
              "enum": [
                "NN",
                "00",
                "01",
                "02",
                "03",
                "11",
                "12",
                "21",
                "22",
                "31",
                "32",
                "41",
                "42",
                "51",
                "52",
                "53"
              ],
              "enumTitles": [
                "Unknown or no employee (NN)",
                "0 employees (00)",
                "1 to 2 (01)",
                "3 to 5 (02)",
                "6 to 9 (03)",
                "10 to 19 (11)",
                "20 to 49 (12)",
                "50 to 99 (21)",
                "100 to 199 (22)",
                "200 to 249 (31)",
                "250 to 499 (32)",
                "500 to 999 (41)",
                "1,000 to 1,999 (42)",
                "2,000 to 4,999 (51)",
                "5,000 to 9,999 (52)",
                "10,000 or more (53)"
              ]
            }
          },
          "companyCategories": {
            "title": "Company categories",
            "type": "array",
            "description": "INSEE size category: PME (small and medium, under 250 employees), ETI (intermediate, 250 to 4,999), GE (large, 5,000 or more). Companies without a computed category are excluded when this filter is set.",
            "items": {
              "type": "string",
              "enum": [
                "PME",
                "ETI",
                "GE"
              ],
              "enumTitles": [
                "PME: small and medium-sized",
                "ETI: intermediate-sized",
                "GE: large"
              ]
            }
          },
          "createdAfter": {
            "title": "Created on or after",
            "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "Keep companies created on or after this date: an absolute date YYYY-MM-DD or a relative duration such as \"6 months\" (that long before the run). Useful for lists of new companies."
          },
          "createdBefore": {
            "title": "Created on or before",
            "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "Keep companies created on or before this date: YYYY-MM-DD or a relative duration such as \"10 years\"."
          },
          "onlyActive": {
            "title": "Active companies only",
            "type": "boolean",
            "description": "true (default): only companies whose legal unit is active in the register. false: closed companies are included too (administrativeStatus tells which).",
            "default": true
          },
          "excludeProspectingOptOut": {
            "title": "Exclude companies that refuse prospecting",
            "type": "boolean",
            "description": "true (default): leave out companies flagged as opposed to the commercial use of their register data (field opposition_diffusion_commerciale of the API). Recommended for direct marketing. false: keep them, with prospectingOptOut = true.",
            "default": true
          },
          "maxItems": {
            "title": "Maximum number of companies",
            "minimum": 1,
            "maximum": 500000,
            "type": "integer",
            "description": "The run stops after this many companies are listed (each listed company is one charged event). Default 1,000.",
            "default": 1000
          },
          "maxRequestsPerSecond": {
            "title": "Max requests per second",
            "minimum": 1,
            "maximum": 7,
            "type": "integer",
            "description": "Politeness limit towards the public API (its hard limit is 7 per second per IP). Leave the default unless several runs share the same IP.",
            "default": 6
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}