@varve/agency-sdks

World Bank API

TypeScript client for the World Bank Indicators API.

World Bank API

@varve/worldbank-api is an isomorphic, Zod-validated TypeScript client for World Bank countries, indicators, sources, topics, and observations.

Install

npm install @varve/worldbank-api zod

Query Data

import { WorldBankClient } from '@varve/worldbank-api';
 
const client = new WorldBankClient();
 
const data = await client.getIndicatorData('USA', 'SP.POP.TOTL', {
  date: '2020:2024',
});
 
console.log(data.items);

Discover Metadata

const countries = await client.getCountries({ perPage: 100 });
const indicators = await client.getIndicators({ perPage: 100 });
const population = await client.getIndicator('SP.POP.TOTL');
const sources = await client.getSources();
const topics = await client.getTopics();

Build Graph Metadata

World Bank data naturally maps to an indicator -> country -> period graph.

const graph = await client.getIndicatorGraphMetadata('SP.POP.TOTL', ['USA', 'CAN'], {
  date: '2020:2024',
});
 
console.log(graph.indicator);
console.log(graph.countries);
console.log(graph.periods);
console.log(graph.observations);

Official References

Previous

Eurostat API

Next

World Bank API

On this page