{ "openapi": "3.0.1", "info": { "title": "UK Solicitor & Law Firm Register (SRA)", "description": "Search every law firm on the Solicitors Regulation Authority register: status, offices, phone, email, website, areas of law, company number. Filter by name, location, postcode or practice area, or watch for new, closed and intervened firms. Includes data supplied by the SRA.", "version": "1.0", "x-build-id": "fxaRG3bJOkV7KKDW4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/onibaku~uk-solicitor-firms/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-onibaku-uk-solicitor-firms", "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/onibaku~uk-solicitor-firms/runs": { "post": { "operationId": "runs-sync-onibaku-uk-solicitor-firms", "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/onibaku~uk-solicitor-firms/run-sync": { "post": { "operationId": "run-sync-onibaku-uk-solicitor-firms", "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": { "searchTerms": { "title": "Firm name contains (any of)", "type": "array", "description": "Matched against the practice name, trading names, previous names and office names, case-insensitive. Leave empty for every firm.", "items": { "type": "string" } }, "locations": { "title": "Locations (any of)", "type": "array", "description": "A postcode area (LS), district (M1, SW1A) or full postcode, or part of a town, county or address (Manchester, Kent). A firm matches if any of its offices does.", "items": { "type": "string" } }, "areasOfLaw": { "title": "Areas of law (any of)", "type": "array", "description": "Part of an area of law the firm lists, e.g. \"Family\", \"Immigration\", \"Personal Injury\", \"Property - Residential\", \"Employment\", \"Criminal\". Firms that list no areas are left out when this is set.", "items": { "type": "string" } }, "statuses": { "title": "Status", "type": "array", "description": "Which firms to include. Authorised = currently authorised by the SRA (the default). Not separately authorised covers freelance solicitors and in-house legal teams.", "items": { "type": "string", "enum": [ "authorised", "closing", "closed", "intervened", "not-separately-authorised" ], "enumTitles": [ "Authorised", "Closure in progress", "Closed", "Intervened by the SRA", "Not separately authorised (freelance, in-house)" ] }, "default": [ "authorised" ] }, "sraNumbers": { "title": "SRA numbers", "type": "array", "description": "Look up specific firms by SRA number (a firm's or one of its offices').", "items": { "type": "string" } }, "companyNumbers": { "title": "Companies House numbers", "type": "array", "description": "Look up firms by company registration number, e.g. OC327261 or 01234567.", "items": { "type": "string" } }, "oneRowPerOffice": { "title": "One row per office", "type": "boolean", "description": "Return each office (head office and branches) as its own row instead of one row per firm with an offices list. With locations set, only the offices in those locations are returned.", "default": false }, "onlyChanges": { "title": "Only new, changed and removed firms", "type": "boolean", "description": "Remembers the firms each run returned (per set of filters) and next time returns only firms that are new, changed (status, name, offices, contact details, areas of law) or gone. Use with a schedule to monitor firms. The first run returns every match.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many rows.", "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 } } } } } } } } } }