docs / worldbank

World Bank

Global economic indicators by country.

base /worldbank/v17 endpoints

post/worldbank/v1/indicator2 credits

time-series for one+ indicators (code or shortcut) across one+ countries/all; date/mrv/mrnev, rank

Parameter		Allowed / range	Description
country	required	—	One or more ISO country codes (2- or 3-letter), separated by ; , or space, or 'all' for every economy (e.g. 'US' or 'US;CN;DE'). Discover codes via action=country / reference.
indicator	required	—	One or more World Bank indicator codes OR friendly shortcut aliases (e.g. 'gdp', 'inflation'), separated by ; , or space. Real codes are case-sensitive; shortcut aliases are not. See action=shortcuts.
date	optional	—	Year or year range (e.g. '2020' or '2015:2022'). Omit for all years; combine with mrv/mrnev for recent-values windows instead.
mrv	optional	1–500	Most-Recent-Values: return only the latest N data points per series.
mrnev	optional	1–500	Most-Recent-Non-Empty-Values: latest N NON-null data points per series.
drop_nulls = false	optional	—	Drop observations whose value is null from each series.
rank = false	optional	—	Rank countries by latest value (only when a SINGLE indicator is queried); adds a 'rank' field to each series.
per_page = 1000	optional	1–20000	World Bank API page size for paging through observations.
max_pages = 10	optional	1–50	Maximum number of observation pages to fetch (caps very large pulls).
frequency	optional	Y · Q · M	Data frequency for indicators that publish sub-annual series (most WDI indicators are yearly).
gapfill = false	optional	—	Carry the last observed value forward to fill gaps (used with mrv).

Try in playground →

post/worldbank/v1/country1 credit

country metadata for codes/all or filtered by region/income_level/lending_type

Parameter		Allowed / range	Description
country	required	—	One or more ISO country codes (2- or 3-letter), separated by ; , or space, or 'all' for every economy (e.g. 'US' or 'US;CN;DE'). Discover codes via action=country / reference.
region	optional	—	Filter countries by region (matches a region id like 'ECS' or its name); forces an all-countries scan. See reference kind=regions.
income_level	optional	—	Filter countries by income group (id like 'HIC'/'LIC' or its name); forces an all-countries scan. See reference kind=income_levels.
lending_type	optional	—	Filter countries by lending type (id like 'IBRD'/'IDA' or its name); forces an all-countries scan. See reference kind=lending_types.
exclude_aggregates = false	optional	—	Drop World Bank aggregate rows (regions/income groups/WLD) and keep only real economies.
all = false	optional	—	Return metadata for every economy (equivalent to country='all').

Try in playground →

post/worldbank/v1/search_indicators1 credit

local keyword search over the indicator catalog (WDI default; full=all sources)

Parameter		Allowed / range	Description
query	required	—	Keyword(s) to match against indicator id + name (all terms must match, case-insensitive).
source = 2	optional	—	World Bank source/database id to search (default 2 = World Development Indicators). Ignored when full=true.
full = false	optional	—	Search the FULL cross-source indicator catalog instead of just WDI.
topic	optional	—	Optional topic filter (matches a topic id or name) layered on top of the keyword search.
limit = 50	optional	1–500	Maximum number of matching indicators to return.

Try in playground →

post/worldbank/v1/indicator_metadata1 credit

definition/source/organization/topics for one+ indicator codes/aliases

Parameter		Allowed / range	Description
indicator	required	—	One or more World Bank indicator codes OR friendly shortcut aliases (e.g. 'gdp', 'inflation'), separated by ; , or space. Real codes are case-sensitive; shortcut aliases are not. See action=shortcuts.

Try in playground →

post/worldbank/v1/country_profile2 credits

one-call headline snapshot (most-recent ~10 key metrics) for one+ countries

Parameter		Allowed / range	Description
country	required	—	One or more ISO country codes (2- or 3-letter), separated by ; , or space, or 'all' for every economy (e.g. 'US' or 'US;CN;DE'). Discover codes via action=country / reference.
metrics	optional	—	Optional comma/semicolon list of shortcut keys or indicator codes to include in the profile. Omit for the default ~10-metric headline set.

Try in playground →

post/worldbank/v1/shortcuts1 credit

list the metric->indicator-code map, or metric=<key>&country=<code> to fetch directly

Parameter		Allowed / range	Description
metric	optional	gdp · gdp_per_capita · gdp_growth · gni_per_capita · inflation · population · population_growth · unemployment · labor_force · life_expectancy · poverty · exports · imports · fdi · exchange_rate · real_interest_rate · gov_debt · co2_per_capita · electricity_access · internet_users · mobile_subs · health_exp_gdp · military_exp_gdp · tax_revenue_gdp · current_account · gross_savings_gdp · agriculture_gdp · industry_gdp · services_gdp · urban_population_pct · trade_gdp	A friendly metric key to fetch directly. Omit to LIST the full metric→indicator-code map instead.
country	optional	—	One or more ISO country codes (2- or 3-letter), separated by ; , or space, or 'all' for every economy (e.g. 'US' or 'US;CN;DE'). Discover codes via action=country / reference.
date	optional	—	Year or year range (e.g. '2020' or '2015:2022'). Omit for all years; combine with mrv/mrnev for recent-values windows instead.
mrv	optional	1–500	Most-Recent-Values: return only the latest N data points per series.
mrnev	optional	1–500	Most-Recent-Non-Empty-Values: latest N NON-null data points per series.

Try in playground →

post/worldbank/v1/reference1 credit

reference lists: regions | income_levels | lending_types | sources | topics

Parameter		Allowed / range	Description
kind	required	regions · income_levels · lending_types · sources · topics · region · income_level · income · incomelevel · lending_type · lendingtype · lending · source · topic	Which reference list to return.

Try in playground →

Example request · indicator

curl -X POST https://api.reefapi.com/worldbank/v1/indicator \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"country":"US","indicator":"NY.GDP.MKTP.CD","date":"2015:2022"}'

Response shape

{
  "ok": true,
  "data": { /* the result */ },
  "meta": {
    "latency_ms": 240,
    "record_count": 12,
    "completeness_pct": 100
  },
  "error": null
}