nsapi

nsapi

nsapi is a free and open source library that allows Node.js applications to easily access the NationStates API without worrying about making HTTP requests, decoding XML, caching or rate limiting.

nsapi features the following:

• a complete interface to the NationStates API (supports the nation, region, world, World Assembly, telegram, trading cards, and authentication APIs)
• rate-limiting to prevent blocked access to the API, including for the telegram API (recruitment and non-recruitment)
• optional URI-based request caching
• XML decoding (all data is returned in simple JavaScript data structures)
• support for version 10 of the NationStates API

Usage

You can install nsapi using npm: npm install nsapi.

You can also build nsapi locally using npm: npm run-script build.

Consult the documentation for more information on API structure and methods.

nsapi targets ES5 but requires support for ES6 promises, so if you're not using a runtime that supports them natively, you'll have to use a polyfill.

Examples

The following is a simple example that retrieves a nation's full name and prints it to the console.

var nsapi = require("nsapi");

// TODO: Replace the user agent with your own
var api = new nsapi.NsApi("Your nation's name");
return api.nationRequest("Auralia", ["fullname"])
          .then(function(data) {
              console.log(data["fullname"]);
          })
          .then(function() {
              api.cleanup();
          });

For additional examples, consult the examples/example.js file.

License

nsapi is licensed under the Apache License 2.0.