{
  "openapi": "3.0.1",
  "info": {
    "title": "ADGM Public Register Scraper - Abu Dhabi Companies & Directors",
    "description": "Export entities from the ADGM (Abu Dhabi Global Market) Public Register: name, registration number, status, type, category, licence status and expiry, address, trade names, business activities, directors, secretaries, shareholders, members, partners, filings. Search, whole register, newest, monitor.",
    "version": "0.1",
    "x-build-id": "tZp14MxjEmHBc7pdQ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapersdelight~adgm-public-register-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapersdelight-adgm-public-register-scraper",
        "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/scrapersdelight~adgm-public-register-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapersdelight-adgm-public-register-scraper",
        "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/scrapersdelight~adgm-public-register-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapersdelight-adgm-public-register-scraper",
        "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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "register",
              "newest"
            ],
            "type": "string",
            "description": "Search = the names, numbers or links in Search terms. Whole register = every entity matching the filters below (about 19,100 with no filters). Newest = most recently incorporated first (up to 3,000).",
            "default": "register"
          },
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Used in Search mode. Each line is an entity or trade name or part of one (e.g. \"capital\"), a registration number (e.g. \"000009292\", \"22086\", \"TL-000000600\") or a newreg.adgm.com entity link.",
            "items": {
              "type": "string"
            }
          },
          "registerType": {
            "title": "Register",
            "enum": [
              "any",
              "Company",
              "Foundation",
              "Partnership",
              "Permit"
            ],
            "type": "string",
            "description": "The register's own Register filter: companies (including branches and RSCs), foundations, partnerships, or temporary permits only.",
            "default": "any"
          },
          "statuses": {
            "title": "Entity status",
            "type": "array",
            "description": "Only entities with these register statuses (e.g. Registered). Empty = every status.",
            "items": {
              "type": "string",
              "enum": [
                "Registered",
                "Deregistered",
                "Dissolved",
                "Expired",
                "Deregistered by Registrar",
                "Registration Inactive",
                "In Liquidation",
                "Continued outside ADGM",
                "Issued",
                "In administration"
              ]
            },
            "default": []
          },
          "categories": {
            "title": "Category",
            "type": "array",
            "description": "Only entities in these categories (Financial = FSRA-regulated firms). Empty = every category.",
            "items": {
              "type": "string",
              "enum": [
                "Financial (Category A)",
                "Non-Financial (Category B)",
                "Retail (Category C)"
              ]
            },
            "default": []
          },
          "continuedOnly": {
            "title": "Continued into ADGM only",
            "type": "boolean",
            "description": "Only entities that re-domiciled into ADGM from another jurisdiction (the register's \"Is continued?\" filter).",
            "default": false
          },
          "incorporatedFrom": {
            "title": "Incorporated on or after",
            "type": "string",
            "description": "Only entities incorporated on or after this date: YYYY-MM-DD or a period such as \"30 days\". Empty = no lower bound."
          },
          "incorporatedTo": {
            "title": "Incorporated on or before",
            "type": "string",
            "description": "Only entities incorporated on or before this date: YYYY-MM-DD or a period such as \"1 year\". Empty = no upper bound."
          },
          "entityTypes": {
            "title": "Entity type",
            "type": "array",
            "description": "Only these legal forms (e.g. Branch of a Foreign Company). Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "Private Company Limited By Shares",
                "Restricted Scope Company",
                "Branch of a Foreign Company",
                "Foundation",
                "Permit",
                "Limited Partnership",
                "Private Company Limited by Guarantee",
                "Branch of Foreign Limited Liability Partnership",
                "Limited Liability Partnership",
                "Public Company Limited by Shares",
                "Private Company Unlimited without Shares",
                "DLT Foundation",
                "Private Company Unlimited with Shares",
                "Branch of a Foreign Partnership",
                "Branch of Foreign Limited Partnership"
              ]
            },
            "default": []
          },
          "licenseStatuses": {
            "title": "Licence status",
            "type": "array",
            "description": "Only entities whose commercial licence has one of these statuses. Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "Licensed",
                "License cancelled",
                "Expired"
              ]
            },
            "default": []
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Keep an entity only if its name, a trade name or (with details on) a business activity contains one of these words (e.g. \"fund\", \"6420\", \"consultancy\"). Empty = no keyword filter.",
            "items": {
              "type": "string"
            }
          },
          "includeDetails": {
            "title": "Include directors, shareholders & filings",
            "type": "boolean",
            "description": "Adds directors, secretaries, shareholders, members or partners, business activities, licence expiry, Arabic address, previous names, status history and filings. One extra call per entity.",
            "default": true
          },
          "monitorMode": {
            "title": "Monitor mode",
            "enum": [
              "off",
              "new",
              "changes"
            ],
            "type": "string",
            "description": "New = only entities no earlier run delivered (new registrations). Changes = new entities plus entities whose status, name, licence status, type, category, address or trade names changed.",
            "default": "off"
          },
          "monitorStoreName": {
            "title": "Monitor memory name",
            "type": "string",
            "description": "Name of the storage that remembers delivered entities. Use a different name for each separate schedule. Empty = the default store."
          },
          "skipExistingOnFirstRun": {
            "title": "First run: record only",
            "type": "boolean",
            "description": "With a monitor on: the first run records the entities in scope without delivering or charging them, so later runs deliver only what is new or changed.",
            "default": false
          },
          "resetMonitor": {
            "title": "Reset monitor memory",
            "type": "boolean",
            "description": "Forget what earlier runs delivered for this scope and start again.",
            "default": false
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "Any HTTPS endpoint that accepts a JSON POST: receives the run's delivered entities (up to 100) when the run delivers at least one."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "A Slack incoming-webhook URL: posts a short list of the delivered entities when the run delivers at least one."
          },
          "teamsWebhookUrl": {
            "title": "Microsoft Teams webhook URL",
            "type": "string",
            "description": "A Teams Workflows webhook URL (\"When a Teams webhook request is received\"): posts an Adaptive Card listing the delivered entities."
          },
          "maxResults": {
            "title": "Max entities",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many entities are delivered. 0 = no limit (the whole register is about 19,100 entities).",
            "default": 40
          },
          "compact": {
            "title": "Compact output",
            "type": "boolean",
            "description": "One value per column (officer names joined, no history arrays or filings list): smaller rows for spreadsheets and AI/MCP pipelines.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "Entity pages read at once (1-12). The default 6 reads about one entity a second with details.",
            "default": 6
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Requests go out directly first. This proxy (default: residential, UAE) is used only if the register refuses a direct request, with a small per-run spending cap.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "AE"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}