{ "openapi": "3.0.1", "info": { "title": "World Bank Indicators Scraper", "description": "Macroeconomic and development data from the World Bank: 29,544 indicators across 217 countries. Flags the 78 aggregate rows the API mixes in with real countries, which otherwise overstate a global total roughly tenfold.", "version": "0.1", "x-build-id": "dbmqWCIIU5uk1cgXz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~worldbank-indicators-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-worldbank-indicators-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/scrapyx~worldbank-indicators-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-worldbank-indicators-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/scrapyx~worldbank-indicators-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-worldbank-indicators-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", "required": [ "indicators" ], "properties": { "indicators": { "title": "Indicator codes", "type": "array", "description": "World Bank indicator codes, e.g. NY.GDP.MKTP.CD (GDP, current US$), SP.POP.TOTL (population), FP.CPI.TOTL.ZG (inflation). 29,544 exist. Each runs as its own request — the API's ';' multi-indicator syntax silently returns only the first series.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "ISO codes, e.g. USA, IDN, BRA. Leave empty for every country AND every aggregate — see 'Include aggregates' below, which is the setting that matters most here.", "items": { "type": "string" } }, "includeAggregates": { "title": "Include aggregate rows (regions, income groups, 'World')", "type": "boolean", "description": "OFF by default. 78 of the API's 295 'countries' are actually aggregates — 'Arab World', 'Africa', 'High income', 'Euro area', 'World'. Summing a full series with them left in overstates a global total by roughly 10x. Every row carries isAggregate either way.", "default": false }, "yearFrom": { "title": "From year", "minimum": 1960, "maximum": 2100, "type": "integer", "description": "e.g. 2000. Mutually exclusive with 'Most recent values'." }, "yearTo": { "title": "To year", "minimum": 1960, "maximum": 2100, "type": "integer", "description": "e.g. 2024." }, "mostRecentValues": { "title": "Most recent values per country", "minimum": 1, "maximum": 60, "type": "integer", "description": "Return only the N latest observations per country. Enforced here as well as requested upstream — the World Bank CDN intermittently serves a cached response computed without it, returning more rows than asked for with nothing to say so." }, "skipMissingValues": { "title": "Drop observations with no value", "type": "boolean", "description": "Missing observations are common in this data and are NOT zeros. Off by default so gaps stay visible; every row carries hasValue.", "default": false }, "maxResultsPerIndicator": { "title": "Max results per indicator", "minimum": 0, "type": "integer", "description": "0 = unlimited.", "default": 1000 }, "pageSize": { "title": "Rows per request", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The API accepted 20,000 in testing, but 32,768 took over 90 seconds to answer — capped at 10,000 here because a page that large is a hang risk.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Requests in flight at once across all indicators.", "default": 3 }, "minRequestInterval": { "title": "Min seconds between request starts", "minimum": 0, "maximum": 30, "type": "number", "description": "Politeness pacing shared across all workers.", "default": 0.2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional and OFF by default. No WAF was observed on api.worldbank.org.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }