What it returns
Canadian economic statistics from Statistics Canada's official Web Data Service, one row per vector and reference period, with the release time and the change from the previous period.
| field | meaning |. |---|---|. | `vectorId`, `vector`, `preset` | the Statistics Canada vector and preset name |. | `table`, `tableTitle`, `title` | the source table and the series' dimension labels |. | `unit`, `scale`, `frequency` | unit of measure, scalar factor (units, thousands, millions) and frequency |. | `refPeriod`, `value`, `change` | reference period, value and change from the previous period |. | `releaseTime` | when Statistics Canada released this value (Eastern time); a revision moves it to the revision's release |. | `status`, `terminated`, `source` | observation status, whether the series is discontinued, and the table on statcan.gc.ca |.
Request
POST https://api.pushbuild.com/statistics-canada-data/run with a JSON body. Send your key in the X-API-Key header.
| Field | Type | Description |
|---|---|---|
presets | list of strings | Headline Canadian series. Default when nothing is chosen: CPI, unemployment rate, monthly GDP and retail sales. |
vectorIds | list of strings | Any Statistics Canada vector id, with or without the v prefix, for example v2062815 (unemployment rate). Up to 300. |
lastN | integer | Most recent reference periods per vector. Ignored when startDate is set. Default: 12. |
startDate | string | Return every reference period from this date, for example 2020-01-01. Optional. |
endDate | string | Last reference period to include when startDate is set. Optional. |
changes | boolean | Add the change from the previous period in the same vector. Default: true. |
maxItems | integer | Maximum items to return (1-500). Default: 100. |
Example
curl -X POST https://api.pushbuild.com/statistics-canada-data/run \
-H "X-API-Key: YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"presets": ["cpi", "unemployment-rate", "gdp-monthly", "retail-sales"], "maxItems": 20}'Response
{"count": 20, "truncated": false, "seconds": 1.4, "items": [ { ... } ]}Each call returns up to 500 items. Records that fail validation or are not found are flagged in the items and not charged.
Pricing
Pay only for results returned: $0.16 per 1,000 observations. No charge for errors or empty searches.
Related APIs
Bank of Canada API: Policy Rate, CORRA, Bonds, CPI & CAD FX API
Bank of Canada statistics from its official Valet API: policy rate, CORRA, prime, T-bills, benchmark bond yields, mortgage and GIC rates, CPI and core CPI, commodity prices and daily CAD exchange rates.
Bank of England API: Bank Rate, SONIA, Gilts & Mortgages API
Bank of England statistics from its official database: Bank Rate, SONIA, gilt yields, implied inflation, mortgage rates and approvals, M4 money, lending and sterling FX.
BLS Data API: Any Bureau of Labor Statistics Series API
Any US Bureau of Labor Statistics time series by id (CPI, payrolls by industry, unemployment, wages, PPI, JOLTS, import prices) plus state unemployment and labor force from plain state codes, with month-over-month and year-over-year changes..
Cboe Put/Call Ratios & VIX Futures Term Structure API
Daily Cboe options statistics: total, equity, index, SPX and VIX put/call ratios with call and put volume and open interest by product, plus the VIX futures curve with settlements, open interest and contango versus spot VIX..
CFPB Consumer Complaints: Banks, Lenders, Fintech API
Search 18 million+ official CFPB consumer complaints against banks, lenders, card issuers, debt collectors, credit bureaus and fintechs.
CFTC Commitments of Traders (COT) Reports API
Weekly CFTC Commitments of Traders positioning for every futures market: legacy, disaggregated (managed money, producers, swap dealers) and financial (leveraged funds, asset managers).
Tell us what you need built.
Questions about this API, higher volumes, or a data source you need that we don't cover yet.
hello@pushbuild.com