A helper for accessing quota limited APIs
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
test
tools
.gitignore
.travis.yml
Makefile
README.md
jsdoc.json
package.json
proxapi.js
tutorial.md

README.md

Build Status

Proxapi is a javascript library acting as a proxy between your code and APIs of services like Twitter, Google or Facebook which limit the number of requests allowed in a period of time. With it, you can set up various strategies to deal with theses limits such as sending back an informative error message or waiting for the end of the limited period to retry the request.

Installation

In node, install the npm package with npm install proxapi, you can then initialize a ProxAPI instance with :

var ProxAPI = require("proxapi");
var proxApi = new ProxAPI(settings);

In the browser, include the file proxapi-0.4.1.min.js

<script src="proxapi-0.4.1.min.js"></script>
<script type="text/javascript">
  var proxApi = new ProxAPI(settings);
</script>

Usage

There is an introductory tutorial here. Check the generated documentation for a complete reference of ProxAPI settings options and methods. Check as well the source code examples/ folder.