{
  "openapi": "3.0.1",
  "info": {
    "title": "Pappers Sirene Scraper",
    "description": "Search French companies by text, filters, coordinates, or SIREN/SIRET. Export official company data with addresses, NAF codes, dirigeants, financials, establishments, Pappers links, and registry flags.",
    "version": "0.1",
    "x-build-id": "k7dfFaCwAdISct53y"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/maximedupre~pappers-sirene-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-maximedupre-pappers-sirene-scraper",
        "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/maximedupre~pappers-sirene-scraper/runs": {
      "post": {
        "operationId": "runs-sync-maximedupre-pappers-sirene-scraper",
        "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/maximedupre~pappers-sirene-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-maximedupre-pappers-sirene-scraper",
        "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": "Target mode",
            "enum": [
              "search",
              "lookup",
              "geo"
            ],
            "type": "string",
            "description": "Choose whether this run searches companies, enriches known identifiers, or searches around coordinates.",
            "default": "search"
          },
          "maxResults": {
            "title": "Maximum companies",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Maximum company rows to save across the run. Use a small value for the first run.",
            "default": 100
          },
          "query": {
            "title": "Search query",
            "type": "string",
            "description": "Use with Search mode. Enter a company name, business type, address term, or officer name."
          },
          "identifiers": {
            "title": "SIREN or SIRET identifiers",
            "uniqueItems": true,
            "type": "array",
            "description": "Use with Enrich mode. Add one SIREN or SIRET per line.",
            "items": {
              "type": "string",
              "minLength": 1
            }
          },
          "latitude": {
            "title": "Latitude",
            "type": "number",
            "description": "Use with Geo mode. Enter the center point latitude."
          },
          "longitude": {
            "title": "Longitude",
            "type": "number",
            "description": "Use with Geo mode. Enter the center point longitude."
          },
          "radiusKm": {
            "title": "Radius in kilometers",
            "minimum": 0.1,
            "maximum": 50,
            "type": "number",
            "description": "Search radius around the coordinates.",
            "default": 10
          },
          "departement": {
            "title": "Department code",
            "type": "string",
            "description": "Filter by French department code, such as `75` for Paris or `69` for Rhône."
          },
          "codePostal": {
            "title": "Postal code",
            "type": "string",
            "description": "Filter by a 5-digit postal code."
          },
          "region": {
            "title": "Region code",
            "type": "string",
            "description": "Filter by a 2-digit French region code, such as `11` for Île-de-France."
          },
          "codeCommune": {
            "title": "Commune code",
            "type": "string",
            "description": "Filter by INSEE commune code."
          },
          "activitePrincipale": {
            "title": "NAF activity code",
            "type": "string",
            "description": "Filter by NAF/APE code, such as `62.01Z` for software or `56.10A` for restaurants."
          },
          "sectionActivitePrincipale": {
            "title": "NAF section",
            "type": "string",
            "description": "Filter by one-letter NAF section, such as `J` for information and communication."
          },
          "etatAdministratif": {
            "title": "Administrative status",
            "enum": [
              "A",
              "C",
              "all"
            ],
            "type": "string",
            "description": "Choose active companies, ceased companies, or both statuses.",
            "default": "A"
          },
          "categorieEntreprise": {
            "title": "Company size category",
            "enum": [
              "PME",
              "ETI",
              "GE"
            ],
            "type": "string",
            "description": "Filter by official company size category."
          },
          "trancheEffectifSalarie": {
            "title": "Employee bracket code",
            "type": "string",
            "description": "Filter by INSEE employee bracket code, such as `21` for 50-99 employees."
          },
          "caMin": {
            "title": "Minimum revenue",
            "minimum": 0,
            "type": "integer",
            "description": "Filter by minimum reported revenue in euros."
          },
          "caMax": {
            "title": "Maximum revenue",
            "minimum": 0,
            "type": "integer",
            "description": "Filter by maximum reported revenue in euros."
          },
          "nomPersonne": {
            "title": "Officer last name",
            "type": "string",
            "description": "Find companies linked to an officer or elected person last name."
          },
          "prenomsPersonne": {
            "title": "Officer first name",
            "type": "string",
            "description": "Add a first name when you want a more precise people search."
          },
          "typePersonne": {
            "title": "Person type",
            "enum": [
              "dirigeant",
              "elu"
            ],
            "type": "string",
            "description": "Choose which kind of person relationship to search."
          },
          "estRge": {
            "title": "RGE certified companies",
            "type": "boolean",
            "description": "Return companies with RGE eco-construction certification.",
            "default": false
          },
          "estQualiopi": {
            "title": "Qualiopi certified companies",
            "type": "boolean",
            "description": "Return companies with Qualiopi training certification.",
            "default": false
          },
          "estBio": {
            "title": "Bio certified companies",
            "type": "boolean",
            "description": "Return companies with organic or bio certification.",
            "default": false
          },
          "estEss": {
            "title": "Social economy companies",
            "type": "boolean",
            "description": "Return companies in the social and solidarity economy.",
            "default": false
          },
          "estAssociation": {
            "title": "Associations",
            "type": "boolean",
            "description": "Return loi 1901 association records.",
            "default": false
          },
          "estOrganismeFormation": {
            "title": "Training organizations",
            "type": "boolean",
            "description": "Return registered training organizations.",
            "default": false
          },
          "estSocieteMission": {
            "title": "Mission-driven companies",
            "type": "boolean",
            "description": "Return société à mission records.",
            "default": false
          },
          "includeFinancialHistory": {
            "title": "Include financial history",
            "type": "boolean",
            "description": "Add year-by-year revenue and net result fields when the source provides them.",
            "default": true
          },
          "includeDirigeants": {
            "title": "Include officers",
            "type": "boolean",
            "description": "Add dirigeants and legal-person officers when the source provides them.",
            "default": true
          },
          "includeEstablishments": {
            "title": "Include establishments",
            "type": "boolean",
            "description": "Add establishment rows nested under each company when the source provides them.",
            "default": true
          },
          "establishmentsLimit": {
            "title": "Establishments per company",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum establishments to include under each company row.",
            "default": 10
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}