{
  "openapi": "3.0.1",
  "info": {
    "title": "French Company Data – SIRENE Search, SIREN Lookup & Enrichment",
    "description": "Search, look up and enrich French companies from the official SIRENE registry: SIREN/SIRET, directors, revenue, certifications (RGE, Qualiopi…), establishments and BODACC risk signals. No 10,000-result cap, name-to-SIREN matching, address radius search.",
    "version": "0.1",
    "x-build-id": "m3ndIPtkoE66dzuwx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/yck69~french-company-data/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-yck69-french-company-data",
        "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/yck69~french-company-data/runs": {
      "post": {
        "operationId": "runs-sync-yck69-french-company-data",
        "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/yck69~french-company-data/run-sync": {
      "post": {
        "operationId": "run-sync-yck69-french-company-data",
        "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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "What do you want to do?",
            "enum": [
              "search",
              "lookup",
              "match",
              "nearby"
            ],
            "type": "string",
            "description": "<b>Search</b>: find companies with keywords and filters (sector, location, size, revenue, certifications…), with no 10,000-result cap.<br><b>Look up</b>: get full records for a list of SIREN, SIRET or French VAT numbers.<br><b>Match names</b>: turn a list of company names (e.g. from your CRM) into SIREN numbers, with a confidence score.<br><b>Nearby</b>: companies with an establishment within a radius of an address or GPS point.",
            "default": "search"
          },
          "query": {
            "title": "Keywords",
            "type": "string",
            "description": "Free text searched in company names, trade names, addresses and director names. Example: <code>boulangerie</code>, <code>agence web Lyon</code>. Leave empty to rely on filters only."
          },
          "nafCodes": {
            "title": "Activity codes (NAF / APE)",
            "type": "array",
            "description": "One or more NAF codes, e.g. <code>62.01Z</code> (software development), <code>56.10A</code> (restaurants), <code>43.21A</code> (electricians). <code>6201Z</code> is accepted too. Also applies to Nearby mode.",
            "items": {
              "type": "string"
            }
          },
          "nafSections": {
            "title": "Activity sectors (NAF sections)",
            "type": "array",
            "description": "Broad sectors. Also applies to Nearby mode.",
            "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 & fishing",
                "B – Mining & quarrying",
                "C – Manufacturing",
                "D – Electricity & gas supply",
                "E – Water, sewerage & waste",
                "F – Construction",
                "G – Wholesale & retail trade",
                "H – Transport & storage",
                "I – Hotels & restaurants",
                "J – Information & communication",
                "K – Finance & insurance",
                "L – Real estate",
                "M – Professional, scientific & technical",
                "N – Administrative & support services",
                "O – Public administration",
                "P – Education",
                "Q – Health & social work",
                "R – Arts, entertainment & recreation",
                "S – Other services",
                "T – Households as employers",
                "U – Extraterritorial organisations"
              ]
            }
          },
          "departments": {
            "title": "Departments",
            "type": "array",
            "description": "Department codes where the company has at least one establishment, e.g. <code>75</code>, <code>69</code>, <code>2A</code>, <code>971</code>.",
            "items": {
              "type": "string"
            }
          },
          "postalCodes": {
            "title": "Postal codes",
            "type": "array",
            "description": "5-digit postal codes where the company has at least one establishment, e.g. <code>69002</code>.",
            "items": {
              "type": "string"
            }
          },
          "communeCodes": {
            "title": "INSEE commune codes",
            "type": "array",
            "description": "INSEE city codes (not postal codes), e.g. <code>75109</code> for Paris 9th.",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "title": "Regions",
            "type": "array",
            "description": "Regions where the company has at least one establishment.",
            "items": {
              "type": "string",
              "enum": [
                "11",
                "24",
                "27",
                "28",
                "32",
                "44",
                "52",
                "53",
                "75",
                "76",
                "84",
                "93",
                "94",
                "01",
                "02",
                "03",
                "04",
                "06"
              ],
              "enumTitles": [
                "Île-de-France",
                "Centre-Val de Loire",
                "Bourgogne-Franche-Comté",
                "Normandie",
                "Hauts-de-France",
                "Grand Est",
                "Pays de la Loire",
                "Bretagne",
                "Nouvelle-Aquitaine",
                "Occitanie",
                "Auvergne-Rhône-Alpes",
                "Provence-Alpes-Côte d'Azur",
                "Corse",
                "Guadeloupe",
                "Martinique",
                "Guyane",
                "La Réunion",
                "Mayotte"
              ]
            }
          },
          "employeeRanges": {
            "title": "Number of employees",
            "type": "array",
            "description": "Official INSEE headcount ranges.",
            "items": {
              "type": "string",
              "enum": [
                "NN",
                "00",
                "01",
                "02",
                "03",
                "11",
                "12",
                "21",
                "22",
                "31",
                "32",
                "41",
                "42",
                "51",
                "52",
                "53"
              ],
              "enumTitles": [
                "No employees",
                "0 at year end",
                "1–2",
                "3–5",
                "6–9",
                "10–19",
                "20–49",
                "50–99",
                "100–199",
                "200–249",
                "250–499",
                "500–999",
                "1,000–1,999",
                "2,000–4,999",
                "5,000–9,999",
                "10,000+"
              ]
            }
          },
          "companyCategories": {
            "title": "Company size category",
            "type": "array",
            "description": "INSEE category: SME, mid-size or large enterprise.",
            "items": {
              "type": "string",
              "enum": [
                "PME",
                "ETI",
                "GE"
              ],
              "enumTitles": [
                "PME – Small & medium-sized",
                "ETI – Mid-size",
                "GE – Large enterprise"
              ]
            }
          },
          "legalForms": {
            "title": "Legal forms",
            "type": "array",
            "description": "Shortcuts: <code>SAS</code> (includes SASU), <code>SARL</code> (includes EURL), <code>SA</code>, <code>SNC</code>, <code>SCI</code>, <code>EI</code> (sole proprietor), <code>SELARL</code>, <code>SELAS</code>, <code>SCOP</code>, <code>GIE</code>, <code>ASSOCIATION</code>. Or any 4-digit INSEE code, e.g. <code>5710</code>.",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "title": "Status",
            "enum": [
              "active",
              "ceased",
              "all"
            ],
            "type": "string",
            "description": "Active companies only, ceased only, or both.",
            "default": "active"
          },
          "labels": {
            "title": "Must have these certifications / labels",
            "type": "array",
            "description": "Keep only companies that have all the selected labels.",
            "items": {
              "type": "string",
              "enum": [
                "rge",
                "qualiopi",
                "bio",
                "ess",
                "societe_mission",
                "organisme_formation",
                "association",
                "entrepreneur_individuel",
                "siae",
                "patrimoine_vivant",
                "finess",
                "alim_confiance",
                "entrepreneur_spectacle",
                "achats_responsables",
                "egapro",
                "uai",
                "administration",
                "collectivite_territoriale",
                "convention_collective"
              ],
              "enumTitles": [
                "RGE (eco-renovation certified)",
                "Qualiopi (training quality)",
                "Organic (Agence Bio)",
                "Social & solidarity economy (ESS)",
                "Société à mission",
                "Training organisation",
                "Association",
                "Sole proprietor (EI)",
                "Work-integration structure (SIAE)",
                "Living Heritage Company (EPV)",
                "Health & social (FINESS)",
                "Food-safety inspected (Alim'Confiance)",
                "Live-show licence",
                "Responsible purchasing (RFAR)",
                "Gender equality index published",
                "Education establishment (UAI)",
                "Public administration",
                "Local authority",
                "Collective agreement on file"
              ]
            }
          },
          "excludeLabels": {
            "title": "Exclude these labels",
            "type": "array",
            "description": "Remove companies that have any of these labels. Tip: exclude <b>Sole proprietor</b> and <b>Association</b> for B2B prospecting.",
            "items": {
              "type": "string",
              "enum": [
                "entrepreneur_individuel",
                "association",
                "administration",
                "collectivite_territoriale",
                "ess",
                "siae"
              ],
              "enumTitles": [
                "Sole proprietor (EI)",
                "Association",
                "Public administration",
                "Local authority",
                "Social & solidarity economy (ESS)",
                "Work-integration structure (SIAE)"
              ]
            }
          },
          "minRevenue": {
            "title": "Minimum revenue (€)",
            "type": "integer",
            "description": "Latest published revenue (chiffre d'affaires). Only companies that publish their accounts have this figure."
          },
          "maxRevenue": {
            "title": "Maximum revenue (€)",
            "type": "integer",
            "description": "Latest published revenue."
          },
          "minNetIncome": {
            "title": "Minimum net income (€)",
            "type": "integer",
            "description": "Latest published net income (résultat net). Use 0 to keep profitable companies only."
          },
          "maxNetIncome": {
            "title": "Maximum net income (€)",
            "type": "integer",
            "description": "Latest published net income."
          },
          "createdAfter": {
            "title": "Created after",
            "type": "string",
            "description": "Keep companies created on or after this date, e.g. <code>2026-01-01</code> or <code>30 days</code> for the last 30 days. Works best combined with sector or location filters."
          },
          "createdBefore": {
            "title": "Created before",
            "type": "string",
            "description": "Keep companies created on or before this date, e.g. <code>2015-12-31</code> or <code>10 years</code> for companies at least 10 years old."
          },
          "personLastName": {
            "title": "Director last name",
            "type": "string",
            "description": "Find companies where this person is a director (or elected official). Example: <code>Dupont</code>."
          },
          "personFirstName": {
            "title": "Director first name",
            "type": "string",
            "description": "Optional, combined with the last name."
          },
          "identifiers": {
            "title": "SIREN, SIRET or VAT numbers",
            "type": "array",
            "description": "One per line. SIREN (9 digits), SIRET (14 digits) or French VAT number (FR + 11 characters). Spaces and dots are ignored.",
            "items": {
              "type": "string"
            }
          },
          "companyNames": {
            "title": "Company names",
            "type": "array",
            "description": "One per line. Add a city, postal code or department after a comma to improve accuracy: <code>Danone, Paris</code>, <code>Boulangerie Martin, 69002</code>.",
            "items": {
              "type": "string"
            }
          },
          "minMatchScore": {
            "title": "Minimum match score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "From 0 to 100. Matches below this score are returned free as <code>low_confidence</code> with the best candidate.",
            "default": 75
          },
          "address": {
            "title": "Address",
            "type": "string",
            "description": "Any French address, e.g. <code>12 rue de la République, Lyon</code>. Leave empty to use the coordinates below."
          },
          "latitude": {
            "title": "Latitude",
            "type": "number",
            "description": "Used when no address is given."
          },
          "longitude": {
            "title": "Longitude",
            "type": "number",
            "description": "Used when no address is given."
          },
          "radiusKm": {
            "title": "Radius (km)",
            "minimum": 0.05,
            "maximum": 50,
            "type": "number",
            "description": "Up to 50 km.",
            "default": 1
          },
          "maxResults": {
            "title": "Maximum results",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Stop after this many companies (or establishments). Large searches are split automatically, so you can go well beyond 10,000.",
            "default": 100
          },
          "countOnly": {
            "title": "Count only (free preview)",
            "type": "boolean",
            "description": "Only count how many companies match and estimate the cost. Nothing is charged.",
            "default": false
          },
          "resultLevel": {
            "title": "One row per",
            "enum": [
              "auto",
              "company",
              "establishment"
            ],
            "type": "string",
            "description": "<b>Auto</b>: establishments for Nearby, Look up by SIRET and searches filtered by postal code or commune (local searches); companies otherwise.<br><b>Establishment</b>: one row per site (shop, office, agency) that the official API matches to your keywords or location filters, up to 100 per company. Companies without a matching site get one row for their head office.",
            "default": "auto"
          },
          "includeDirectors": {
            "title": "Include directors",
            "type": "boolean",
            "description": "Names, roles and birth year of directors and auditors.",
            "default": true
          },
          "includeEstablishments": {
            "title": "Include matching establishments in company rows",
            "type": "boolean",
            "description": "Adds the list of the company's establishments that match your location filters (up to 100).",
            "default": false
          },
          "checkBodacc": {
            "title": "Add BODACC risk check (paid add-on)",
            "type": "boolean",
            "description": "Look up each company in the official BODACC gazette: insolvency proceedings, deregistration, business sales, last accounts filed, plus a risk level. Charged per company on top of the base price.",
            "default": false
          },
          "splitLargeSearches": {
            "title": "Go beyond 10,000 results",
            "type": "boolean",
            "description": "The official API stops at 10,000 results per query. When on, large searches are split automatically (by department, postal code, sector…) and merged without duplicates.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Usually not needed. The official API limits requests per IP address; a proxy can help if you see many rate-limit warnings.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}