{ "openapi": "3.0.1", "info": { "title": "UK Gender Pay Gap Lookup: Employer Figures by Year", "description": "Look up UK gender pay gap reporting figures by employer name or company number: hourly wage and bonus pay gap percentages, quartiles, and submission history from gender-pay-gap.service.gov.uk.", "version": "1.0", "x-build-id": "4fKZtkh8yEQpYAdFU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~uk-gender-pay-gap-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-uk-gender-pay-gap-lookup", "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/accountable_eel~uk-gender-pay-gap-lookup/runs": { "post": { "operationId": "runs-sync-accountable_eel-uk-gender-pay-gap-lookup", "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/accountable_eel~uk-gender-pay-gap-lookup/run-sync": { "post": { "operationId": "run-sync-accountable_eel-uk-gender-pay-gap-lookup", "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", "required": [ "employers" ], "properties": { "employers": { "title": "Employer names or company numbers", "type": "array", "description": "One UK employer name or Companies House number per line (e.g. \"Tesco\", \"Barclays\", \"08514605\"). Prefix matching finds all registered entities. Accepted formats: Tesco, Barclays, 08514605. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "years": { "title": "Reporting snapshot years", "type": "array", "description": "UK gender pay gap reporting snapshot years to check (for example 2024, 2023, 2022). 2024 covers the 2024 to 2025 reporting cycle. Defaults to 2024.", "items": { "type": "string" } }, "maxItems": { "title": "Max records per search", "type": "integer", "description": "Maximum matching employer records to return per employer name (default 10, max 100).", "default": 10 }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "queryEmployer", "matchedCount", "matchType", "reports", "employerName", "employerId", "companyNumber", "year", "diffMeanHourlyPercent", "diffMedianHourlyPercent", "diffMeanBonusPercent", "diffMedianBonusPercent", "maleBonusPercent", "femaleBonusPercent", "maleLowerQuartile", "femaleLowerQuartile", "maleLowerMiddleQuartile", "femaleLowerMiddleQuartile", "maleUpperMiddleQuartile", "femaleUpperMiddleQuartile", "maleTopQuartile", "femaleTopQuartile", "employerSize", "sicCodes", "address", "postcode", "currentName", "submittedAfterTheDeadline", "dueDate", "dateSubmitted", "companyLinkToGpgInfo", "reportFileUrl", "sourceUrl" ], "enumTitles": [ "Query employer", "Matching records count", "Match type", "All reports (full array)", "Registered employer name", "Employer ID", "Company number", "Reporting snapshot year", "Mean hourly pay gap %", "Median hourly pay gap %", "Mean bonus gap %", "Median bonus gap %", "Male receiving bonus %", "Female receiving bonus %", "Male lower pay quartile %", "Female lower pay quartile %", "Male lower-middle quartile %", "Female lower-middle quartile %", "Male upper-middle quartile %", "Female upper-middle quartile %", "Male top pay quartile %", "Female top pay quartile %", "Employer employee size", "SIC industry codes", "Registered address", "Postcode", "Current organisation name", "Submitted after deadline", "Submission deadline", "Date submitted", "Company gender pay gap report URL", "Annual dataset source file", "Source service URL" ] }, "default": [ "queryEmployer", "matchedCount", "matchType", "reports", "employerName", "employerId", "companyNumber", "year", "diffMeanHourlyPercent", "diffMedianHourlyPercent", "diffMeanBonusPercent", "diffMedianBonusPercent", "maleBonusPercent", "femaleBonusPercent", "maleLowerQuartile", "femaleLowerQuartile", "maleLowerMiddleQuartile", "femaleLowerMiddleQuartile", "maleUpperMiddleQuartile", "femaleUpperMiddleQuartile", "maleTopQuartile", "femaleTopQuartile", "employerSize", "sicCodes", "address", "postcode", "currentName", "submittedAfterTheDeadline", "dueDate", "dateSubmitted", "companyLinkToGpgInfo", "reportFileUrl", "sourceUrl" ] }, "expandRows": { "title": "One row per report (recommended) — turn off for one row per employer search instead", "type": "boolean", "description": "When on, each report found gets its own row instead of being grouped under its employer search. You're still only charged once per employer search, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. This target is a free public API that needs no proxy — defaults to off, but you can turn one on if you prefer.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }