pycrunchbase¶

class pycrunchbase.Acquisition(data)¶

Represents a Acquisition on CrunchBase

class pycrunchbase.Address(data)¶

Represents a Address on CrunchBase

class pycrunchbase.Category(data)¶

Represents a Category on CrunchBase

class pycrunchbase.Degree(data)¶

Represents a Degree on CrunchBase

class pycrunchbase.FundingRound(data)¶

Represents a FundingRound on CrunchBase

class pycrunchbase.Fund(data)¶

Represents an Fund on CrunchBase Previously known as a FundRaise.

class pycrunchbase.Image(data)¶

Represents a Image on CrunchBase

class pycrunchbase.Investment(data)¶

Represents a Investment (investor-investment) on CrunchBase

class pycrunchbase.IPO(data)¶

Represents an IPO on CrunchBase

class pycrunchbase.Job(data)¶

Represents a Job on CrunchBase

class pycrunchbase.Location(data)¶

Represents a Location on CrunchBase

class pycrunchbase.News(data)¶

Represents a News on CrunchBase

class pycrunchbase.Organization(data)¶

Represents an Organization on CrunchBase

class pycrunchbase.Page(name, data)¶

A Page represents a a page of results returned by CrunchBase. Page contains useful information regarding how many items there are in total (total_items), items per page (items_per_page), etc.

A page contains information for going to the prev/next page (if available).

The data that is used to initialize a Page looks like this:

"data": {
    "paging": {
        "items_per_page": 1000,
        "current_page": 1,
        "number_of_pages": 1,
        "next_page_url": null,
        "prev_page_url": null,
        "total_items": 1,
        "sort_order": "custom"
    },
    "items": [
     {
        "properties": {
            "path": "organization/example",
            "name": "Example",
            "updated_at": 1423666090,
            "created_at": 1371717055,
         },
         "type": "Organization",
         "uuid": "uuid"
     }
    ]
}

class pycrunchbase.PageItem(data)¶

A item within a Page.

A page is a homogenous collection of PageItem, and there are many kinds of PageItem. build() is a helper class method to help build the correct type of PageItem based on

1. path, or
2. type

class pycrunchbase.Person(data)¶

Represents a Person on CrunchBase

class pycrunchbase.Product(data)¶

Represents a Product on CrunchBase

class pycrunchbase.Relationship(name, data)¶

A Relationhip represents relationship between a Node and interesting information regarding the Node.

This is a summary returned alongside the Node details information, e.g. ad call to /organizatin/example will return many properties and many relationships.

To get more details of this relationship, call CrunchBase‘s more().

get(i)¶

Gets the i-th element of this page

Args:

i (int): 0-based index of the element to retrieve

Returns:

PageItem: if valid item exists at index i None if the index is too small or too large

class pycrunchbase.StockExchange(data)¶

Represents a Website on CrunchBase

class pycrunchbase.Video(data)¶

Represents a Video on CrunchBase

class pycrunchbase.Website(data)¶

Represents a Website on CrunchBase

class pycrunchbase.CrunchBase(api_key=None)¶

Class that manages talking to CrunchBase API

acquisition(uuid)¶

Get the details of a acquisition given a uuid.

Returns:

Acquisition or None

categories()¶

Queries for a list of all active Categories, returns the first Page of results.

Returns:

Page or None

fund(permalink)¶

Get the details of an fundraise given a fundraise uuid.

Returns:

Fund or None

funding_round(uuid)¶

Get the details of a FundingRound given the uuid.

Returns

FundingRound or None

fundraise(permalink)¶

Get the details of an fundraise given a fundraise uuid.

Returns:

Fund or None

get_node(node_type, uuid, params=None)¶

Get the details of a Node from CrunchBase. The node_type must match that of CrunchBase’s, and the uuid is either the {uuid} or {permalink} as stated on their docs.

Returns:

dict: containing the data describing this node with the keys uuid, type, properties, relationships. Or None if there’s an error.

ipo(permalink)¶

Get the details of an ipo given a ipo uuid.

Returns:

IPO or None

locations()¶

Queries for a list of all active Locations, returns the first Page of results.

Returns:

Page or None

more(page)¶

Given a Page, tries to get more data using the first_page_url or next_page_url given in the response.

If page happens to be a Relationship, i.e. page.first_page_url is not None, we just call that url to retrieve the first page.

Returns:

None if there is no more page to get, else Relationship with the new data

organization(permalink)¶

Get the details of a organization given a organization’s permalink.

Returns:

Organization or None

organizations(name)¶

Search for a organization given a name, returns the first Page of results

Returns:

Page or None

people(permalink)¶

Get the details of a person given a person’s permalink

Returns:

Person or None

person(permalink)¶

Helper to maintain backward compatability

product(permalink)¶

Get the details of a product given a product permalink.

Returns:

Product or None

products()¶

Gets a list of products on CrunchBase

Relationship¶

class Relationship¶

A relationship

class NoneRelationship¶

A NoneRelationship is a subclass of Relationship that represents a non-existent relationship. Think of it as a None that is also a Relationship.

NoneRelationship and NonePageItem¶

A NoneRelationship is a subclass of Relationship that represents a non-existent relationship. Think of it as a None that is also a Relationship.

A NoneRelationship is returned by _parse_relationship() in Node, when there is an expected relationship but it isn’t in the returned data.

For example:

members = organization.team_members  # the data we got from CrunchBase was missing the team_members realtionship
assert instanceof(members[0], NoneRelationship) == True

The benefit of this is that calling the conventional relationship methods, such as get(), will return an object, rather than throwing an AttributeError:

members = organization.team_members
first_member = members.get(0)  # will not explode
assert bool(first_member) == False

Because Relationship are made up of PageItem, we have a similar None for it as well, called NonePageItem. The idea behind it is similar to what was discussed above as well:

# continuing the example from above, we have member
first_member = members.get(0)  # will not explode
assert first_member.name == None
assert first_member.whatever == None

Page¶

class Page¶

A ``Page`` presents a page of results as returned by a query on an endpoint of CrunchBase, e.g. the `/organizations` endpoint.

A Page contains information on how items there are per page, the current page number, amongst others.

items_per_page¶

an int representing the maximum number of items there can be in a page

current_page¶

The page number of this current page

number_of_pages¶

Number of pages there are for this query result

next_page_url¶

A url that you can request to get the next page of data

prev_page_url¶

A url that you can request to get the prev page of data

total_items¶

Total number of items that exist for this endpoint/query

sort_oder¶

The sorting order of this list of results

get(i)¶

Gets the i-th element in this page, 0-based.

Parameters:	i (int) – Index of PageItem to get, 0-based.
Returns:	the PageItem
Return type:	PageItem
Raises:	IndexError – if i is out the bounds TypeError – if i is not an int

Adding a node to pycrunchbase¶

If CrunchBase adds a new Node, we can add it to pycrunchbase as such:

1. Make a new file under resource/ with the name <node>.py, rerplacing <node> with the name of the node.
2. Write a test file for this node in tests/ called test_<node>.py.
3. Add a method on CrunchBase with the name <node> as the public api to access this node.
4. Ensure that all imports are working fine, this includes adding the node to resource/__init__.py, pycrunchbase/__init__.py.
5. Add a test case to test_pycrunchbase.py to test the public api for the new node.