# PakDataHub Documentation

> PakDataHub is the self-serve REST API for Pakistan's official economic and financial data - 16,964 live series from 1947 to today (exchange rates, inflation, interest rates and yield curves, balance of payments, reserves, remittances, money and banking, GDP, public finance, debt, digital payments, telecom) plus 567 mutual funds, debt securities, auctions and trade, sourced from SBP, PBS, PTA and MUFAP. Base URL https://api.pakdatahub.com, auth via the `X-API-Key` header, 500 free API calls every month. Append `.md` to any docs URL for that page as raw Markdown, or fetch every page at once at https://pakdatahub.com/llms-full.txt (one file, raw Markdown)

## Introduction

- [Getting started](https://pakdatahub.com/docs/getting-started.md): Get a free PakDataHub key and make your first API call for Pakistan's economic data in about five minutes.
- [Authentication](https://pakdatahub.com/docs/authentication.md): How PakDataHub API keys work - the X-API-Key header, the api_key query parameter, dashboard session tokens, key limits and rotation.
- [Series & the catalog](https://pakdatahub.com/docs/series-and-catalog.md): The PakDataHub data model - series ids, modules, units, frequencies, dimensions (bid/offer, city), the catalog record and how to discover any series.
- [Errors & rate limits](https://pakdatahub.com/docs/errors-rate-limits.md): PakDataHub error envelope, every HTTP status and error code, rate-limit headers, per-plan limits and how to handle 429 and 402 responses.
- [Plans & credits](https://pakdatahub.com/docs/plans-credits.md): PakDataHub plans - the free plan's 500 API calls a month, Developer, Pro and Business, and what each plan sells - history depth, vintages, webhooks and the right to show data in your product.
- [Google Sheets & Excel functions](https://pakdatahub.com/docs/spreadsheets.md): Pull Pakistan's official economic data straight into a cell - =PAKDATA() and =PAKDATA_LATEST() for Google Sheets and Excel 365, plus a Power Query function for full history.
- [Sources & provenance](https://pakdatahub.com/docs/sources-provenance.md): Where every PakDataHub number comes from - the official State Bank of Pakistan (incl. its EasyData portal), PBS, PTA and MUFAP releases - how it is ingested, validated and versioned, and how to trace any value to its official source.

## API reference

- [API reference](https://pakdatahub.com/docs/api-reference.md): Index of every PakDataHub REST endpoint - base URL, response envelope, conventions and a link to the full reference page for each endpoint.
- [Catalog](https://pakdatahub.com/docs/api-catalog.md): GET /v1/catalog and /v1/catalog/{id} - list, filter and page through metadata for every PakDataHub series (public, no key).
- [Search](https://pakdatahub.com/docs/api-search.md): GET /v1/search - ranked search over every PakDataHub series by id, name and description (public, no key).
- [Series](https://pakdatahub.com/docs/api-series.md): GET /v1/series/{id} and /v1/series/{id}/latest - observations for any of 16,964 Pakistan series with date range, dimension filters, sort, limit, CSV, transforms and vintages.
- [Transforms](https://pakdatahub.com/docs/api-transforms.md): Server-side series transforms on PakDataHub - year-over-year, month-over-month, percent change, 3-period moving average and index rebasing via ?transform=.
- [Revision vintages](https://pakdatahub.com/docs/api-vintages.md): Point-in-time data on PakDataHub - ?vintage=YYYY-MM-DD returns each observation as it was recorded on a past date, for reproducible research and revision studies (Pro+).
- [Commodities](https://pakdatahub.com/docs/api-commodities.md): GET /v1/commodities, /by-city, /items and /cities - weekly PBS SPI retail prices for 30 essential items (flour, rice, sugar, ghee, petrol...) nationally and in 17 Pakistani cities.
- [Wholesale prices API](https://pakdatahub.com/docs/api-agri.md): /v1/agri - Punjab AMIS daily wholesale (mandi) prices by market and commodity - min, max and fair-quality price since 2007. Endpoints, parameters and responses.
- [Mutual funds](https://pakdatahub.com/docs/api-funds.md): GET /v1/funds, /v1/funds/screener and per-fund NAV, returns, payouts, expenses (TER) and portfolio endpoints - 567 Pakistani mutual funds from MUFAP, NAVs back to 1996.
- [Fund analytics](https://pakdatahub.com/docs/api-fund-analytics.md): GET /v1/funds/{id}/analytics - server-computed performance for any Pakistani mutual fund - trailing and annualized returns, CAGR, annualized volatility and max drawdown from the full NAV history.
- [AMCs (asset managers)](https://pakdatahub.com/docs/api-amcs.md): GET /v1/amcs and /v1/amcs/{amc} - profiles of Pakistan's asset-management companies with fund counts, average expense ratio, categories and credit-rating distribution.
- [Debt securities](https://pakdatahub.com/docs/api-securities.md): GET /v1/securities, /v1/securities/{code}/prices and /v1/securities/trades - MUFAP prices for floating-rate PIBs, GoP Ijara Sukuk and corporate TFCs/Sukuk, plus trade-level secondary-market debt transactions.
- [Auctions](https://pakdatahub.com/docs/api-auctions.md): GET /v1/fixed-income/auctions - Pakistan government securities auction cut-off yields for T-Bills (since 2004), PIBs (since 2000) and GoP Ijara Sukuk.
- [External trade](https://pakdatahub.com/docs/api-trade.md): GET /v1/trade - Pakistan's monthly exports and imports by commodity from PBS, with quantity, value in PKR million and US$ thousand.
- [Release calendar](https://pakdatahub.com/docs/api-calendar.md): GET /v1/calendar - upcoming Pakistan economic data releases (CPI, SPI, reserves, remittances, trade, LSM, M2) with the linked PakDataHub series (public).
- [Status](https://pakdatahub.com/docs/api-status.md): GET /v1/status - public freshness and health of every PakDataHub module and dataset - last observation date, cadence, state (fresh/current/delayed/stale), job runs and API latency.
- [Usage](https://pakdatahub.com/docs/api-usage.md): GET /v1/usage and /v1/usage/history - your PakDataHub plan, rate limits, requests used this minute and today, remaining free credits and a 30-day request history.
- [Account & keys](https://pakdatahub.com/docs/api-account-keys.md): GET/PATCH /v1/account and GET/POST/DELETE /v1/keys - read your PakDataHub account and plan, update your profile, and create, list and revoke API keys.
- [Webhooks](https://pakdatahub.com/docs/api-webhooks.md): GET/POST/DELETE /v1/webhooks - get an HMAC-SHA256-signed POST whenever a PakDataHub series or module updates, instead of polling. Payload, signature verification and plan limits.
- [Auth (signup & sessions)](https://pakdatahub.com/docs/api-auth.md): PakDataHub account endpoints - POST /auth/signup, /auth/login, /auth/logout, /auth/change-password, /auth/set-password and Google sign-in, with session tokens.
- [Billing](https://pakdatahub.com/docs/api-billing.md): GET /v1/plans, POST /v1/checkout, GET /v1/billing/portal and the one-time key claim - PakDataHub plans, prices, limits and self-serve subscription management.

## Datasets

- [Data dictionary & coverage](https://pakdatahub.com/docs/data-dictionary.md): The definitive map of what PakDataHub covers - every dataset and module with series counts, cadence, history, source and the endpoint to use, plus quick answers to "does PakDataHub have X?".
- [Exchange rates (forex)](https://pakdatahub.com/docs/data-forex.md): Pakistan rupee exchange-rate data via API - PKR vs USD, EUR, GBP, JPY, SAR, AED, CNY and 20+ currencies, monthly average and month-end since 1947, plus REER and NEER from SBP.
- [Interest rates & yields](https://pakdatahub.com/docs/data-rates.md): Pakistan interest-rate data via API - KIBOR/KIBID by tenor since 2005, SBP policy rate and corridor, PKRV and PKISRV yield curves, T-Bill/PIB/Sukuk auction cut-offs, overnight repo.
- [Inflation & prices](https://pakdatahub.com/docs/data-inflation.md): Pakistan inflation data via API - CPI national/urban/rural index and YoY, CPI by COICOP group, food and core (NFNE) inflation, WPI, SPI, and a weekly cost-of-living index for 17 cities.
- [Commodity prices (SPI)](https://pakdatahub.com/docs/data-commodities.md): Weekly retail prices of 30 essential goods in Pakistan - flour, rice, sugar, ghee, pulses, milk, eggs, chicken, petrol, diesel, LPG - nationally and in 17 cities, from the PBS Sensitive Price Indicator.
- [Wholesale (mandi) prices - Punjab AMIS](https://pakdatahub.com/docs/data-agri-prices.md): Daily wholesale prices of grains, vegetables and fruits in Punjab's markets since 2007 - min, max and fair-quality price per market and day, from the Punjab Agriculture Marketing Information Service (AMIS).
- [External sector](https://pakdatahub.com/docs/data-external.md): Pakistan external-sector data via API - balance of payments and current account, FX reserves since 1948, workers' remittances by country since 1972, FDI by country and sector, exports by country, Roshan Digital Account.
- [Money & banking](https://pakdatahub.com/docs/data-monetary.md): Pakistan monetary and banking data via API - broad money M2/M3, deposits, credit, banking-sector NPLs by segment, deep KIBOR/KIBID history, branchless banking, Economic Policy Uncertainty index, from SBP.
- [Real economy](https://pakdatahub.com/docs/data-real.md): Pakistan real-economy data via API - GDP and growth (quarterly and annual, 1950-), Large-Scale Manufacturing, auto production and sales, electricity generation by fuel, POL sales, fertilizer, cement, FMCG and corporate-sector financials.
- [Public finance](https://pakdatahub.com/docs/data-public-finance.md): Pakistan fiscal data via API - federal and provincial revenue and expenditure, FBR tax collection by tax type, provincial fiscal balances, from 1979, from SBP.
- [Debt](https://pakdatahub.com/docs/data-debt.md): Pakistan debt data via API - total external debt and liabilities (quarterly, 1995-), government-securities holdings (MTB, PIB, GIS) by investor type, and national savings schemes, from SBP.
- [Population & society](https://pakdatahub.com/docs/data-social.md): Pakistan social-sector data via API - population and census by age since 1951, labour force and employment, literacy, education enrolment and institutions, health facilities since 1947, and SBP consumer and business confidence surveys.
- [Digital payments & SME](https://pakdatahub.com/docs/data-payments.md): Pakistan digital-payments data via API - Raast P2P/P2M/bulk volume and value, cards, ATMs, POS and QR merchants, PRISM/RTGS, e-commerce, mobile and internet banking by channel, plus SBP SME finance (portfolio, borrowers, NPL ratio).
- [Telecom (PTA)](https://pakdatahub.com/docs/data-telecom.md): Pakistan telecom data via API - cellular subscribers by operator (Jazz, Zong, Telenor, Ufone), teledensity, 2G/3G/4G cell sites, ARPU, broadband data usage, telecom revenue, investment, FDI and exchequer contribution, from PTA.
- [Mutual funds (MUFAP)](https://pakdatahub.com/docs/data-mutual-funds.md): Pakistan mutual-fund data via API - 567 funds from 25 asset managers, daily NAV history back to 1996, returns, dividend payouts, expense ratios (TER), asset allocation, computed CAGR, volatility and drawdown, and AMC profiles.
- [Debt securities (MUFAP)](https://pakdatahub.com/docs/data-debt-securities.md): Pakistan bond and sukuk price data via API - floating-rate PIBs, GoP Ijara Sukuk and rated corporate TFCs/Sukuk with daily valuation prices since 2022, plus trade-level secondary-market transactions.
- [Derived indicators](https://pakdatahub.com/docs/data-derived.md): The PakDataHub derived layer - real interest rates, rate spreads, yield-curve slope, import cover, rolling remittances, city essentials inflation and fund-category yields, each computed from official series with a published formula. Every plan.

## Use cases

- [For fintech & lending teams](https://pakdatahub.com/docs/for-fintech-teams.md): How fintech, lending, remittance and wallet teams use PakDataHub - KIBOR pricing, FX for remittances, inflation for credit models, Raast and payments data for market sizing.
- [For macro researchers](https://pakdatahub.com/docs/for-macro-researchers.md): How economists and macro researchers use PakDataHub - long-run Pakistan series (FX since 1947, reserves since 1948, GDP since 1950), transforms, revision vintages and pandas workflows.
- [Banks, treasury & ALM](https://pakdatahub.com/docs/use-case-banks-treasury.md): How Pakistani banks, treasury desks and ALM teams use PakDataHub - KIBOR since 2005, the PKRV yield curve, T-Bill/PIB auction cut-offs, the policy-rate corridor, deposits, M2 and NPLs in one API.
- [Credit risk & IFRS 9 macro scenarios](https://pakdatahub.com/docs/use-case-credit-risk-ifrs9.md): Build IFRS 9 forward-looking macro overlays and PD models for Pakistan with PakDataHub - GDP growth, CPI, KIBOR, the policy rate, USD/PKR, LSM, remittances and NPL history via one API.
- [Asset managers, wealth & robo-advisors](https://pakdatahub.com/docs/use-case-asset-managers.md): Build fund comparison, robo-advice and wealth tools on Pakistan's 567 mutual funds with PakDataHub - daily NAVs since 1996, returns, CAGR, volatility, drawdown, expense ratios, allocations and AMC profiles.
- [Remittance & FX apps](https://pakdatahub.com/docs/use-case-remittance-fx.md): How remittance, money-transfer and FX products use PakDataHub - PKR rates vs USD, SAR, AED, GBP, EUR since 1947, remittances by sending country, reserves and REER.
- [Journalists & data storytelling](https://pakdatahub.com/docs/use-case-journalists.md): How journalists and newsrooms use PakDataHub for Pakistan's economic stories - inflation, the rupee, reserves, flour and petrol prices by city, remittances and interest rates, as charts, CSV and free tools.
- [Students & academic research](https://pakdatahub.com/docs/use-case-students-academics.md): Pakistan economic data for theses and papers - long-run series (FX 1947, reserves 1948, GDP 1950, CPI 1964), clean CSV for R, Stata, Python and Excel, and reproducible downloads via PakDataHub.
- [Policy, development & NGOs](https://pakdatahub.com/docs/use-case-policy-development.md): How think tanks, development organizations and NGOs use PakDataHub - financial inclusion (Raast, branchless banking, SME finance), food prices by city, fiscal accounts, social indicators and remittances.
- [FMCG, retail & supply chain](https://pakdatahub.com/docs/use-case-fmcg-retail-supply-chain.md): How FMCG, retail, food and logistics businesses in Pakistan use PakDataHub - weekly prices of flour, sugar, ghee, oil, fuel by city, inflation by group, POL sales, auto and cement demand indicators.
- [Excel, Google Sheets & Power BI](https://pakdatahub.com/docs/use-case-excel-sheets-bi.md): Pull Pakistan economic data straight into Excel (Power Query), Google Sheets (IMPORTDATA) and Power BI from the PakDataHub API - no code, auto-refreshing CSV.
- [AI agents & LLM apps](https://pakdatahub.com/docs/use-case-ai-agents.md): Give an AI assistant or agent live, official Pakistan economic data via PakDataHub - tool/function definitions for search and series lookups, llms.txt and raw-Markdown docs for grounding.
- [Equity & sector analysts](https://pakdatahub.com/docs/use-case-equity-analysts.md): Macro and sector data for Pakistan equity research - autos, cement, power, fertilizer, POL, FMCG, banking, rates and FX from PakDataHub, alongside PSX market data from pypsx.com.
- [Startups & market sizing](https://pakdatahub.com/docs/use-case-startups-market-sizing.md): Size Pakistani markets for pitch decks and diligence with PakDataHub - digital-payments adoption, Raast, cards, e-commerce merchants, mobile subscribers, remittances, auto and consumer demand data.

## Resources

- [Changelog](https://pakdatahub.com/docs/changelog.md): Notable changes to the PakDataHub API, data and docs.

## For AI Agents & LLMs

- [AGENTS.md](https://pakdatahub.com/AGENTS.md): How AI agents should read and use these docs.
- [llms.txt](https://pakdatahub.com/docs/llms.txt): This index of every docs page, linking each page's raw Markdown.
- [llms-full.txt](https://pakdatahub.com/llms-full.txt): Every documentation page concatenated as raw Markdown, in one file.
- [Site overview](https://pakdatahub.com/llms.txt): What PakDataHub is, one-line answers, blog and tools.

## Optional

- [Website](https://pakdatahub.com)
- [API guides - copy-paste recipes per dataset](https://pakdatahub.com/guides)
- [Browse the catalog](https://pakdatahub.com/coverage)
- [Status](https://pakdatahub.com/status)
- [Pricing](https://pakdatahub.com/pricing)
- [Blog](https://pakdatahub.com/blog)