{
"openapi": "3.0.1",
"info": {
"title": "SiteVerdict — UK Gender Pay Gap Data & Benchmarks",
"description": "Official UK gender pay gap data (all years since 2017): employer search by name or company number, year-by-year trends, sector benchmarks and percentiles, possibly-missing filings, monitoring alerts and CSV export. Open data (OGL), no key needed.",
"version": "1.1",
"x-build-id": "1Gt70XNNeWdkZULxb"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/siteverdict~siteverdict-uk-gender-pay-gap/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-uk-gender-pay-gap",
"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/siteverdict~siteverdict-uk-gender-pay-gap/runs": {
"post": {
"operationId": "runs-sync-siteverdict-siteverdict-uk-gender-pay-gap",
"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/siteverdict~siteverdict-uk-gender-pay-gap/run-sync": {
"post": {
"operationId": "run-sync-siteverdict-siteverdict-uk-gender-pay-gap",
"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": {
"employers": {
"title": "Employers",
"type": "array",
"description": "One per line: an employer name (Tesco), a Companies House number (00445790, SC016876) or a service id (id:19070). Max 500.",
"items": {
"type": "string"
}
},
"sectors": {
"title": "Sectors to benchmark",
"type": "array",
"description": "SIC 2007 section letter (J = information and communication), a 2-5 digit SIC prefix (62, 64191), public or all. Max 50.",
"items": {
"type": "string"
}
},
"yearFrom": {
"title": "From snapshot year",
"minimum": 2017,
"maximum": 2100,
"type": "integer",
"description": "Snapshot year (2017 = reporting year 2017 to 2018). Default: 4 years before 'To'."
},
"yearTo": {
"title": "To snapshot year",
"minimum": 2017,
"maximum": 2100,
"type": "integer",
"description": "Default: the latest year whose reporting deadline (5 April the next year) has passed."
},
"maxMatchesPerQuery": {
"title": "Matches per employer query",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Name searches can match several legal entities (e.g. Tesco Stores Ltd and Tesco PLC). Each match is one employer report.",
"default": 1
},
"checkMissingFilings": {
"title": "Flag possibly-missing filings",
"type": "boolean",
"description": "Flags employers that filed the previous year (250+ staff) but have no filing after this year's deadline. A heuristic, not proof of non-compliance.",
"default": true
},
"missingFilingsScope": {
"title": "Check missing filings for",
"enum": [
"matched",
"sectors"
],
"type": "string",
"description": "Only the matched employers, or every employer in the sectors above.",
"default": "matched"
},
"minSizeForMissing": {
"title": "Minimum previous size band",
"enum": [
"250 to 499",
"500 to 999",
"1000 to 4999",
"5000 to 19,999",
"20,000 or more"
],
"type": "string",
"description": "Only flag employers whose last filing reported at least this size.",
"default": "250 to 499"
},
"monitorMode": {
"title": "Monitor mode (alert on new or amended filings)",
"type": "boolean",
"description": "Remembers the matched employers' filings in a named key-value store and reports new filings and amended figures on later (scheduled) runs. The first run saves a baseline.",
"default": false
},
"stateStoreName": {
"title": "State store name",
"type": "string",
"description": "Named key-value store that keeps the monitor state between runs.",
"default": "siteverdict-gpg-monitor"
},
"webhookUrl": {
"title": "Webhook URL (https)",
"type": "string",
"description": "We POST a JSON digest of alerts here (Zapier, Make, n8n, your API). Stored encrypted, never logged."
},
"slackWebhookUrl": {
"title": "Slack incoming webhook URL",
"type": "string",
"description": "https://hooks.slack.com/services/... Stored encrypted, never logged."
},
"exportCsv": {
"title": "Save CSV exports",
"type": "boolean",
"description": "Saves employer-reports.csv and sector-benchmarks.csv to the run's key-value store.",
"default": true
},
"aiProvider": {
"title": "AI brief (optional, your own key)",
"enum": [
"none",
"anthropic",
"openai"
],
"type": "string",
"description": "Adds a short analyst brief written by your own Anthropic or OpenAI account. Off by default; we never use our own key.",
"default": "none"
},
"aiApiKey": {
"title": "AI API key",
"type": "string",
"description": "Your own key. Stored encrypted, never logged or output."
},
"aiModel": {
"title": "AI model (optional)",
"type": "string",
"description": "Default: claude-sonnet-5-5 (Anthropic) or gpt-4.1-mini (OpenAI)."
},
"includePersonalData": {
"title": "Include 'responsible person' names",
"type": "boolean",
"description": "The files name the senior person who confirmed each filing. Off by default (UK GDPR data minimisation). Only enable if you have a lawful basis.",
"default": false
},
"sampleMode": {
"title": "Sample mode (no network, free)",
"type": "boolean",
"description": "Replays a small extract of the official files (2022-2025) to show every output type. Nothing is charged.",
"default": 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
}
}
}
}
}
}
}
}
}
}