1.1.0 • Published 10 years ago

angel.co v1.1.0

Weekly downloads
3
License
-
Repository
github
Last release
10 years ago

Angel List

AngelList wrapper purely written in Node.js

Getting Started

Wrapper can be downloaded from npm:

npm install angel.co --save

Once installed, its easy to use it:

var angel = require('angel.co')('APP_ID', 'APP_SECRET');

Please follow the documentation from https://angel.co/api/(AngelList documentation)

Authentication

Module includes ability to let the user authenticate from AngelList. For now, its hard coded and asks for all ther permissions but you can change sa you like ;-)

Below example has been implemented with Express.js you may modify it.

app.get('/auth/angel-list', function(req, res) {
    res.redirect(angel.getAuthorizeUrl());
});

app.get('/auth/angel-list/callback', function(req, res) {
    angel.auth.requestAccessToken(req.query.code, function(err, response) {
        if ( err )
            return console.error(err); //Something went wrong.
            
        // I got the Token. Ain't you?
        app.set('my_key_to_token', response.access_token); // Persist it anywhere.
        res.redirect('/'); // Go back to the homepage.
    });
});

PS: Your callback url must be similar to what you have configured while creating an app on AngelList.

Available Services.

You can serve this wrapper for following services:

Users

Specification for the user is available at: https://angel.co/api/spec/users

me

It returns the data of logged in user.

angel.users.me('access_token_here', function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Get User

To get the user, first argument must be the userId while another would be the set for query parameters.

angel.users.user('467664', {'include_details': 'investor'}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Get User Roles

Returns all the roles of user in organizations in which user is tagged in.

angel.users.roles('USER_ID', function(err, body) {
     if ( err )
        return console.log(err);

    console.log(body);
});

Batch Request

Helps to query multiple users at a time. First argument must be an array with the list of user ids.

angel.users.batch(['155', 671], function(err, body) {
     if ( err )
        return console.log(err);

    console.log(body);
});

Users Search

Search the users by slug and/or md5 of the user's email

angel.users.search({'slug': "hamza-waqas"}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Users by Tag

Returns all the users related to the tag. Tag must be either LocationTag or MarketTag. First argument is the tagId, while another is the object with k/v of query parameters.

angel.users.tags('1654', {
    include_children: true,
    investors: 'by_residence'
}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Startups

Specification of startup is available at https://angel.co/api/spec/startups

Get Startup

Returns the information of the given startup Id.

angel.startups.get(6702, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Get Startup Comments

Retrieves all the comments of startup.

angel.startups.comments(6702, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Startup Roles

Returns the company's startup roles. Direction must be either Incoming or Outgoing.

angel.startups.roles(6702, {direction: "outgoing"}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Filter Startups

Filters the startups by criteria.

angel.startups.filter({filter: "raising"}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Get Startups by Tag

Returns companies that are tagged with the given tag or a child of the given tag. Results are paginated and ordered according to the order parameter.

angel.startups.tags(1654, {order: "asc"}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Feeds

Specification for feeds entity is available at: https://angel.co/api/spec/activity_feeds

Consume

Returns site activity. If authenticated and the personalized parameter is passed in, only activity from the authenticated user's social graph is returned. No more than 25 items will be returned. Results are paginated and ordered by most recent story first, unless a since parameter is given.

angel.feeds.consume({
    since: 'PRESAVED_UNIX_TIMESTAMP',
    personalized: 1,
    access_token: 'access_token_here'
}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Search

Specification regardings calls and parameters for search is available at: https://angel.co/api/spec/search

Search Entity.

Search by name for Startups, Users, MarketTags and LocationTags, optionally narrowing the results by type. Results are sorted by a mix of match and popularity.

angel.search.search({
    query: "hamza-waqas",
    type: "User"
}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Search by Slugs

Search for entity by slug directly.

angel.search.slugs({
    query: "hamza-waqas"
}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Comments

Specification for the comments is available at: https://angel.co/api/spec/comments

Get Comments

Returns all the comments of entity.

angel.comments.get({
    commentable_type: "Startup",
    commentable_id: 6702
}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Create Comment

Creates a new comment against commentable item.

angel.comments.create('I b reviewing it now!', {
    commentable_type: "Startup",
    commentable_id: 6702
}, function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Delete a comment

Deletes a comment.

angel.comments.delete('comment_id', function(err, body) {
    if ( err )
        return console.log(err);

    console.log(body);
});

Contribution

This wrapper is solely written at Kuew Inc by Hamza Waqas

1.1.0

10 years ago

1.0.0

10 years ago