{ "openapi": "3.0.1", "info": { "title": "NZ Doctor Register Scraper", "description": "Search and browse the Medical Council of New Zealand (MCNZ) public Register of Doctors - filter by name, town/city, specialty, and registration status.", "version": "1.0", "x-build-id": "w7FaHIRRin2vaWauD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~nz-doctor-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-nz-doctor-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/crawlerbros~nz-doctor-register-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-nz-doctor-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/crawlerbros~nz-doctor-register-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-nz-doctor-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": { "keyword": { "title": "Name or registration keyword", "type": "string", "description": "Free-text search across doctor names (first, last, previous names). Leave blank to browse using only the filters below." }, "location": { "title": "Location (town / city)", "enum": [ "", "akaroa", "alexandra", "amberley", "arrowtown", "ashburton", "auckland", "aukland", "balclutha", "blenheim", "bluff", "brighton", "bulls", "cambridge", "cheviot", "christchurch", "christchurch-central", "christchurch-city", "clyde", "coopers-beach", "coromandel", "cromwell", "dannevirke", "darfield", "dargaville", "dunedin", "edgecumbe", "edgeware-health", "fairlie", "featherston", "feilding", "flaxmere", "foxton", "gisborne", "gore", "great-barrier-island", "greymouth", "greytown", "hamilton", "hanmer-springs", "haruru", "hastings", "havelock", "havelock-north", "hawera", "hawkes-bay", "henderson", "hikurangi", "hokitika", "invercargill", "kaeo", "kaiapoi", "kaikohe", "kaikoura", "kaitaia", "kataia", "katikati", "kawakawa", "kawerau", "kawhia", "kerikeri", "kumeu", "kurow", "leeston", "levin", "lincoln", "little-river", "lower-hutt", "lyttelton", "mangawhai", "mangonui", "manukau", "manukau-city", "mapua", "martinborough", "masterton", "matamata", "methven", "morrinsville", "mosgiel", "motueka", "mount-maunganui", "murupara", "napier", "nelson", "new-plymouth", "ngaruawahia", "north-shore-city", "northland", "not-available", "oakura", "oamaru", "ohope", "omokoroa", "onerahi", "opotiki", "orewa", "otaki", "otane", "otautau", "otorohanga", "outram", "overseas", "paekakariki", "paeroa", "paihia", "palmerston-north", "papakura", "papamoa", "papamoa-beach", "paraparaumu", "picton", "porirua", "port-chalmers", "pukekohe", "qatar", "queenstown", "raetihi", "raglan", "rakaia", "rangiora", "rawene", "red-beach", "renwick", "richmond", "rolleston", "rotorua", "roxburgh", "ruakaka", "silverdale", "stratford", "strathern", "takaka", "takanini", "tasman", "taumarunui", "taupo", "tauranga", "te-anau", "te-aroha", "te-awamutu", "te-kaha", "te-kauwhata", "te-kuiti", "te-puia-springs", "te-puke", "temuka", "thames", "timaru", "tokomaru-bay", "tokoroa", "tuakau", "turangi", "twizel", "upper-hutt", "upper-moutere", "victoria", "waiheke-island", "waihi", "waihi-beach", "waikanae", "waikari", "waikato", "waimauku", "waipawa", "waipukurau", "wairoa", "waitakere", "waitara", "waiuku", "wakefield", "wanaka", "warkworth", "wellington", "wellsford", "westport", "whakatane", "whangamata", "whanganui", "whangaparaoa", "whangarei", "whitianga" ], "type": "string", "description": "Restrict results to doctors whose recorded practice location matches this New Zealand town or city.", "default": "" }, "specialty": { "title": "Type of medicine (specialty)", "enum": [ "", "anaesthesia", "cardiothoracic-surgery", "clinical-genetics", "dermatology", "diagnostic-and-interventional-radiology", "emergency-medicine", "family-planning-and-reproductive-health", "general-practice", "general-surgery", "intensive-care-medicine", "internal-medicine", "medical-administration", "musculoskeletal-medicine", "neurosurgery", "obstetrics-and-gynaecology", "occupational-medicine", "ophthalmology", "oral-and-maxillofacial-surgery", "orthopaedic-surgery", "otolaryngology-head-and-neck-surgery", "paediatric-surgery", "paediatrics", "pain-medicine", "palliative-medicine", "pathology", "plastic-and-reconstructive-surgery", "psychiatry", "public-health-medicine", "radiation-oncology", "rehabilitation-medicine", "rural-hospital-medicine", "sexual-health-medicine", "sport-and-exercise-medicine", "urgent-care", "urology", "vascular-surgery" ], "type": "string", "description": "Restrict results to doctors registered in this vocational scope / specialty area.", "default": "" }, "status": { "title": "Registration status", "enum": [ "", "inactive", "not-practising", "practising", "suspended" ], "type": "string", "description": "Restrict results to doctors with this current registration status.", "default": "" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on the number of doctor records emitted in this run. MCNZ's own register never serves more than 1000 results for a single query, regardless of how many total matches it reports — narrow the location/specialty/status filters to reach doctors beyond the first 1000 matches.", "default": 50 } } }, "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 } } }, "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 } } } } } } } } } }