cpiu
v0.2.4
Published
A Node.js interface for CPI-U data provided by the U.S. Bureau of Labor Statistics
Downloads
15
Maintainers
Readme
CPIU
CPIU is a Node.js interface for CPI-U data provided by the U.S. Bureau of Labor Statistics. CPI-U data are commonly used for calculating inflation. More info on the BLS Public Data API is available here.
Neither I nor BLS.gov can vouch for the data or analyses derived from these data after the data have been retrieved from BLS.gov.
Installation
Requires Node.js 6 or up. Get the module with npm install cpiu
and use it with var cpiu = require('cpiu');
.
Copy .env.example
to .env
(or create a .env
file with the environment variable BLS_API_KEY
) and enter your BLS API key, which can be obtained here.
Usage
API documentation can be found here.
Better documentation, including examples, is pending.
License
Copyright © 2017–2019 Cody Logan
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
A copy of the GNU General Public License can be found in LICENSE and at http://www.gnu.org/licenses/.