Using Entity Lookup API
Instructions on how to use Crunchbase's Entity Lookup API endpoints
The Entity Lookup API endpoints are provided so you can retrieve data - data fields and relationships - from a specific entity. We provide Entity Lookup endpoints for many of our collections - e.g. organizations, people, funding rounds, and acquisitions. If any ranges or limitations exist, they will be noted within our reference documentation. For details on all of our collections, please visit our Legacy API Reference page
To make a request using our Entity Lookup APIs, you must provide the following:
- a user key
- an {entity_id} - which can either be the UUID or the permalink (e.g. "crunchbase") of the entity
You can also ask for additional data fields and relationships in the response by adding the "field_ids" and/or "card_ids" parameters to the request. Here is an example below:
GET https://api.crunchbase.com/api/v4/entities/organizations/tesla-motors?card_ids=founders,raised_funding_rounds&field_ids=categories,short_description,rank_org_company,founded_on,website,facebook,created_at&user_key=INSERT_KEY_HERE
curl --request GET 'https://api.crunchbase.com/api/v4/entities/organizations/tesla-motors?card_ids=founders,raised_funding_rounds&field_ids=categories,short_description,rank_org_company,founded_on,website,facebook,created_at&user_key=INSERT_KEY_HERE'
How do I know what data are available to be returned in the response?
You can quickly see what data fields & relationships are available to be returned in the response for each collection by going to the specific endpoint's response schema.
- The field names listed under "Properties" are what you will put as the value for "field_ids"
- The card names listed under "Cards" are what you will put as the value for "card_ids"
Steps by Steps:
-
- First go to the endpoint that you are interested in (let's say Entity Lookup for Organization)
-
- Scroll down to the Responses section
-
- Click on Schema (screenshot below)
Pro Tips: find permalink easily
Want to find the permalink for an entity?
- Go to www.crunchbase.com to find the entity you want, then take the last portion of the URL to get your permalink --> https://www.crunchbase.com/organization/{permalink}
- Use the autocomplete API - more details here
Expect all data fields & relationships to be optional
Unless otherwise called out as a required field or relationship in the response schema, please configure your system/process to treat data fields & relationships (e.g. "card_ids") in the response as optional.
"Card" returns 100 items max
If you choose to add a "card_id" to your request, please note that "card" will only return a max of 100 items.
To retrieve more results from a "card", you can paginate for more results by using the lookup API endpoint for a single card. More details in the section below
How do I get more results from a single "card_id"?
To retrieve more results from a "card", you can paginate for more results by using the lookup API endpoint for a single card. (ex: /entities/organizations/{entity_id}/cards/{card_id})
For step-by-step instruction, please refer to Get More Results from Card_id .
Updated about 2 months ago