{ "openapi": "3.0.1", "info": { "title": "City + Nearby + Capitals + Population + Geocoding Api", "description": "Search, filter, and explore **4.4 million+ cities worldwide** — get population data, find nearby cities, discover capitals, and more. Lightning-fast results with zero setup.", "version": "0.0", "x-build-id": "FQ1CSFLeolCGX5Mfb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happitap~city-nearby-capitals-population-geocoding-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happitap-city-nearby-capitals-population-geocoding-api", "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/happitap~city-nearby-capitals-population-geocoding-api/runs": { "post": { "operationId": "runs-sync-happitap-city-nearby-capitals-population-geocoding-api", "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/happitap~city-nearby-capitals-population-geocoding-api/run-sync": { "post": { "operationId": "run-sync-happitap-city-nearby-capitals-population-geocoding-api", "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": [ "searchMode" ], "properties": { "searchMode": { "title": "Search Mode", "enum": [ "CITY_SEARCH", "NEARBY_CITIES", "COUNTRY_CITIES", "CAPITAL_CITIES", "TOP_CITIES_BY_POPULATION" ], "type": "string", "description": "Choose how to search for cities", "default": "CITY_SEARCH" }, "cityName": { "title": "City Name", "type": "string", "description": "City name to search for (supports partial matching). Used in CITY_SEARCH mode." }, "countryName": { "title": "Country Name", "type": "string", "description": "Filter by country name (e.g., 'United States', 'India'). Used in CITY_SEARCH, COUNTRY_CITIES, and TOP_CITIES_BY_POPULATION modes." }, "countryCode": { "title": "Country Code (ISO2)", "type": "string", "description": "Filter by ISO2 country code (e.g., 'US', 'IN', 'GB'). Alternative to countryName." }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Latitude for NEARBY_CITIES search (e.g., 40.7128 for New York)" }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Longitude for NEARBY_CITIES search (e.g., -74.0060 for New York)" }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 500, "type": "number", "description": "Search radius in kilometers for NEARBY_CITIES mode", "default": 50 }, "minPopulation": { "title": "Minimum Population", "minimum": 0, "type": "integer", "description": "Filter cities with population greater than or equal to this value" }, "maxPopulation": { "title": "Maximum Population", "minimum": 0, "type": "integer", "description": "Filter cities with population less than or equal to this value" }, "minRanking": { "title": "Minimum Ranking", "minimum": 1, "maximum": 5, "type": "integer", "description": "Filter by minimum city ranking (1=largest, 5=smallest). Lower ranking = bigger city." }, "maxRanking": { "title": "Maximum Ranking", "minimum": 1, "maximum": 5, "type": "integer", "description": "Filter by maximum city ranking (1=largest, 5=smallest)" }, "timezone": { "title": "Timezone", "type": "string", "description": "Filter by timezone (e.g., 'America/New_York', 'Asia/Kolkata')" }, "capitalOnly": { "title": "Capital Cities Only", "type": "boolean", "description": "Return only capital cities (primary, admin, minor)", "default": false }, "capitalType": { "title": "Capital Type", "enum": [ "all", "primary", "admin", "minor" ], "type": "string", "description": "Filter by capital type. Used in CAPITAL_CITIES mode.", "default": "primary" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of results to return", "default": 100 }, "sortBy": { "title": "Sort By", "enum": [ "city", "population", "density", "ranking", "country" ], "type": "string", "description": "Sort results by a field", "default": "population" }, "sortOrder": { "title": "Sort Order", "enum": [ "ASC", "DESC" ], "type": "string", "description": "Sort direction", "default": "DESC" } } }, "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 } } } } } } } } } }