API v3 Compared to API v3.1

Our new API v3.1 builds upon the current API v3, but has new capabilities incorporated in order to allow you to get the data that you want in the most efficient manner possible. At a high level, enhancements included in v3.1 include:

• More Refined Searches - Specify exactly what results you want to see.
• Batch Search Capabilities - Pass parameters for several query requests in a single HTTP call.
• Faster Pagination - Key set pagination will enable you to traverse our dataset faster.

New API v3.1 Features

More Refined Searches

When you query an entity, you're now able to specify exactly what results you want to see. Previously with v3, you'd see results for all relationships included in your query. Now you can customize your query to pull only the results that you want to see. For example, if you're only interested in funding rounds and investors of a company, you can specify this in your query to see only those results. To do this, just add the relationships you'd like to see the results for at the end of the query.

https://api.crunchbase.com/v3.1/organizations/facebook?relationships=funding_rounds,investors&user_key=INSERT_KEY_HERE

Batch Search Capabilities

A new batching endpoint will allow you to pass parameters for several query requests in a single HTTP call, and even specify the relationships for each query. Your queries will be processed in parallel and results will be returned sequentially in the original order. Once all requests have been completed, a consolidated response will be passed back to you and the HTTP connection will be closed. To leverage this, you can now call our batch endpoint:

http://api.crunchbase.com/v3.1/batch

Use an array of requests with the following parameters when calling the batch endpoint:

• entity_type: any available type that has a collection (Organization, Person, Product, FundingRound, Acquisition, Ipo, Fund)
• entity_uuid: UUID of corresponding entity
• relationships: An array with the relationships name (string)

{"requests": [
  { "type": "<entity_type>", "uuid": "<entity_uuid>", "relationships": ["<relationship_name>"]}
]
}

{"requests":[
    { "type":"Organization","uuid":"df6628127f970b439d3e12f64f504fbb","relationships": ["investors","funding_rounds"]},
    { "type":"Organization","uuid":"fd80725f53fc70099878aeecf1e9ffbb","relationships": ["news","featured_team"]},
    { "type":"Organization","uuid":"902deab4ec4168ced9dfc0c959578176","relationships": ["investments","funds"]},
    { "type":"Person","uuid":"43b343a7ff56090a63fa5f833e55ea6d","relationships": ["primary_location","jobs","investments"]},
    { "type":"Product","uuid":"1767f73acc385927b66e51d1308d6c9d","relationships": ["owner","websites"]},
    { "type":"FundingRound","uuid":"08c74f1c6f8d9a2b95a095e61e558ccf","relationships": ["investments","investors","funded_organization"]},
    { "type":"Acquisition","uuid":"11cc4a63be13d7d3191c50bd2cd73a71","relationships": ["acquiree","acquirer","news"]},
    { "type":"Ipo","uuid":"bee91e2e4cfb70deb19d42e4bf991848","relationships": ["funded_company","news"]},
    { "type":"Fund","uuid":"a90b8ad0668ab1d2d5b4162277a3e6df","relationships": ["venture_firm","news"]}
    ]
}

Faster Pagination

Key set pagination will enable you to traverse our dataset faster. If you’re looking to extract all data results from a given endpoint, you will no longer have to paginate through the entire collection using the page number. We now provide pre-populated pagination URLs in your query results so that you can paginate through the collection efficiently as possible. Using page numbers to traverse a set can cause you to miss entities as the set changes while you paginate. Switching to keyset pagination guarantees that you will never miss an entity! As the set changes the keys remain constant so you can rely on the provided URLs never missing a beat.

In your query results, under the 'data' array, there will now be the following fields:

• next_page_url
• prev_page_url
• key_set_url

For any queries that return more than 100 results and require pagination, the key_set_url will have the compiled version of the respective fast pagination, so if you continuously use the key_set_url for each page of the results, it will traverse through the collection until you reach the end of the results in which case it will return NULL.

Changes to the API

In the next section we list each endpoint with associated changes...

/organizations/

*As a note, some permalinks have changed in our migration process.

/people/

*As a note, some permalinks have changed in our migration process.

/products

/ipos/

/funds/

/funding-rounds/

/acquisitions/

/locations

/categories

Changes to the CSV Exports

In addition to changes to the REST API, there will be some changes to our CSV exports.

*Formatting Changes: Category_list is now delimitated by a comma "," instead of a pipe "|"