crunchbase

Node module that wraps the Crunchbase API

npm install crunchbase
12 downloads in the last month

node-crunchbase: Easy wrapper around the CrunchBase API

This module is designed to be an easy-to-use wrapper around the CrunchBase API. This module is designed to be used with node.js, but could be modified to be used directly in the browser as well.

Install

  npm install crunchbase

Or from source:

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

Simple Examples

var crunchbase = require('crunchbase');

// Init the object with your API key
crunchbase.init(apikey);

// Search for a company name
crunchbase.search('', function(error, results) {
 if (!error) {
    console.log(results) // Print the search results
  }
});

Test

I have written unit tests for these API calls using the nodeunit framework. The unit tests make actual API calls, so be wary of your API call limit.

To run the unit tests:

nodeunit test/

Documentation

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

CrunchBase API

init(apikey)

Inits the object with your API data, including your API key.

Arguments

  • apikey - Your API key

Example

// Fetch the schedule for Week 1 of the NFL season
var crunchbase = require('crunchbase');
crunchbase.init(apikey);

getEntity(entityType, name, callback)

Returns information about the entity as a JSON object

Arguments

  • entityType - Can be either company, person, financial-organization, product, or service-provider
  • name - The entity name to search for
  • callback(err, body) - A callback which is called after the API call has returned, or an error has occurred.

Example

// Fetch information about Dropbox
crunchbase.getEntity('company', 'dropbox', function(error, entityInfo) {
 if (!error) {
    console.log(entityInfo);
  }
});

getEntityList(entityType, callback)

Returns every entity of a certain type in the system as a JSON object

Arguments

  • entityType - Can be either companies, people, financial-organizations, products, or service-providers
  • callback(err, body) - A callback which is called after the API call has returned, or an error has occurred.

Example

// Fetch every company in the system
crunchbase.getEntityList('company', function(error, allCompanies) {
 if (!error) {
    console.log(allCompanies);
  }
});

search(query, callback)

Returns search results as a JSON object

Arguments

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

Example

// Search for the company Xobni
crunchbase.search('xobni', function(error, xobniData) {
 if (!error) {
    console.log(xobniData);
  }
});

getPosts(entityType, name, firstName, lastName, callback)

Returns the posts of a person in an entity as a JSON object

Arguments

  • entityType - Can be either companies, people, financial-organizations, products
  • name - The entity name
  • firstName - The person's first name
  • lastName - The person's last name
  • 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
crunchbase.getPosts('companies', 'dropbox', 'drew', 'houston', function(error, postsData) {
 if (!error) {
    console.log(postsData);
  }
});
npm loves you