{
  "openapi": "3.0.1",
  "info": {
    "title": "France Company Search & Emails: SIREN, NAF, New Companies",
    "description": "Search French companies from the official Sirene register by NAF code, département, postcode, creation date and legal form, with SIREN, address, employees and VAT number. Optional website and email lookup for companies that allow prospecting. No API key. $0.005 per company.",
    "version": "0.3",
    "x-build-id": "d5OwKdZytKdbpnLk8"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/datagleaner~france-company-contacts/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-datagleaner-france-company-contacts",
        "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/datagleaner~france-company-contacts/runs": {
      "post": {
        "operationId": "runs-sync-datagleaner-france-company-contacts",
        "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/datagleaner~france-company-contacts/run-sync": {
      "post": {
        "operationId": "run-sync-datagleaner-france-company-contacts",
        "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": {
          "query": {
            "title": "Name, address or SIREN",
            "type": "string",
            "description": "Optional text search over company names and addresses, or an exact 9-digit SIREN or 14-digit SIRET. Leave empty to filter only by the fields below."
          },
          "nafCodes": {
            "title": "NAF / APE activity codes",
            "type": "array",
            "description": "Optional. Main-activity codes in the NAF 2008 list that the register API accepts, e.g. `62.01Z` (software), `56.10A` (restaurants), `43.22A` (plumbing), `69.20Z` (accounting). `6201Z` without the dot also works. Several codes are OR-ed.",
            "items": {
              "type": "string"
            }
          },
          "departements": {
            "title": "Départements",
            "type": "array",
            "description": "Optional. Département codes, e.g. `75`, `69`, `2A`, `971`. By default only companies whose head office is in the area are kept (see Head office in area).",
            "items": {
              "type": "string"
            }
          },
          "postalCodes": {
            "title": "Postal codes",
            "type": "array",
            "description": "Optional. Five-digit postal codes, e.g. `75008`. Takes precedence over départements for the head-office check.",
            "items": {
              "type": "string"
            }
          },
          "legalForms": {
            "title": "Legal forms",
            "type": "array",
            "description": "Optional. `SAS`, `SASU`, `SARL`, `EURL`, `SA`, `SCI`, `SCOP`, `ASSOCIATION`, or an INSEE 4-digit legal category code such as `5710`. Empty means every legal form except sole traders, which are never returned.",
            "items": {
              "type": "string"
            }
          },
          "createdFrom": {
            "title": "Created on or after",
            "type": "string",
            "description": "Optional date `YYYY-MM-DD`. The register API has no date filter, so this is applied while reading result pages: pair it with a NAF code, département or postcode so the search stays under the API's 10,000-result ceiling."
          },
          "createdTo": {
            "title": "Created on or before",
            "type": "string",
            "description": "Optional date `YYYY-MM-DD`, see Created on or after."
          },
          "status": {
            "title": "Status",
            "enum": [
              "active",
              "ceased"
            ],
            "type": "string",
            "description": "Active companies by default.",
            "default": "active"
          },
          "companyCategories": {
            "title": "Company size category",
            "type": "array",
            "description": "Optional. `PME`, `ETI` or `GE` (INSEE company category).",
            "items": {
              "type": "string"
            }
          },
          "employeeBands": {
            "title": "Employee bands",
            "type": "array",
            "description": "Optional. INSEE employee band codes: `01` (1-2), `02` (3-5), `03` (6-9), `11` (10-19), `12` (20-49), `21` (50-99), `22` (100-199) and so on.",
            "items": {
              "type": "string"
            }
          },
          "headOfficeInArea": {
            "title": "Head office in area",
            "type": "boolean",
            "description": "The API's département and postcode filters also match companies that only have a branch there. On (default), only companies whose head office is in the area are kept.",
            "default": true
          },
          "onlyProspectable": {
            "title": "Only companies open to prospecting",
            "type": "boolean",
            "description": "On by default. A large share of Sirene records (a third to nine in ten, highest for recent registrations) carry an opposition to commercial prospecting use (GDPR article 21(2)); the field is `prospectingOptOut`. Those records and non-diffusible ones are never output; this switch also drops ceased companies.",
            "default": true
          },
          "findContacts": {
            "title": "Find website and email",
            "type": "boolean",
            "description": "Switched off for now: the website and email lookup returns after our contact enrichment is reviewed. Setting it has no effect; the run returns register data only and says so in its status message.",
            "default": false
          },
          "minDomainConfidence": {
            "title": "Minimum website confidence",
            "minimum": 0.1,
            "maximum": 0.99,
            "type": "number",
            "description": "Only with Find website and email. A company's website is accepted (and billed by the website finder) only at or above this confidence. 0.8 and above is high; raise it for precision, lower it to 0.3 to see more guesses.",
            "default": 0.5
          },
          "maxContactCompanies": {
            "title": "Max companies to look up",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Only used with Find website and email. At most this many companies are sent to the lookups; the rest come back with a note.",
            "default": 50
          },
          "maxItems": {
            "title": "Maximum companies",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop after this many companies (100 when empty). You pay per company returned.",
            "default": 100
          },
          "maxPagesScanned": {
            "title": "Maximum result pages to read",
            "minimum": 1,
            "maximum": 400,
            "type": "integer",
            "description": "Each page is 25 records, 400 is the API's ceiling. Reading pages is free; a date range or head-office check may need many pages to find enough matches.",
            "default": 400
          },
          "requestDelaySecs": {
            "title": "Pause between API requests",
            "minimum": 0.16,
            "maximum": 5,
            "type": "number",
            "description": "Seconds between requests to the register API. The API allows 7 requests a second per IP; 0.16 is the floor.",
            "default": 0.16
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}