{
  "openapi": "3.0.1",
  "info": {
    "title": "French Company Search: Official SIREN Data, No Personal Data",
    "description": "Search French companies in the official Sirene register by activity, area, size, revenue or label (RGE, Qualiopi), or check a SIREN list. No personal data.",
    "version": "0.1",
    "x-build-id": "HbWoDK2I9IMefxDQo"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/arnaud437~french-company-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-arnaud437-french-company-search",
        "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/arnaud437~french-company-search/runs": {
      "post": {
        "operationId": "runs-sync-arnaud437-french-company-search",
        "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/arnaud437~french-company-search/run-sync": {
      "post": {
        "operationId": "run-sync-arnaud437-french-company-search",
        "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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "lookup"
            ],
            "type": "string",
            "description": "Search: find companies matching your filters. Lookup: check a list of SIREN or SIRET numbers.",
            "default": "search"
          },
          "sirens": {
            "title": "SIREN or SIRET numbers (lookup mode)",
            "maxItems": 5000,
            "type": "array",
            "description": "Companies to check, one number per line. Invalid numbers are reported as error rows and never charged.",
            "items": {
              "type": "string"
            }
          },
          "query": {
            "title": "Name or keywords",
            "maxLength": 200,
            "type": "string",
            "description": "Optional. Words searched in the company name and activity, as on annuaire-entreprises.data.gouv.fr."
          },
          "nafCodes": {
            "title": "Activity codes (NAF)",
            "maxItems": 100,
            "type": "array",
            "description": "NAF codes such as 62.01Z (software) or 43.21A (electrical work). Several codes: companies with any of them.",
            "items": {
              "type": "string"
            }
          },
          "departments": {
            "title": "Departments",
            "maxItems": 110,
            "type": "array",
            "description": "Department codes such as 33, 2A or 974. Companies with at least one establishment there.",
            "items": {
              "type": "string"
            }
          },
          "postalCodes": {
            "title": "Postal codes",
            "maxItems": 200,
            "type": "array",
            "description": "5-digit postal codes.",
            "items": {
              "type": "string"
            }
          },
          "companyCategories": {
            "title": "Company size category",
            "type": "array",
            "description": "INSEE category: PME (small and medium), ETI (intermediate), GE (large).",
            "items": {
              "type": "string",
              "enum": [
                "PME",
                "ETI",
                "GE"
              ],
              "enumTitles": [
                "PME (small and medium)",
                "ETI (intermediate)",
                "GE (large)"
              ]
            }
          },
          "employeeRanges": {
            "title": "Employees",
            "type": "array",
            "description": "Salaried headcount ranges declared to INSEE.",
            "items": {
              "type": "string",
              "enum": [
                "00",
                "01",
                "02",
                "03",
                "11",
                "12",
                "21",
                "22",
                "31",
                "32",
                "41",
                "42",
                "51",
                "52",
                "53"
              ],
              "enumTitles": [
                "0 employees",
                "1-2 employees",
                "3-5 employees",
                "6-9 employees",
                "10-19 employees",
                "20-49 employees",
                "50-99 employees",
                "100-199 employees",
                "200-249 employees",
                "250-499 employees",
                "500-999 employees",
                "1000-1999 employees",
                "2000-4999 employees",
                "5000-9999 employees",
                "10000+ employees"
              ]
            }
          },
          "legalForms": {
            "title": "Legal form codes",
            "maxItems": 50,
            "type": "array",
            "description": "Optional. INSEE legal form codes such as 5710 (SAS) or 5499 (SARL).",
            "items": {
              "type": "string"
            }
          },
          "labels": {
            "title": "Official labels",
            "type": "array",
            "description": "Keep only companies holding all these labels.",
            "items": {
              "type": "string",
              "enum": [
                "rge",
                "qualiopi",
                "bio",
                "ess",
                "societeMission",
                "organismeFormation",
                "siae",
                "patrimoineVivant"
              ],
              "enumTitles": [
                "RGE (energy renovation)",
                "Qualiopi (training quality)",
                "Organic (bio)",
                "Social and solidarity economy (ESS)",
                "Société à mission",
                "Training organisation",
                "Inclusion employer (SIAE)",
                "Living heritage company (EPV)"
              ]
            }
          },
          "minRevenue": {
            "title": "Minimum revenue (EUR)",
            "type": "integer",
            "description": "Optional. Last published turnover, in euros. Many small companies publish none."
          },
          "maxRevenue": {
            "title": "Maximum revenue (EUR)",
            "type": "integer",
            "description": "Optional."
          },
          "minNetIncome": {
            "title": "Minimum net income (EUR)",
            "type": "integer",
            "description": "Optional. Last published net result, in euros."
          },
          "maxNetIncome": {
            "title": "Maximum net income (EUR)",
            "type": "integer",
            "description": "Optional."
          },
          "includeClosed": {
            "title": "Include closed companies",
            "type": "boolean",
            "description": "Search mode only. Lookups always return closed companies.",
            "default": false
          },
          "includeProspectingOptOut": {
            "title": "Include companies that refused prospecting",
            "type": "boolean",
            "description": "Many companies refused the use of their data for prospecting (Code de commerce, art. A123-96). They are left out by default. Turn this on only if your use is not prospecting (checking suppliers or customers, market studies): each row then says prospectingOptOut true or false.",
            "default": false
          },
          "onlyNew": {
            "title": "Only new companies",
            "type": "boolean",
            "description": "Search mode, for scheduled runs: skip the companies this watch already returned.",
            "default": false
          },
          "stateKey": {
            "title": "Watch name",
            "maxLength": 50,
            "type": "string",
            "description": "Optional. Give each scheduled watch its own name, so they do not share their memory of sent companies."
          },
          "maxResults": {
            "title": "Maximum results",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Most companies to return in one run. The official API delivers at most 10,000 per search.",
            "default": 100
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}