{ "openapi": "3.0.1", "info": { "title": "GB Gambling Business Register: Licence and Domain Check", "description": "Check gambling licences, operators, trading names and domains on the Gambling Commission's register of gambling businesses for Great Britain, as published. Dated register changes after a 15-day hold, from about 17 Nov. Lookup, search or a scheduled changes run. Not affiliated with the Commission.", "version": "0.1", "x-build-id": "kDeodIOLsvTLxkuzG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yappman~gambling-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yappman-gambling-register", "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/yappman~gambling-register/runs": { "post": { "operationId": "runs-sync-yappman-gambling-register", "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/yappman~gambling-register/run-sync": { "post": { "operationId": "run-sync-yappman-gambling-register", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "lookup", "search", "changes" ], "type": "string", "description": "lookup: entries matching your account numbers, licence numbers, domains or trading names; search: entries matching filters; changes: register changes released since a date, or since your last run.", "default": "lookup" }, "accountNumbers": { "title": "Account numbers (lookup; changes filter)", "maxItems": 500, "type": "array", "description": "Up to 500 Commission account numbers (digits). In changes mode, only changes to these accounts.", "items": { "type": "string" } }, "licenceNumbers": { "title": "Licence numbers (lookup)", "maxItems": 500, "type": "array", "description": "Up to 500 licence numbers, as the register shows them.", "items": { "type": "string" } }, "domainNames": { "title": "Domain names (lookup)", "maxItems": 500, "type": "array", "description": "Up to 500 domains. A leading http:// or https://, a leading www. and a trailing / are removed from what you type, and the comparison ignores case; it matches a published domain equal to it or to www. plus it. Published values are returned exactly as published.", "items": { "type": "string" } }, "tradingNames": { "title": "Trading names (lookup)", "maxItems": 100, "type": "array", "description": "Up to 100 trading names, matched exactly after ignoring case and repeated spaces.", "items": { "type": "string" } }, "withAccount": { "title": "Also return each account's businesses entry", "type": "boolean", "description": "Off by default. When on, each matching account's entry in the businesses file is returned as well, as its own row, and each such row is charged as one entry.", "default": false }, "nameContains": { "title": "Name contains (search)", "type": "string", "description": "At least 3 characters; matched, ignoring case, in Licence Account Name and Trading Name." }, "activity": { "title": "Activity (search)", "type": "string", "description": "A licence Activity exactly as the register words it (case is ignored). Licence entries only." }, "status": { "title": "Status (search)", "type": "string", "description": "A Status exactly as the register words it (case is ignored). Licence, trading name and domain entries." }, "type": { "title": "Type (search)", "type": "string", "description": "A licence Type exactly as the register words it (case is ignored). Licence entries only." }, "files": { "title": "Files (search, changes)", "type": "array", "description": "Limit to some of the four business register files.", "items": { "type": "string", "enum": [ "businesses", "licences", "trading-names", "domain-names" ] } }, "exportAll": { "title": "Export everything (search)", "type": "boolean", "description": "Search with no filter: every entry in the chosen files, up to Max entries. Each entry returned is charged.", "default": false }, "maxItems": { "title": "Max entries (search)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "At most this many entries (1 to 10,000). Each entry returned is charged.", "default": 1000 }, "since": { "title": "Since (changes)", "type": "string", "description": "Changes released on or after this date (YYYY-MM-DD), at most 92 days back and not before the start of our change history (RUN_SUMMARY historyStart). Changes are released 15 days after we first see them." }, "alertStore": { "title": "Saved store name (changes)", "type": "string", "description": "The NAME of a key-value store in your own account (3 to 63 lower-case letters, digits or hyphens). Each run returns the changes released since the previous run that used it. A store id is refused. Use one run per saved store at a time: two runs on the same store at once can deliver, and charge for, the same changes." }, "kinds": { "title": "Kinds of change (changes)", "type": "array", "description": "Limit to some kinds of register change.", "items": { "type": "string", "enum": [ "entry added", "entry no longer listed", "entry changed", "entry listed again", "entry reverted" ] } } } }, "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 } } } } } } } } } }