{
  "openapi": "3.0.1",
  "info": {
    "title": "France Company Search: SIREN Lookup, Lists & Group Links",
    "description": "probe",
    "version": "0.1",
    "x-build-id": "fXbLJ7YM5BtnB6FaX"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/yzy001~france-company-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-yzy001-france-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/yzy001~france-company-search/runs": {
      "post": {
        "operationId": "runs-sync-yzy001-france-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/yzy001~france-company-search/run-sync": {
      "post": {
        "operationId": "run-sync-yzy001-france-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": "What to do",
            "enum": [
              "search",
              "lookup",
              "group"
            ],
            "type": "string",
            "description": "search builds a company list from the filters below. lookup returns one row per identifier in ids. group starts from the companies in ids and follows corporate officers up and down.",
            "default": "search"
          },
          "query": {
            "title": "Text search",
            "type": "string",
            "description": "Optional. Company name, address or brand, as on the Annuaire des Entreprises (at least 3 characters unless a filter is set)."
          },
          "nafCodes": {
            "title": "NAF / APE activity codes",
            "type": "array",
            "description": "INSEE NAF rev. 2 codes such as 62.01Z or 6201Z (any of them).",
            "items": {
              "type": "string"
            }
          },
          "nafSections": {
            "title": "NAF sections",
            "type": "array",
            "description": "Broad activity sections (any of them).",
            "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"
              ]
            }
          },
          "departments": {
            "title": "Departments",
            "type": "array",
            "description": "Department codes such as 75, 69, 2A or 974 (any of them).",
            "items": {
              "type": "string"
            }
          },
          "postalCodes": {
            "title": "Postal codes",
            "type": "array",
            "description": "Five-digit postal codes (any of them).",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "title": "Regions",
            "type": "array",
            "description": "Regions (any of them).",
            "items": {
              "type": "string",
              "enum": [
                "01",
                "02",
                "03",
                "04",
                "06",
                "11",
                "24",
                "27",
                "28",
                "32",
                "44",
                "52",
                "53",
                "75",
                "76",
                "84",
                "93",
                "94"
              ],
              "enumTitles": [
                "Guadeloupe",
                "Martinique",
                "Guyane",
                "La Réunion",
                "Mayotte",
                "Î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"
              ]
            }
          },
          "locationMatch": {
            "title": "Location applies to",
            "enum": [
              "HEAD_OFFICE",
              "ANY_ESTABLISHMENT"
            ],
            "type": "string",
            "description": "The registry matches a company when any of its establishments is in the area. HEAD_OFFICE keeps only companies whose head office is there.",
            "default": "HEAD_OFFICE"
          },
          "legalFormCodes": {
            "title": "Legal form codes",
            "type": "array",
            "description": "INSEE legal category codes (catégorie juridique), e.g. 5710 SAS, 5499 SARL, 5599 SA, 6540 SCI, 9220 association. Code 1000 (sole trader) is not available.",
            "items": {
              "type": "string"
            }
          },
          "sizeCategories": {
            "title": "Company size",
            "type": "array",
            "description": "INSEE size category (any of them).",
            "items": {
              "type": "string",
              "enum": [
                "PME",
                "ETI",
                "GE"
              ],
              "enumTitles": [
                "SME (PME)",
                "Mid-size (ETI)",
                "Large (GE)"
              ]
            }
          },
          "headcountBands": {
            "title": "Headcount bands",
            "type": "array",
            "description": "INSEE employee bands (any of them).",
            "items": {
              "type": "string",
              "enum": [
                "NN",
                "00",
                "01",
                "02",
                "03",
                "11",
                "12",
                "21",
                "22",
                "31",
                "32",
                "41",
                "42",
                "51",
                "52",
                "53"
              ],
              "enumTitles": [
                "Non-employer",
                "0 employees 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 or more"
              ]
            }
          },
          "minRevenueEur": {
            "title": "Minimum revenue (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Only companies whose latest published revenue is at least this."
          },
          "maxRevenueEur": {
            "title": "Maximum revenue (EUR)",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Only companies whose latest published revenue is at most this."
          },
          "labels": {
            "title": "Labels and registers",
            "type": "array",
            "description": "Only companies carrying all of these labels.",
            "items": {
              "type": "string",
              "enum": [
                "RGE",
                "QUALIOPI",
                "ESS",
                "BIO",
                "SIAE",
                "MISSION_COMPANY",
                "TRAINING_ORGANISATION",
                "LIVING_HERITAGE_COMPANY",
                "ENTERTAINMENT_LICENCE",
                "ASSOCIATION",
                "RESPONSIBLE_PURCHASING",
                "HEALTH_SOCIAL_FINESS"
              ],
              "enumTitles": [
                "RGE (energy renovation)",
                "Qualiopi (training quality)",
                "Social economy (ESS)",
                "Organic (Agence Bio)",
                "Work integration (SIAE)",
                "Mission-driven company",
                "Training organisation",
                "Living heritage company (EPV)",
                "Entertainment licence",
                "Association",
                "Responsible purchasing (RFAR)",
                "Health and social (FINESS)"
              ]
            }
          },
          "onlyActive": {
            "title": "Active companies only",
            "type": "boolean",
            "description": "Search and group modes: leave out ceased companies. Lookup always returns the status.",
            "default": true
          },
          "excludeProspectingOptOuts": {
            "title": "Leave out companies that object to prospecting",
            "type": "boolean",
            "description": "Search mode: leave out companies that objected to the reuse of their register data for commercial prospecting (GDPR art. 21(2)). Turn off only for uses other than prospecting.",
            "default": true
          },
          "ids": {
            "title": "SIREN, SIRET or VAT numbers",
            "type": "array",
            "description": "Lookup: up to 1,000 identifiers, one row each. Group: up to 50 starting companies.",
            "items": {
              "type": "string"
            }
          },
          "direction": {
            "title": "Group direction",
            "enum": [
              "both",
              "up",
              "down"
            ],
            "type": "string",
            "description": "Group mode: follow officers up (companies that are officers of the starting company), down (companies where it is an officer), or both.",
            "default": "both"
          },
          "maxDepth": {
            "title": "Group depth",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Group mode: how many links to follow in each direction (1-5).",
            "default": 2
          },
          "relationshipTypes": {
            "title": "Officer roles to follow",
            "type": "array",
            "description": "Group mode: which officer roles count as a link. Auditors, liquidators and 'other' roles are not followed unless you add them.",
            "items": {
              "type": "string",
              "enum": [
                "LEGAL_REPRESENTATIVE",
                "PARTNER",
                "BOARD",
                "MEMBER",
                "AUDITOR",
                "LIQUIDATOR",
                "OTHER"
              ],
              "enumTitles": [
                "Legal representative (président, gérant, directeur général)",
                "Partner with unlimited liability",
                "Board or supervisory board",
                "Member (GIE and similar)",
                "Auditor (commissaire aux comptes)",
                "Liquidator or court administrator",
                "Other"
              ]
            },
            "default": [
              "LEGAL_REPRESENTATIVE",
              "PARTNER",
              "BOARD",
              "MEMBER"
            ]
          },
          "maxSearchPagesPerCompany": {
            "title": "Name-search pages per company",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Group mode, downward: result pages (25 each) to scan when searching a company's name for the companies it runs (1-100).",
            "default": 20
          },
          "maxItems": {
            "title": "Maximum rows",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop after this many rows (1-10,000; the registry returns at most 10,000 matches per search).",
            "default": 500
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}