{ "openapi": "3.0.1", "info": { "title": "France Egapro Equality Index: Gender Pay Gap by Company", "description": "Official French gender equality index (Index Egapro) for every company and UES with 50+ employees: overall score out of 100, five indicator scores, headcount band, NAF, department, history since 2018. Pay per company.", "version": "1.0", "x-build-id": "AsW55E5pQyradKs9X" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~france-egapro-equality-index/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-france-egapro-equality-index", "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/datacraft-studio~france-egapro-equality-index/runs": { "post": { "operationId": "runs-sync-datacraft-studio-france-egapro-equality-index", "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/datacraft-studio~france-egapro-equality-index/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-france-egapro-equality-index", "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": { "sirens": { "title": "SIREN numbers", "type": "array", "description": "9-digit SIREN identifiers to look up (e.g. 632012100 for L'Oréal, 615680089 for DELABIE).", "items": { "type": "string" } }, "companyNameContains": { "title": "Company name contains", "type": "array", "description": "Keep companies whose name contains one of these strings (accent-insensitive).", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes (69, 2A, 974) or official names (Rhône, Nord).", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "Region names as published by Egapro (e.g. Île-de-France, Auvergne-Rhône-Alpes).", "items": { "type": "string" } }, "nafPrefixes": { "title": "NAF / APE prefixes", "type": "array", "description": "Keep companies whose NAF code starts with one of these prefixes (e.g. 62, 62.01, 49.41).", "items": { "type": "string" } }, "year": { "title": "Declaration year", "type": "string", "description": "Index year, e.g. 2025. Empty = latest year published in the official file." }, "headcountBands": { "title": "Headcount bands", "type": "array", "description": "Exact Egapro bands to keep, e.g. \"50 à 250\", \"251 à 999\", \"1000 et plus\".", "items": { "type": "string" } }, "structure": { "title": "Structure type", "enum": [ "any", "company", "ues" ], "type": "string", "description": "Company only, UES (economic and social unit) only, or both.", "default": "any" }, "minIndex": { "title": "Minimum index score", "type": "string", "description": "Only companies with an index ≥ this value (0-100)." }, "maxIndex": { "title": "Maximum index score", "type": "string", "description": "Only companies with an index ≤ this value (0-100)." }, "onlyWithIndex": { "title": "Only rows with a numeric index", "type": "boolean", "description": "Drop declarations where the index is NC / not calculable.", "default": false }, "belowThreshold": { "title": "Only below the legal threshold (< 75)", "type": "boolean", "description": "Only companies whose published index is strictly below 75 (corrective measures required).", "default": false }, "includeHistory": { "title": "Include yearly history", "type": "boolean", "description": "Attach previous years' index and pay-gap scores for each delivered SIREN, plus the 1-year change.", "default": true }, "allFrance": { "title": "All of France", "type": "boolean", "description": "Every declaration of the selected year (~30,000). Mind maxItems and your cost limit.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "indexAsc", "indexDesc", "nameAsc", "none" ], "type": "string", "description": "Sort delivered companies by index (lowest or highest first), by name, or keep file order.", "default": "indexAsc" }, "maxItems": { "title": "Max companies delivered", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on how many companies are charged and returned (default 1000, max 50000).", "default": 1000 } } }, "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 } } } } } } } } } }