# World Bank on Onekey

> 10 endpoints for World Bank (10 stable, 0 beta), 1 to 5 credits each. Category: Government & public data. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/worldbank
Reference (Markdown): https://onekey.dev/docs/api/worldbank.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 10 mapped World Bank endpoints return each:

- `entity.id` (string): 10
- `entity.name` (string): 10
- `entity.category` (string): 5
- `entity.description` (string): 4
- `entity.date` (ISO 8601 date): 2
- `place.lat` (number): 2
- `place.lon` (number): 2
- plus 7 platform-specific fields under `ext.`

## Endpoints

### worldbank.countries

Countries and aggregates with region, income level and capital.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/worldbank/countries?per_page=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `per_page` (string, optional, default 100): Rows per page (1-500)
  - `page` (string, optional, default 1): Page number
- Fields returned: `entity.id`, `entity.name`, `entity.category`, `place.lon`, `place.lat`, `ext.symbol`, `ext.incomeLevel`, `ext.lendingType`, `ext.capital`
- Reference: https://onekey.dev/docs/api/worldbank/countries.md

### worldbank.country

One country profile by ISO2/ISO3 code.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/worldbank/country?code=in` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `code` (string, required): Country code, e.g. IN or IND
- Fields returned: `entity.id`, `entity.name`, `entity.category`, `place.lon`, `place.lat`, `ext.symbol`, `ext.incomeLevel`, `ext.capital`
- Reference: https://onekey.dev/docs/api/worldbank/country.md

### worldbank.income_levels

World Bank income level groups.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/worldbank/income_levels` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `ext.symbol`
- Reference: https://onekey.dev/docs/api/worldbank/income_levels.md

### worldbank.indicator

One indicator's metadata (name, source, definition).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/worldbank/indicator?indicator=NY.GDP.MKTP.CD` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `indicator` (string, required): Indicator code, e.g. NY.GDP.MKTP.CD
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.category`, `ext.sourceOrganization`, `ext.unit`
- Reference: https://onekey.dev/docs/api/worldbank/indicator.md

### worldbank.indicators

Browse the indicator catalogue (paged).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/worldbank/indicators?per_page=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `per_page` (string, optional, default 100): Rows per page (1-500)
  - `page` (string, optional, default 1): Page number
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.category`
- Reference: https://onekey.dev/docs/api/worldbank/indicators.md

### worldbank.lending_types

World Bank lending type groups.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/worldbank/lending_types` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `ext.symbol`
- Reference: https://onekey.dev/docs/api/worldbank/lending_types.md

### worldbank.regions

World Bank regions and aggregates.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/worldbank/regions` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `ext.symbol`
- Reference: https://onekey.dev/docs/api/worldbank/regions.md

### worldbank.series

Time series of one indicator for one country (most recent first).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/worldbank/series?country=in&indicator=NY.GDP.MKTP.CD&per_page=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `country` (string, required): Country/aggregate code, e.g. IN, USA, WLD
  - `indicator` (string, required): Indicator code, e.g. NY.GDP.MKTP.CD
  - `per_page` (string, optional, default 60): Rows per page (1-500)
  - `page` (string, optional, default 1): Page number
- Fields returned: `entity.id`, `entity.name`, `entity.category`, `entity.date`, `ext.value`
- Reference: https://onekey.dev/docs/api/worldbank/series.md

### worldbank.sources

World Bank data sources (WDI, etc.).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/worldbank/sources` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.date`, `ext.symbol`
- Reference: https://onekey.dev/docs/api/worldbank/sources.md

### worldbank.topics

World Bank data topics.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/worldbank/topics` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.description`
- Reference: https://onekey.dev/docs/api/worldbank/topics.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/worldbank/country?code=in" \
  -H "x-api-key: YOUR_API_KEY"
```