{"__v":10,"_id":"56bac66503e4a61900a52177","category":{"project":"54424ec108d2440800d6d02f","version":"5514597be74c1c2300f9b33e","_id":"56bacb4cb77e261700bc1535","pages":[],"__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-10T05:31:56.017Z","from_sync":false,"order":2,"slug":"rest-api","title":"REST API"},"parentDoc":null,"project":"54424ec108d2440800d6d02f","user":"5424edfd1972e21d7dae4e99","version":{"__v":5,"_id":"5514597be74c1c2300f9b33e","forked_from":"54424efc08d2440800d6d036","project":"54424ec108d2440800d6d02f","createdAt":"2015-03-26T19:09:47.065Z","releaseDate":"2015-03-26T19:09:47.065Z","categories":["5514597be74c1c2300f9b33f","5514597be74c1c2300f9b340","5514597be74c1c2300f9b341","5514597be74c1c2300f9b342","5514597be74c1c2300f9b343","56bacaf4b77e261700bc1533","56bacb1e4aa5930d00da77d6","56bacb4cb77e261700bc1535","56bacc465d0f400d00ac80e5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-10T05:11:01.229Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Build powerful applications and integrate Crunchbase into your web and mobile applications with the REST API.  The Crunchbase API is a read-only RESTful service that enables approved developers to leverage the same data that powers [www.crunchbase.com](http://www.crunchbase.com).\n\nTo get a better sense of what's available through the REST API, you can compare the [Crunchbase company page](https://www.crunchbase.com/organization/crunchbase) with [JSON returned from the API](http://static.crunchbase.com/data_crunchbase/sample_organization_crunchbase.json). \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Accessing the REST API\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Access to the Full API Requires an Advanced or Commercial License\",\n  \"body\": \"If you are not already registered for a Crunchbase Data account, [register here](https://about.crunchbase.com/solutions/).\"\n}\n[/block]\nAdvanced and Commercial licensees have access to the full Crunchbase API.  Basic Access licensees are limited to the [/odm-organizations](/docs/odm-organizations) and [/odm-people ](/docs/odm-people) collection endpoints which return data from the [Open Data Map](doc:open-data-map).\n\nThe REST API can be accessed programmatically (the most common use case), and a number of developers have written [Language-Specific Libraries](doc:language-specific-libraries) to jump-start your development.\n\nFor simple testing / inspection, the Crunchbase API can also be accessed through any web browser capable of displaying JSON.\n\nAll API calls require a user key which is emailed to you following registration.  If you lose your key, contact [data:::at:::crunchbase.com](mailto:data@crunchbase.com).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nThe Crunchbase API uses token-based authentication, which means that developers must pass their individual user_key parameter with every request. An example request for the [/organizations](doc:organizations) endpoint would read as follows:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.crunchbase.com/v/3/organizations?user_key=[user_key]\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nThis `user_key` is used to validate each developer's access to the API and ensure that any rate limits or quotas are respected.  If you omit the user_key, overrun a rate limit, or exceed a quota, the system will respond with an error message.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Collections\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"If you are attempting to paginate through an entire collection, we recommend that you use the [Complete Node List](doc:node-export) export.  This alleviates the need to paginate and includes an updated_at timestamp for each node.\",\n  \"title\": \"Processing Entire Collections\"\n}\n[/block]\nThe Crunchbase API provides Collection endpoints to retrieve the entire set and core properties of many of the important Item types in the Crunchbase Dataset.  The Crunchbase API returns 100 items per page.  \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Node Type\",\n    \"h-1\": \"Endpoint\",\n    \"0-0\": \"[Organization](doc:organization)\",\n    \"0-1\": \"[/organizations](doc:organizations)\",\n    \"1-0\": \"[Person](doc:person)\",\n    \"1-1\": \"[/people](doc:peopleinput)\",\n    \"2-0\": \"[Product](doc:product)\",\n    \"2-1\": \"[/products](doc:products)\",\n    \"3-0\": \"[Category](doc:category)\",\n    \"3-1\": \"[/categories](doc:categories)\",\n    \"4-0\": \"[Location](doc:location)\",\n    \"4-1\": \"[/locations](doc:testinput)\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Item Details\"\n}\n[/block]\nFurther, the Crunchbase API provides Item Detail endpoints to retrieve not only the core properties of each Node but also the details of related Items.\n\nSuch endpoints are available for the following Items:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Node Type\",\n    \"h-1\": \"Endpoint\",\n    \"0-0\": \"[Organization](doc:organization)\",\n    \"0-1\": \"[/organizations/:permalink](doc:organizationpermalink)\",\n    \"1-0\": \"[Person](doc:person)\",\n    \"1-1\": \"[/people/:permalink](doc:personpermalink)\",\n    \"2-0\": \"[Product](doc:product)\",\n    \"2-1\": \"[/products/:permalink](doc:productpermalink)\",\n    \"3-0\": \"[FundingRound](doc:funding-round)\",\n    \"3-1\": \"[/funding_rounds/:uuid](doc:testinput-1)\",\n    \"4-0\": \"[Acquisition](doc:acquisition)\",\n    \"4-1\": \"[/acquisitions/:uuid](doc:acquisitionuuid)\",\n    \"5-0\": \"[Ipo](doc:ipo)\",\n    \"5-1\": \"[/ipos/:uuid](doc:ipouuid)\",\n    \"6-0\": \"[Fund](doc:fund-raise)\",\n    \"6-1\": \"[/funds/:uuid](doc:fund_raiseuuid)\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\nThe Crunchbase API returns 10 items per relationship type. For example, you might get 10 investments. Then you can use the investments endpoint [/organizations/:permalink/investments](doc:organizationspermalinkrelationship_name)  for an entity to get a further 1000 investments per page if you require more.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Using the REST API\"\n}\n[/block]\nWe encourage you to leverage the API for your internal business and research needs.  Unless otherwise noted in your license (see [License Agreement](doc:license) and [Data Access Terms](doc:terms)), you may not license, sublicense, sell, offer to sell, distribute or otherwise provide any of the Crunchbase data to any third parties.\n\n### Attribution Requirements\nWhen sharing information about the data, follow these attribution requirements.\n\n  * Attribution must be accompanied by a hyperlink to Crunchbase\n  * If content being attributed is primarily about one entity, link must point to that entity on Crunchbase.\n  * Link must be plainly visible to end user\n  * Link must be in close proximity to the attributed data\n  * Link must be visible to Internet spiders (e.g. Googlebot)\n  * Link cannot include the “nofollow” tag\"","excerpt":"","slug":"using-the-api","type":"basic","title":"Using the API"}
Build powerful applications and integrate Crunchbase into your web and mobile applications with the REST API. The Crunchbase API is a read-only RESTful service that enables approved developers to leverage the same data that powers [www.crunchbase.com](http://www.crunchbase.com). To get a better sense of what's available through the REST API, you can compare the [Crunchbase company page](https://www.crunchbase.com/organization/crunchbase) with [JSON returned from the API](http://static.crunchbase.com/data_crunchbase/sample_organization_crunchbase.json). [block:api-header] { "type": "basic", "title": "Accessing the REST API" } [/block] [block:callout] { "type": "success", "title": "Access to the Full API Requires an Advanced or Commercial License", "body": "If you are not already registered for a Crunchbase Data account, [register here](https://about.crunchbase.com/solutions/)." } [/block] Advanced and Commercial licensees have access to the full Crunchbase API. Basic Access licensees are limited to the [/odm-organizations](/docs/odm-organizations) and [/odm-people ](/docs/odm-people) collection endpoints which return data from the [Open Data Map](doc:open-data-map). The REST API can be accessed programmatically (the most common use case), and a number of developers have written [Language-Specific Libraries](doc:language-specific-libraries) to jump-start your development. For simple testing / inspection, the Crunchbase API can also be accessed through any web browser capable of displaying JSON. All API calls require a user key which is emailed to you following registration. If you lose your key, contact [data@crunchbase.com](mailto:data@crunchbase.com). [block:api-header] { "type": "basic", "title": "Authentication" } [/block] The Crunchbase API uses token-based authentication, which means that developers must pass their individual user_key parameter with every request. An example request for the [/organizations](doc:organizations) endpoint would read as follows: [block:code] { "codes": [ { "code": "https://api.crunchbase.com/v/3/organizations?user_key=[user_key]", "language": "text" } ] } [/block] This `user_key` is used to validate each developer's access to the API and ensure that any rate limits or quotas are respected. If you omit the user_key, overrun a rate limit, or exceed a quota, the system will respond with an error message. [block:api-header] { "type": "basic", "title": "Collections" } [/block] [block:callout] { "type": "warning", "body": "If you are attempting to paginate through an entire collection, we recommend that you use the [Complete Node List](doc:node-export) export. This alleviates the need to paginate and includes an updated_at timestamp for each node.", "title": "Processing Entire Collections" } [/block] The Crunchbase API provides Collection endpoints to retrieve the entire set and core properties of many of the important Item types in the Crunchbase Dataset. The Crunchbase API returns 100 items per page. [block:parameters] { "data": { "h-0": "Node Type", "h-1": "Endpoint", "0-0": "[Organization](doc:organization)", "0-1": "[/organizations](doc:organizations)", "1-0": "[Person](doc:person)", "1-1": "[/people](doc:peopleinput)", "2-0": "[Product](doc:product)", "2-1": "[/products](doc:products)", "3-0": "[Category](doc:category)", "3-1": "[/categories](doc:categories)", "4-0": "[Location](doc:location)", "4-1": "[/locations](doc:testinput)" }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Item Details" } [/block] Further, the Crunchbase API provides Item Detail endpoints to retrieve not only the core properties of each Node but also the details of related Items. Such endpoints are available for the following Items: [block:parameters] { "data": { "h-0": "Node Type", "h-1": "Endpoint", "0-0": "[Organization](doc:organization)", "0-1": "[/organizations/:permalink](doc:organizationpermalink)", "1-0": "[Person](doc:person)", "1-1": "[/people/:permalink](doc:personpermalink)", "2-0": "[Product](doc:product)", "2-1": "[/products/:permalink](doc:productpermalink)", "3-0": "[FundingRound](doc:funding-round)", "3-1": "[/funding_rounds/:uuid](doc:testinput-1)", "4-0": "[Acquisition](doc:acquisition)", "4-1": "[/acquisitions/:uuid](doc:acquisitionuuid)", "5-0": "[Ipo](doc:ipo)", "5-1": "[/ipos/:uuid](doc:ipouuid)", "6-0": "[Fund](doc:fund-raise)", "6-1": "[/funds/:uuid](doc:fund_raiseuuid)" }, "cols": 2, "rows": 7 } [/block] The Crunchbase API returns 10 items per relationship type. For example, you might get 10 investments. Then you can use the investments endpoint [/organizations/:permalink/investments](doc:organizationspermalinkrelationship_name) for an entity to get a further 1000 investments per page if you require more. [block:api-header] { "type": "basic", "title": "Using the REST API" } [/block] We encourage you to leverage the API for your internal business and research needs. Unless otherwise noted in your license (see [License Agreement](doc:license) and [Data Access Terms](doc:terms)), you may not license, sublicense, sell, offer to sell, distribute or otherwise provide any of the Crunchbase data to any third parties. ### Attribution Requirements When sharing information about the data, follow these attribution requirements. * Attribution must be accompanied by a hyperlink to Crunchbase * If content being attributed is primarily about one entity, link must point to that entity on Crunchbase. * Link must be plainly visible to end user * Link must be in close proximity to the attributed data * Link must be visible to Internet spiders (e.g. Googlebot) * Link cannot include the “nofollow” tag"