npm CircleCI npm NPM GitHub issues
A Node.js wrapper for the StackExchange API
Disclaimer: WIP. Doesn't work with many endpoints yet.
- stackexchange-api provides a simple way to access the StackExchange API endpoints
- All complex data types from the API have a corresponding Object
- stackexchange-api is written in TypeScript and every field of every request option / result has (will eventually have) type definitions. As a result, modern editors are able to provide extensive autocompletion.
npm install --save stackexchange-api
yarn add stackexchange-api
Including in a project:
- ES6:
import {StackExchange} from 'stackexchange-api';
- CommonJS:
const StackExchangeApi = require('stackexchange-api');
Example usage:
import {StackExchange} from 'stackexchange-api'; StackExchange.search({ // Equivalent to the /search endpoint. Go to https://paul-soporan.github.io/stackexchange-api/classes/stackexchange.html#search for details. inTitle: 'nodejs', site: 'stackoverflow' }).then((result) => { console.log(result); // Output: Wrapper<Question> console.log(result.items); // Output: an array of Questions (Question[]) console.log(result.items[0]); // Output: the first Question console.log(result.items[0].viewCount); // Output: the view count of the first Question });