ADB.org Terms of Use Contact

Key Indicators Application Programming Interface

The Key Indicators Application Programming Interface (API) is a universal web-based service that provides access to the data and metadata available in the Key Indicators Database, using any computer language or platform. The API transforms Key Indicators data into a standardized Statistical Data and Metadata eXchange (SDMX) format through SDMX-ML (XML) or JavaScript Object Notation (JSON) outputs. The API endpoints shown below further describe how to use and modify internet requests to connect to the Key Indicators Database and retrieve either metadata or actual database records.

Data were last updated on 10 September 2019. The data are updated annually in line with the release of Key Indicators for Asia and the Pacific.

Basic call structure

There are two types of end-points - one is for retrieving KI metadata, and another for retrieveing actual KI data. The following SDMX response formats are supported in this API.

XML format:

By default, requests are downloaded as .XML files. To attempt to view XML code in the browser, append the format=xml URL parmeter on the SDMX data query request

JSON format:

To request data in JSON format, just append the input_format=json parmeter on the SDMX data query request

Metadata end-points

Metadata provides users with more information about the data structures such as data sources, units of measurement, or frequency, just to name a few.

Dataflow
Retrieves the unique dataset code for the KI dataset. - View More
GET  https://kidb.adb.org/api
Copy  
Implementation Notes
retrieves the dimensions for the KI dataset

Response Format
SDMX-ML (XML), SDMX-JSON

HTTP Response
Success Status Code: 200
Content: The response has the code list for the KI dataset

Sample Response Schema
Sample Response Values
Data Structure Definition (DSD)
Retrieves the DSD for the KI dataset - View More
GET  https://kidb.adb.org/api
Copy  
Implementation Notes
Retrieves the DSD for the KI dataset

Response Format
SDMX-ML (XML), SDMX-JSON

HTTP Response
Success Status Code: 200
Content: The response has the code list for the KI dataset

Sample Response
Sample Response Value
Concept Scheme
Retrieves the concepts for the KI dataset - View More
GET  https://kidb.adb.org/api
Copy  
Implementation Notes
Retrieves the concept schemes for the KI dataset

Response Format
SDMX-ML (XML), SDMX-JSON

HTTP Response
Success Status Code: 200
Content: The response has the code list for the KI dataset

Sample Response
Sample Response Value
Code List
Retrieves the code lists for the KI dataset - View More
GET  https://kidb.adb.org/api
Copy  
Implementation Notes
Retrieves the code list for the KI dataset

Response Format
SDMX-ML (XML), SDMX-JSON

HTTP Response
Success Status Code: 200
Content: The response has the code list for the KI dataset

Sample Response
Sample Response Value

Database end-points

The SDMX API can programmatically access the database and indicators that are available in the KI database.

Indicators
These end-points retrieve the KI dataset - View More
GET  https://kidb.adb.org/api
Copy  
Implementation Notes
This end-point requires {indicator} SDMX code to return the corresponding KI indicator dataset. Refer to the code list for SDMX indicator codes.

Parameters
sdmx_format = For viewing data in either generic or compact (structure specific) schema. Generic is the default value.
e.g. /api/v1/sdmx/POP_MID?sdmx_format=compact
country = ISO Country code. Filters results by selected country. Multiple countries can be selected using the , separator. Refer to code list for frequency names and codes.
e.g. /api/v1/sdmx/POP_MID?country=PHI
e.g. /api/v1/sdmx/POP_MID?country=PHI,BHU,SRI
year = From year 2000 onwards. Returns data for the specified year(s). Multiple years can be selected using the , separator. A range can be indicated using a : separator.
e.g. /api/v1/sdmx/POP_MID?year=2005
e.g. /api/v1/sdmx/POP_MID?year=2005,2009
e.g. /api/v1/sdmx/POP_MID?year=2005,2009:2010
freq = Frequency code. Refer to code list for frequency names and codes.
e.g. /api/v1/sdmx/POP_MID?frequency=A
page = Page number. For paging through large result-sets. This allows users to indicate the page number requested from the record-set.
e.g. /api/v1/sdmx/POP_MID?page=5
per_page = For determining the number of results per page. The default setting is 50 results per page.
e.g. /api/v1/sdmx/POP_MID?per_page=100
Multiple Parameters. It is possible to combine parameters using the & sign.
e.g. /api/v1/sdmx/POP_MID?country=PHI&yearstart=2005&yearend=2010