# finwire.pl - Public financial data API

Open API with financial data for Poland: NBP policy rates, WIBOR/POLSTR, CPI inflation, NBP FX rates, NBP BaRN housing prices, GUS wages, government bonds and finwire's own indicators.

Documentation: https://public-api.finwire.pl/
OpenAPI: https://public-api.finwire.pl/openapi.json
Interactive: https://public-api.finwire.pl/reference

Cite as: Source: finwire.pl, https://public-api.finwire.pl

## Datasets

### Interest rates: NBP, WIBOR, POLSTR
Daily and historical values of NBP policy rates and the WIBOR and POLSTR benchmarks (all tenors). POLSTR is the successor to WIBOR in the Polish benchmark reform.
Endpoint: https://public-api.finwire.pl/v1/series/interest-rate/{indicator}
Example: https://public-api.finwire.pl/v1/series/interest-rate/wibor-3m?days=365
Source: NBP, GPW Benchmark
Documentation: https://public-api.finwire.pl/datasets/interest-rates

### CPI inflation (GUS)
Consumer price inflation (CPI), year-over-year (YoY) and month-over-month (MoM), monthly and annual, based on data from Statistics Poland (GUS).
Endpoint: https://public-api.finwire.pl/v1/series/cpi
Example: https://public-api.finwire.pl/v1/series/cpi?type=monthly&limit=24
Source: GUS
Documentation: https://public-api.finwire.pl/datasets/cpi

### NBP currency rates
Mid rates (table A) and bid/ask rates (table C) for major currencies against the Polish zloty, current and historical, based on NBP tables.
Endpoint: https://public-api.finwire.pl/v1/series/fx/{code}
Example: https://public-api.finwire.pl/v1/series/fx/EUR?days=365
Source: NBP
Documentation: https://public-api.finwire.pl/datasets/fx

### Housing prices (NBP BaRN)
Average price per square meter of flats on the secondary and primary market in provincial capitals, quarterly since 2006, based on the NBP BaRN database.
Endpoint: https://public-api.finwire.pl/v1/series/housing/{city}
Example: https://public-api.finwire.pl/v1/series/housing/warszawa
Source: NBP BaRN
Documentation: https://public-api.finwire.pl/datasets/housing

### Government bonds
Interest rates of retail government bonds (OTS, ROR, DOR, TOS, COI, EDO, ROS, ROD) across successive issues, based on Polish Ministry of Finance data.
Endpoint: https://public-api.finwire.pl/v1/bonds
Example: https://public-api.finwire.pl/v1/bonds
Source: Ministry of Finance
Documentation: https://public-api.finwire.pl/datasets/bonds

### Wages (GUS) - median and percentiles
Median, mean and percentiles of gross wages in Poland, plus average wages across the 16 provinces, based on GUS wage-distribution data.
Endpoint: https://public-api.finwire.pl/v1/wages
Example: https://public-api.finwire.pl/v1/wages
Source: GUS
Documentation: https://public-api.finwire.pl/datasets/wages

### Legal limits (IKE, IKZE)
Current legal limits updated annually: annual contribution limits for the IKE and IKZE retirement accounts and related values, based on official announcements.
Endpoint: https://public-api.finwire.pl/v1/legal-limits
Example: https://public-api.finwire.pl/v1/legal-limits
Source: Ministry of Family
Documentation: https://public-api.finwire.pl/datasets/legal-limits

### finwire credit stress map
The installment of a model mortgage for a 50 sqm flat as a percentage of the average net wage in each of the 16 provinces, with DSTI thresholds per the KNF Recommendation S. Computed by finwire.pl.
Endpoint: https://public-api.finwire.pl/v1/index/credit-stress
Example: https://public-api.finwire.pl/v1/index/credit-stress
Source: finwire.pl (NBP BaRN + GUS + WIBOR)
Documentation: https://public-api.finwire.pl/datasets/credit-stress

### Real return on deposits
The rate of the best term deposits minus CPI inflation - a barometer of whether savings actually gain or lose value. Computed by finwire.pl.
Endpoint: https://public-api.finwire.pl/v1/index/real-deposit-rate
Example: https://public-api.finwire.pl/v1/index/real-deposit-rate
Source: finwire.pl (deposit offers + CPI GUS)
Documentation: https://public-api.finwire.pl/datasets/real-deposit-rate

### Housing affordability (financeable area)
The number of square meters of housing that a model household can finance with a mortgage. Computed by finwire.pl.
Endpoint: https://public-api.finwire.pl/v1/index/housing-affordability
Example: https://public-api.finwire.pl/v1/index/housing-affordability
Source: finwire.pl (NBP BaRN + WIBOR)
Documentation: https://public-api.finwire.pl/datasets/housing-affordability

### Mortgage cost
A barometer of the current mortgage interest rate against the 3-year average. Computed by finwire.pl.
Endpoint: https://public-api.finwire.pl/v1/index/credit-cost
Example: https://public-api.finwire.pl/v1/index/credit-cost
Source: finwire.pl
Documentation: https://public-api.finwire.pl/datasets/credit-cost

### Borrowing power (barometer)
The maximum mortgage available to a model household over time. Computed by finwire.pl.
Endpoint: https://public-api.finwire.pl/v1/index/borrowing-power
Example: https://public-api.finwire.pl/v1/index/borrowing-power
Source: finwire.pl
Documentation: https://public-api.finwire.pl/datasets/borrowing-power

### Purchasing power (inflation)
A barometer of the zloty purchasing power based on year-over-year CPI inflation. Computed by finwire.pl.
Endpoint: https://public-api.finwire.pl/v1/index/purchasing-power
Example: https://public-api.finwire.pl/v1/index/purchasing-power
Source: finwire.pl (CPI GUS)
Documentation: https://public-api.finwire.pl/datasets/purchasing-power

### Term deposit rate aggregates
Median, percentiles and spread of term deposit rates currently available on the market, for a model amount and term. Aggregates only - no individual bank offers.
Endpoint: https://public-api.finwire.pl/v1/market/deposit-rates
Example: https://public-api.finwire.pl/v1/market/deposit-rates?amount=10000&period=3
Source: finwire.pl (market offer aggregate)
Documentation: https://public-api.finwire.pl/datasets/deposit-rates

### Savings account rate aggregates
Median and percentiles of savings account rates currently available on the market. Aggregates only - no individual bank offers.
Endpoint: https://public-api.finwire.pl/v1/market/savings-rates
Example: https://public-api.finwire.pl/v1/market/savings-rates?amount=10000
Source: finwire.pl (market offer aggregate)
Documentation: https://public-api.finwire.pl/datasets/savings-rates

### Mortgage rate aggregates
Median APRC (RRSO), margin and nominal rate of mortgages for a model loan. Aggregates only - no individual bank offers.
Endpoint: https://public-api.finwire.pl/v1/market/mortgage-rates
Example: https://public-api.finwire.pl/v1/market/mortgage-rates?amount=400000&period=25
Source: finwire.pl (market offer aggregate)
Documentation: https://public-api.finwire.pl/datasets/mortgage-rates

### Cash loan rate aggregates
Median APRC (RRSO) and nominal rate of cash loans for a model amount and term. Aggregates only - no individual bank offers.
Endpoint: https://public-api.finwire.pl/v1/market/cash-loan-rates
Example: https://public-api.finwire.pl/v1/market/cash-loan-rates?amount=20000&period=48
Source: finwire.pl (market offer aggregate)
Documentation: https://public-api.finwire.pl/datasets/cash-loan-rates

### Market snapshot - one call
The current state of Polish finance in a single call: rates, inflation, FX, the credit stress indicator and barometers.
Endpoint: https://public-api.finwire.pl/v1/snapshot
Example: https://public-api.finwire.pl/v1/snapshot
Source: finwire.pl (source aggregate)
Documentation: https://public-api.finwire.pl/datasets/snapshot