{
  "openapi": "3.0.1",
  "info": {
    "title": "French Company Data: SIREN/SIRET Search & Lookup (Official API)",
    "description": "Official French company data (SIRENE) from the government API: look up SIREN/SIRET or search by name, NAF code, département, postcode, size, legal form, revenue. Clean output with NAF labels, HQ address, headcount, revenue & net income. No API key. Sole traders excluded by default.",
    "version": "1.0",
    "x-build-id": "GTXuDogPB9YbOpb8M"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/terracotta_hauyne~france-company-data-sirene/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-terracotta_hauyne-france-company-data-sirene",
        "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/terracotta_hauyne~france-company-data-sirene/runs": {
      "post": {
        "operationId": "runs-sync-terracotta_hauyne-france-company-data-sirene",
        "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/terracotta_hauyne~france-company-data-sirene/run-sync": {
      "post": {
        "operationId": "run-sync-terracotta_hauyne-france-company-data-sirene",
        "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": {
          "sirenOrSiret": {
            "title": "SIREN / SIRET numbers",
            "type": "array",
            "description": "SIREN lookup (9 digits) or SIRET lookup (14 digits, one establishment). Spaces are ignored and annuaire-entreprises.data.gouv.fr URLs are accepted. Example: 383474814 (Airbus).",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search by name or address",
            "type": "array",
            "description": "Free-text company search (name, acronym, address, or a director's name), e.g. 'boulangerie lyon'. Each query is combined with the filters below.",
            "items": {
              "type": "string"
            }
          },
          "nafCodes": {
            "title": "NAF / APE activity codes",
            "type": "array",
            "description": "NAF rev. 2 codes of the company's main activity, e.g. 10.71C (boulangerie), 62.01Z (software), 56.10A (restaurants). '1071C' also works.",
            "items": {
              "type": "string"
            }
          },
          "nafSections": {
            "title": "NAF sections",
            "type": "array",
            "description": "Broad activity sections (A-U).",
            "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, sylviculture et pêche",
                "B - Industries extractives",
                "C - Industrie manufacturière",
                "D - Production et distribution d'électricité, de gaz, de vapeur et d'air conditionné",
                "E - Production et distribution d'eau ; assainissement, gestion des déchets et dépollution",
                "F - Construction",
                "G - Commerce; réparation d'automobiles et de motocycles",
                "H - Transports et entreposage",
                "I - Hébergement et restauration",
                "J - Information et communication",
                "K - Activités financières et d'assurance",
                "L - Activités immobilières",
                "M - Activités spécialisées, scientifiques et techniques",
                "N - Activités de services administratifs et de soutien",
                "O - Administration publique",
                "P - Enseignement",
                "Q - Santé humaine et action sociale",
                "R - Arts, spectacles et activités récréatives",
                "S - Autres activités de services",
                "T - Activités des ménages en tant qu'employeurs ; activités indifférenciées des ménages en tant que producteurs de biens et services pour usage propre",
                "U - Activités extra-territoriales"
              ]
            }
          },
          "departements": {
            "title": "Départements",
            "type": "array",
            "description": "Département codes of an establishment, e.g. 75 (Paris), 69 (Rhône), 2A (Corse-du-Sud), 971 (Guadeloupe).",
            "items": {
              "type": "string"
            }
          },
          "postalCodes": {
            "title": "Postal codes",
            "type": "array",
            "description": "5-digit postal codes of an establishment, e.g. 69002.",
            "items": {
              "type": "string"
            }
          },
          "communeCodes": {
            "title": "Commune codes (INSEE)",
            "type": "array",
            "description": "5-character INSEE commune codes (not postal codes), e.g. 75056 (Paris), 31555 (Toulouse).",
            "items": {
              "type": "string"
            }
          },
          "locationHeadOfficeOnly": {
            "title": "Location filters: head office only",
            "type": "boolean",
            "description": "The API matches département / postal code / commune against any establishment of a company. Turn this on to keep only companies whose head office (siège) is in the selected location.",
            "default": false
          },
          "companyStatus": {
            "title": "Company status",
            "enum": [
              "active",
              "ceased",
              "any"
            ],
            "type": "string",
            "description": "Administrative status of the company (searches only; lookups always return the company).",
            "default": "active"
          },
          "companyCategories": {
            "title": "Company size category",
            "type": "array",
            "description": "INSEE company category.",
            "items": {
              "type": "string",
              "enum": [
                "PME",
                "ETI",
                "GE"
              ],
              "enumTitles": [
                "PME (SME)",
                "ETI (mid-cap)",
                "GE (large enterprise)"
              ]
            }
          },
          "headcountBands": {
            "title": "Headcount bands",
            "type": "array",
            "description": "INSEE employee headcount bands (tranche d'effectif salarié).",
            "items": {
              "type": "string",
              "enum": [
                "NN",
                "00",
                "01",
                "02",
                "03",
                "11",
                "12",
                "21",
                "22",
                "31",
                "32",
                "41",
                "42",
                "51",
                "52",
                "53"
              ],
              "enumTitles": [
                "NN - Unité non employeuse",
                "00 - 0 salarié",
                "01 - 1 ou 2 salariés",
                "02 - 3 à 5 salariés",
                "03 - 6 à 9 salariés",
                "11 - 10 à 19 salariés",
                "12 - 20 à 49 salariés",
                "21 - 50 à 99 salariés",
                "22 - 100 à 199 salariés",
                "31 - 200 à 249 salariés",
                "32 - 250 à 499 salariés",
                "41 - 500 à 999 salariés",
                "42 - 1 000 à 1 999 salariés",
                "51 - 2 000 à 4 999 salariés",
                "52 - 5 000 à 9 999 salariés",
                "53 - 10 000 salariés et plus"
              ]
            }
          },
          "legalFormCodes": {
            "title": "Legal form codes (nature juridique)",
            "type": "array",
            "description": "INSEE legal category codes, e.g. 5710 (SAS), 5720 (SASU), 5499 (SARL), 5599 (SA), 9220 (association).",
            "items": {
              "type": "string"
            }
          },
          "createdFrom": {
            "title": "Created from",
            "type": "string",
            "description": "Only companies created on or after this date (YYYY-MM-DD). The API has no date filter, so this is applied to the results of your search/filters: combine it with an activity or location filter."
          },
          "createdTo": {
            "title": "Created to",
            "type": "string",
            "description": "Only companies created on or before this date (YYYY-MM-DD)."
          },
          "minRevenue": {
            "title": "Min revenue (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only companies whose latest published revenue (chiffre d'affaires) is at least this amount. The API filters on published accounts, so companies without them do not match."
          },
          "maxRevenue": {
            "title": "Max revenue (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only companies whose latest published revenue is at most this amount."
          },
          "onlyWithLabels": {
            "title": "Only companies with labels / certifications",
            "type": "array",
            "description": "Only companies holding all of the selected labels.",
            "items": {
              "type": "string",
              "enum": [
                "est_rge",
                "est_qualiopi",
                "est_bio",
                "est_ess",
                "est_societe_mission",
                "est_siae",
                "est_patrimoine_vivant",
                "est_organisme_formation",
                "est_entrepreneur_spectacle",
                "est_finess",
                "est_achats_responsables",
                "est_alim_confiance",
                "est_association",
                "egapro_renseignee"
              ],
              "enumTitles": [
                "RGE (energy renovation)",
                "Qualiopi (training quality)",
                "Organic (Agence Bio)",
                "Social & solidarity economy (ESS)",
                "Société à mission",
                "Inclusion employer (SIAE)",
                "Entreprise du Patrimoine Vivant",
                "Training organisation",
                "Live-show licence",
                "Health & social (FINESS)",
                "Responsible purchasing (RFAR)",
                "Alim'Confiance food inspection",
                "Association",
                "Egapro gender-equality index published"
              ]
            }
          },
          "sortBySize": {
            "title": "Biggest companies first",
            "type": "boolean",
            "description": "Sort search results by size (number of establishments) instead of relevance.",
            "default": false
          },
          "excludeSoleTraders": {
            "title": "Exclude sole traders (entrepreneurs individuels)",
            "type": "boolean",
            "description": "On by default: sole traders are natural persons, so their name and often home address are personal data under GDPR. Also applies to SIREN/SIRET lookups.",
            "default": true
          },
          "excludeProspectingOptOuts": {
            "title": "Exclude companies opposed to commercial prospecting",
            "type": "boolean",
            "description": "Skip companies registered as opposed to reuse of their data for commercial prospecting (opposition_diffusion_commerciale, from the RNE). Every item has the field optedOutOfCommercialProspecting either way; respect it for marketing.",
            "default": false
          },
          "includeEstablishments": {
            "title": "Include establishments",
            "type": "boolean",
            "description": "Add the establishments (SIRET) that matched your search/filters, with address, activity, headcount and status. For a SIREN lookup the API returns no matching establishments, so the head office is listed.",
            "default": false
          },
          "maxEstablishmentsPerCompany": {
            "title": "Max establishments per company",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Establishments to include per company (API maximum 100).",
            "default": 10
          },
          "includeDirectors": {
            "title": "Include directors (personal data)",
            "type": "boolean",
            "description": "Add directors and statutory auditors as published by the API: names and roles only (birth dates are never output). This is personal data: enable it only if you have a lawful basis under GDPR; you are the controller of your copy.",
            "default": false
          },
          "maxResults": {
            "title": "Max companies in total",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many companies (each company is one result). The API returns at most 10,000 companies per search.",
            "default": 100
          },
          "maxRequestsPerSecond": {
            "title": "Max API requests per second",
            "minimum": 1,
            "maximum": 6,
            "type": "integer",
            "description": "The API allows 7 requests/s per IP and 30/s per cloud network shared with other users. The actor slows down automatically after a 429. Each request returns up to 25 companies.",
            "default": 4
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}