angellist

0.1.0 • Public • Published

node-angellist: Easy wrapper around the AngelList API

This module is designed to be an easy-to-use wrapper around the AngelList API. This module is designed to be used with node.js.

Install

  npm install angellist

Or from source:

  git clone git://github.com/rgerard/node-angellist.git
  cd node-angellist
  npm install

Simple Examples

var angel = require('angellist');
 
// Init the object with your API key
angel.init(clientID, clientSecret);
 
// Search for a company name
angel.search('pickmoto', function(error, results) {
 if (!error) {
    console.log(results) // Print the search results
  }
});

Documentation

Please refer to the AngelList API documentation for more detail on their API.

AngelList API

### init(clientID, clientSecret)

Inits the object with your client data;

Arguments

  • clientID - Your client ID
  • clientSecret - Your client secret

Example

// Init an AngelList object
var angel = require('angellist');
angel.init(clientID, clientSecret);

### getAuthUrl()

Returns the URL needed to start the authentication process.

Example

// Redirect the user to the auth URL
var url = angel.getAuthUrl();
res.redirect(url);

### requestAccessToken(code, callback)

Requests an access token for a user who has authenticated your application

Arguments

  • code - Returned from AngelList after the user has authenticated your app
  • callback(err, body) - A callback which is called after the API call has returned, or an error has occurred.

Example

// Fetch the access token
angel.requestAccessToken(req.query['code'], function(err, body) {
 if (!error) {
    // Set the access token
    angel.setAccessToken(body.access_token);
  }
});

### setAccessToken(token)

Stores the access token returned from AngelList

Arguments

  • token - Token to save

Example

// Fetch the access token
angel.requestAccessToken(req.query['code'], function(err, body) {
 if (!error) {
    // Set the access token
    angel.setAccessToken(body.access_token);
  }
});

### getMe(callback)

Returns the information about the logged-in user

Arguments

  • callback(err, body) - A callback which is called after the API call has returned, or an error has occurred.

Example

// Fetch the posts for a company/person
angel.getMe(function(err, user) {
 if (!error) {
    console.log(user);
  }
});

### search(query, callback)

Returns the search results from a query.

Arguments

  • query - The person or company to search for
  • callback(err, body) - A callback which is called after the API call has returned, or an error has occurred.

Example

// Search for a person or company
angel.search('pickmoto', function(err, results) {
 if (!error) {
    console.log(results);
  }
});

### getUserById(angelID, callback)

Returns the information about a user by their AngelList ID.

Arguments

  • angelID - The AngelList ID of the person to get information for.
  • callback(err, body) - A callback which is called after the API call has returned, or an error has occurred.

Example

// Search for a person or company
angel.getUserById(77, function(err, user) {
 if (!error) {
    console.log(user);
  }
});

Readme

Keywords

none

Package Sidebar

Install

npm i angellist

Weekly Downloads

1

Version

0.1.0

License

none

Last publish

Collaborators

  • rgerard