openaq

A ES6 promise-based JS client for the OpenAQ API

Install:

npm install openaq
const openaq = require('openaq')
const client = new openaq

API:

Any parameters should be passed as an optional params object as seen in the examples.

.getCities(params)

  • example:
    cities().then(results => {
    //results here
    })
    

//with optional parameters cities({country:'US', page:2}).then(results => { //results here })


### [.countries(params)](https://docs.openaq.org/#api-Countries)
- example:
```javascript
countries().then(results => {
  //results here
})

//with optional parameters
countries({limit:10, page:2}).then(results => {
  //results here
})

.fetches(params)

  • example:
    fetches().then(results = {
    //results here
    })
    

//with optional parameters fetches({limit:10, page:2}).then(results => { //results here })


### [.latest(params)](https://docs.openaq.org/#api-Latest)
- example:
```javascript
latest().then(results => {
  //results here
})

//with optional parameters
latest({location:'Bowling Green', parameter:'o3'}).then(results => {
  //results here
})

.locations(params)

  • example:
    locations().then(results => {
    //results here
    })
    

//with optional parameters locations({location:'Bowling Green', parameter:'o3'}).then(results => { //results here })


### [.measurements(params)](https://docs.openaq.org/#api-Measurements)
- example:
```javascript
measurements().then(results => {
  //results here
})

//with optional parameters
measurements({location:'Bowling Green', parameter:'o3'}).then(results => {
  //results here
})

.parameters()

  • example:
    parameters().then(results => {
    //results here
    })

.sources(params)

  • example:

sources().then(results => { //results here })

//with optional parameters sources({limit:10, page:2}).then(results => { //results here })

## TODO
- add testing
- make isomorphic (commonJS and ES2015 module support)

Openaq

A JS client for the OpenAQ API

Openaq Info

⭐ Stars 15
🔗 Homepage openaq.org
🔗 Source Code github.com
🕒 Last Update a year ago
🕒 Created 4 years ago
🐞 Open Issues 1
➗ Star-Issue Ratio 15
😎 Author nickolasclarke