Do I need an API key to access World Bank data?

Many public datasets from the World Bank, especially World Development Indicators, are accessible without an API key. However, some advanced features, higher request limits, or specific restricted datasets may require account registration and API keys.

What data formats does the World Bank API support?

The World Bank API typically supports JSON, XML, and CSV formats for its data responses. You can specify your preferred format using the 'format' parameter in your API request URL.

How do I find specific indicator codes or country codes?

The World Bank provides comprehensive lists of all available indicators and countries, along with their respective codes, on its developer portal. These lists are essential for constructing accurate API queries.

Are there rate limits for World Bank API requests?

Yes, like most public APIs, the World Bank API has rate limits to ensure fair usage. If you exceed these limits, you will typically receive a 429 Too Many Requests HTTP status code. Authenticated users might have higher limits.

How do I handle pagination in World Bank API responses?

World Bank API responses often include pagination metadata, such as 'page', 'pages', and 'per_page'. You can use these parameters in subsequent requests to retrieve additional pages of data until all results are fetched.

Where can I find examples of World Bank API calls?

The World Bank developer portal features a dedicated section with API examples, demonstrating how to construct various queries for different datasets and use cases.

What should I do if my API request returns an error?

Check the HTTP status code and the response body for error messages. Common issues include incorrect URL syntax, invalid indicator/country codes, or rate limiting. Consult the World Bank's API documentation for specific error details and troubleshooting steps.

World Bank Getting Started: Data Access for Developers (2026)

Getting started overview

To begin working with World Bank data programmatically, developers typically interact with the World Bank's APIs. These APIs provide access to a wide range of global development data, including economic indicators, project details, and financial statistics. The primary entry point for developers is the World Bank's developer portal, which hosts documentation, tools, and access points for various datasets. The initial setup involves understanding the available data services, registering for an account if specific authenticated access is required, and then constructing API calls to retrieve desired information.

The World Bank provides several data access points, including the World Development Indicators (WDI) API, which offers comprehensive global statistics, and APIs for specific datasets like projects or finances. While much of the World Bank's public data is accessible without an API key, certain advanced features or higher rate limits may necessitate registration. Developers should consult the World Bank API overview to determine if their use case requires authentication.

This guide focuses on the general process for making your initial API calls, covering scenarios for both authenticated and unauthenticated access, depending on the specific World Bank API endpoint being used. Understanding the structure of the API endpoints and the parameters for filtering and formatting data is crucial for successful integration.

Create an account and get keys

For many public datasets available through the World Bank's APIs, an account and API keys are not strictly required. Developers can often directly query endpoints to retrieve data. For instance, basic requests to the World Development Indicators API for common indicators can be made without prior registration. This open access facilitates initial exploration and rapid prototyping.

However, if your application requires access to specific restricted datasets, higher request limits, or personalized features, creating an account on the World Bank developer portal may be necessary. The registration process typically involves providing an email address and creating a password. Upon successful registration, the portal might provide access to a dashboard where API keys can be generated and managed. These keys serve as credentials to authenticate your application when making requests to protected endpoints.

The World Bank's documentation specifies which APIs or endpoints require authentication. Developers should review the relevant API-specific documentation to confirm authentication requirements for their target data. If API keys are issued, they should be treated as sensitive information, similar to how other platforms, like Stripe API keys, are handled. Secure storage and transmission practices are recommended to prevent unauthorized access.

Quick Reference: Account and Key Setup

Step	What to do	Where
1. Determine Need	Check if your desired data requires authentication.	World Bank API Overview
2. Register (if needed)	Create a free account.	World Bank Developer Portal Registration
3. Generate API Keys (if needed)	Access your dashboard to generate or view keys.	Account Dashboard (post-registration)
4. Secure Keys	Store API keys securely; do not hardcode in client-side code.	Your application's environment configuration

Your first request

Making your first request to the World Bank API typically involves constructing a URL to a specific endpoint, specifying parameters for the data you want, and sending an HTTP GET request. For many common datasets, such as the World Development Indicators (WDI), you can start without an API key.

Let's consider an example using the WDI API to retrieve GDP per capita for a specific country over a few years. The base URL for the WDI API is http://api.worldbank.org/v2/. You then append the resource path and parameters.

Example: Retrieve GDP per capita for Brazil (BRA) for years 2010-2012.

The indicator code for GDP per capita (current US$) is NY.GDP.PCAP.CD. The country code for Brazil is BRA. We can specify the years using a range or comma-separated values.

GET http://api.worldbank.org/v2/country/BRA/indicator/NY.GDP.PCAP.CD?date=2010:2012&format=json

In this URL:

country/BRA specifies the country.
indicator/NY.GDP.PCAP.CD specifies the indicator.
date=2010:2012 filters the data for the years 2010 through 2012.
format=json requests the response in JSON format. Other formats like XML or CSV are also available.

You can execute this request using various tools:

Web Browser: Paste the URL directly into your browser's address bar. The browser will display the JSON response.

curl (Command Line): Open your terminal or command prompt and type:

curl "http://api.worldbank.org/v2/country/BRA/indicator/NY.GDP.PCAP.CD?date=2010:2012&format=json"

Programming Languages: Most programming languages have libraries for making HTTP requests. For example, in Python:

import requests

url = "http://api.worldbank.org/v2/country/BRA/indicator/NY.GDP.PCAP.CD?date=2010:2012&format=json"
response = requests.get(url)
data = response.json()
print(data)

The response will be a JSON array containing metadata and the requested data points. It's common for API responses to be paginated, so you might receive an initial page with links or parameters to fetch subsequent pages. The World Bank API examples page provides further illustration of various query types.

Common next steps

After successfully retrieving your first dataset from the World Bank API, several common next steps can help you expand your data integration and application development:

Explore More Indicators and Data Series: The World Bank offers thousands of indicators. Utilize the World Bank Indicators catalog to discover relevant data series. You can query the API for a list of available indicators or countries to build dynamic applications.
```
GET http://api.worldbank.org/v2/indicators?format=json
```
Implement Pagination: World Bank API responses are often paginated. Learn how to handle multiple pages of results by using the page and per_page parameters, and by parsing the pagination metadata in the API response. This is analogous to how pagination is handled in other large data APIs, such as PayPal's REST API pagination.
```
GET http://api.worldbank.org/v2/country/all/indicator/SP.POP.TOTL?date=2020&format=json&page=2&per_page=100
```
Filter and Aggregate Data: Experiment with advanced filtering options, such as specifying multiple countries, indicators, or date ranges. Some APIs may support aggregation functions directly, reducing the need for client-side processing.
```
GET http://api.worldbank.org/v2/country/US;CN/indicator/NY.GDP.MKTP.CD?date=2015:2020&format=json
```
Error Handling: Implement robust error handling in your application to gracefully manage API rate limits, invalid requests, or unavailable data. The API typically returns HTTP status codes (e.g., 400 for bad request, 404 for not found) and descriptive error messages in the response body.
Data Visualization and Integration: Once you have retrieved data, consider how to visualize it or integrate it into other applications. Tools for data analysis or dashboard creation can consume the JSON or CSV output from the API.
Explore Other World Bank APIs: Beyond the WDI, the World Bank offers APIs for projects, finances, and other specific datasets. Review the full list of World Bank APIs to find additional resources relevant to your development goals.
Stay Updated: The World Bank frequently updates its data and API capabilities. Subscribe to relevant newsletters or check the developer news page to stay informed about changes and new features.

Troubleshooting the first call

Encountering issues during your initial API calls is common. Here's a guide to troubleshooting typical problems when accessing the World Bank API:

HTTP Status Codes: Always check the HTTP status code returned with the API response. Common codes and their meanings:
- 200 OK: The request was successful.
- 400 Bad Request: The API could not understand the request, often due to malformed parameters or an invalid URL. Double-check your URL syntax, indicator codes, country codes, and date formats.
- 404 Not Found: The requested resource (e.g., a specific indicator or country) does not exist or the URL path is incorrect. Verify the indicator and country codes against the World Bank's official lists.
- 429 Too Many Requests: You have exceeded the API's rate limit. Wait for a period and try again, or implement exponential backoff in your application.
- 500 Internal Server Error: An unexpected error occurred on the World Bank's server. This usually indicates an issue on their end; try again later.
Incorrect Indicator or Country Codes: A common mistake is using an incorrect code for an indicator or country. The World Bank maintains comprehensive lists of indicators and countries with their respective codes. Ensure your codes match exactly.
Date Formatting Issues: The API expects specific date formats (e.g., YYYY for single years, YYYY:YYYY for ranges). Incorrect formatting can lead to 400 Bad Request errors. Refer to the World Bank API documentation on date parameters.
JSON Parsing Errors: If you receive a successful 200 OK response but your application fails to parse the JSON, verify that your parsing logic correctly handles the structure of the World Bank's API responses. Responses typically contain an array with metadata and the actual data. Tools like MDN Web Docs on HTTP Status Codes can provide general context for API responses.
Network Connectivity: Ensure your development environment has stable internet connectivity and that no firewall or proxy settings are blocking outgoing HTTP requests to api.worldbank.org.
Authentication Problems (if applicable): If you are using an API key and encounter authentication errors, double-check that your key is correctly included in the request headers or parameters as specified in the World Bank's authentication guide. Ensure the key has the necessary permissions for the data you are trying to access.
Consult Documentation and Community: The World Bank developer portal is the authoritative source for API documentation. Additionally, check their developer forum for common issues and solutions, or post your question if you can't find an existing answer.