{"_id":"59600120338757001b822948","project":"54424ec108d2440800d6d02f","version":{"_id":"5514597be74c1c2300f9b33e","forked_from":"54424efc08d2440800d6d036","project":"54424ec108d2440800d6d02f","__v":5,"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"},"category":{"_id":"5514597be74c1c2300f9b33f","__v":11,"version":"5514597be74c1c2300f9b33e","pages":["5514597ce74c1c2300f9b348","5514597ce74c1c2300f9b349","5514597ce74c1c2300f9b34a","5514597ce74c1c2300f9b34b","5514597ce74c1c2300f9b34c","551c77d2b7a32b3b00d1ef22","5567a76c6976ef0d0099c5ec","56bac3e28fce0e1900d99367","56bac4255d0f400d00ac80e0","56bac451c275570d00ce7111","56bac5fd47ff0e0d0098651b","56bac62ff60d630d006885a9","56bac66503e4a61900a52177","56bac6858fce0e1900d9936b","56bac85203e4a61900a52179"],"project":"54424ec108d2440800d6d02f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-18T11:28:01.705Z","from_sync":false,"order":0,"slug":"api-documentation","title":"Documentation"},"user":"5500ce0cd013312100fbf565","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-07T21:46:08.549Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"We're excited to announce our new API v3.1 is coming this September! 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:\n\n* [More Refined Searches](#section-more-refined-searches) - Specify exactly what results you want to see.\n* [Batch Search Capabilities](#section-batch-search-capabilities) - Pass parameters for several query requests in a single HTTP call. \n* [Faster Pagination](#section-faster-pagination) - Key set pagination will enable you to traverse our dataset faster.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Accessing the New API & Timeline\"\n}\n[/block]\nAPI v3.1 will go live mid September. \n\nTo prepare, a beta version of v3.1 will be launched on August 10th. During the beta period, you’ll be able to make calls against a working version of v3.1 ahead of the official launch date. This version will have weekly data refreshes during the beta period, and then daily data refreshes the two weeks leading up to v3.1 launch. There will also be a dedicated support team on call to assist with any questions or potential issues. \n\nOnce API v3.1 is officially launched, API v3 will still be available for three months, but we will no longer be pushing updated data to it.\n[block:api-header]\n{\n  \"title\": \"New API v3.1 Features\"\n}\n[/block]\n## More Refined Searches\nWhen 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. \n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.crunchbase.com/v3.1/organizations/facebook?relationships=funding_rounds,investors?user_key=INSERT_KEY_HERE\",\n      \"language\": \"text\",\n      \"name\": \"Example API Call\"\n    }\n  ]\n}\n[/block]\n## Batch Search Capabilities\nA 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: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://api.crunchbase.com/v/3.1/batch\",\n      \"language\": \"text\",\n      \"name\": \"Batch Endpoint\"\n    }\n  ]\n}\n[/block]\nUse an array of requests with the following parameters when calling the batch endpoint:\n* `entity_type`: any available type that has a collection (Organization, Person, Product, FundingRound, Acquisition, Ipo, Fund)\n* `entity_uuid`: UUID of corresponding entity\n* `relationships`: An array with the relationships name (string) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\\"requests\\\": [\\n  { \\\"type\\\": \\\"<entity_type>\\\", \\\"uuid\\\": \\\"<entity_uuid>\\\", \\\"relationships\\\": [\\\"<relationship_name>\\\"]}\\n]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Single Request Example\"\n    },\n    {\n      \"code\": \"{\\\"requests\\\":[\\n    { \\\"type\\\":\\\"Organization\\\",\\\"uuid\\\":\\\"df6628127f970b439d3e12f64f504fbb\\\",\\\"relationships\\\": [\\\"investors\\\",\\\"funding_rounds\\\"]},\\n    { \\\"type\\\":\\\"Organization\\\",\\\"uuid\\\":\\\"fd80725f53fc70099878aeecf1e9ffbb\\\",\\\"relationships\\\": [\\\"news\\\",\\\"featured_team\\\"]},\\n    { \\\"type\\\":\\\"Organization\\\",\\\"uuid\\\":\\\"902deab4ec4168ced9dfc0c959578176\\\",\\\"relationships\\\": [\\\"investments\\\",\\\"funds\\\"]},\\n    { \\\"type\\\":\\\"Person\\\",\\\"uuid\\\":\\\"43b343a7ff56090a63fa5f833e55ea6d\\\",\\\"relationships\\\": [\\\"primary_location\\\",\\\"jobs\\\",\\\"investments\\\"]},\\n    { \\\"type\\\":\\\"Product\\\",\\\"uuid\\\":\\\"1767f73acc385927b66e51d1308d6c9d\\\",\\\"relationships\\\": [\\\"owner\\\",\\\"websites\\\"]},\\n    { \\\"type\\\":\\\"FundingRound\\\",\\\"uuid\\\":\\\"08c74f1c6f8d9a2b95a095e61e558ccf\\\",\\\"relationships\\\": [\\\"investments\\\",\\\"investors\\\",\\\"funded_organization\\\"]},\\n    { \\\"type\\\":\\\"Acquisition\\\",\\\"uuid\\\":\\\"11cc4a63be13d7d3191c50bd2cd73a71\\\",\\\"relationships\\\": [\\\"acquiree\\\",\\\"acquirer\\\",\\\"news\\\"]},\\n    { \\\"type\\\":\\\"Ipo\\\",\\\"uuid\\\":\\\"bee91e2e4cfb70deb19d42e4bf991848\\\",\\\"relationships\\\": [\\\"funded_company\\\",\\\"news\\\"]},\\n    { \\\"type\\\":\\\"Fund\\\",\\\"uuid\\\":\\\"a90b8ad0668ab1d2d5b4162277a3e6df\\\",\\\"relationships\\\": [\\\"venture_firm\\\",\\\"news\\\"]}\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Multiple Request Example\"\n    }\n  ]\n}\n[/block]\n## Faster Pagination\nKey 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. \n\nIn your query results, under the 'data' array, there will now be the following fields:\n\n* `next_page_url`\n* `prev_page_url`\n* `key_set_url`\n\nFor 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. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Changes to the API\"\n}\n[/block]\nIn the next section we list each endpoint with associated changes...\n\n\n### /organizations/<permalink>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"field\",\n    \"0-1\": \"api_url\",\n    \"0-2\": \"new field that includes the full URL of the API endpoint\",\n    \"1-0\": \"relationship\",\n    \"1-1\": \"primary_image\",\n    \"1-2\": \"UUID, created_at, and updated_at will all refer to the entity; height, width, and filesize have been deprecated, these fields will always return 'null'\",\n    \"2-0\": \"relationship\",\n    \"2-1\": \"board_members_and_advisors\",\n    \"2-2\": \"only current board members and advisors will be returned\",\n    \"3-0\": \"relationship\",\n    \"3-1\": \"headquarters\",\n    \"3-2\": \"the following fields have been removed: region_code2, country_code2, country_code3, latitude and longitude\",\n    \"4-0\": \"relationship\",\n    \"4-1\": \"offices\",\n    \"4-2\": \"will only return headquarters location, multiple office locations has been deprecated\",\n    \"5-0\": \"relationship\",\n    \"5-1\": \"products\",\n    \"5-2\": \"product data has been deprecated, this field will always return an empty array\",\n    \"6-0\": \"relationship\",\n    \"6-1\": \"funding_rounds\",\n    \"6-2\": \"the investments nodes which appear within relationships will no longer include copies of the funding_round and  funding_organization nodes.  the investments will contain a new node for partners.\",\n    \"7-0\": \"relationship\",\n    \"7-1\": \"investments\",\n    \"7-2\": \"within relationships we have added two nodes invested_in and partners; invested_in represents the company raising funds and partners represents the people at this organization who are responsible for the funding round\",\n    \"8-0\": \"relationship\",\n    \"8-1\": \"acquisition\",\n    \"8-2\": \"only the acquiree is returned in the response as the acquirer is implied\",\n    \"9-0\": \"relationship\",\n    \"9-1\": \"competitors\",\n    \"9-2\": \"competitor data has been deprecated, this field will always return an empty array\",\n    \"10-0\": \"relationship\",\n    \"10-1\": \"customers\",\n    \"10-2\": \"customer data has been deprecated, this field will always return an empty array\",\n    \"11-0\": \"relationship\",\n    \"11-1\": \"memberships\",\n    \"11-2\": \"membership data has been deprecated, this field will always return an empty array\",\n    \"12-0\": \"relationship\",\n    \"12-1\": \"members\",\n    \"12-2\": \"membership data has been deprecated, this field will always return an empty array\",\n    \"13-0\": \"relationship\",\n    \"13-1\": \"websites\",\n    \"13-2\": \"will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'\",\n    \"14-0\": \"relationship\",\n    \"14-1\": \"images\",\n    \"14-2\": \"duplicates primary_images field, support for multiple images has been deprecated\",\n    \"15-0\": \"relationship\",\n    \"15-1\": \"videos\",\n    \"15-2\": \"video data has been deprecated, this field will always return an empty array\",\n    \"16-0\": \"relationship\",\n    \"16-1\": \"news\",\n    \"16-2\": \"articles without a posted_on date will no longer be returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 16\n}\n[/block]\n ### /people/<permalink>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"field\",\n    \"0-1\": \"api_url\",\n    \"0-2\": \"new field that includes the full URL of the API endpoint\",\n    \"1-0\": \"relationship\",\n    \"1-1\": \"primary_image\",\n    \"1-2\": \"UUID, created_at, and updated_at will all refer to the entity; height, width, and filesize have been deprecated, these fields will always return 'null'\",\n    \"2-0\": \"relationship\",\n    \"2-1\": \"advisory_roles\",\n    \"2-2\": \"only current board members and advisors will be returned\",\n    \"3-0\": \"relationship\",\n    \"3-1\": \"investments\",\n    \"3-2\": \"within relationships we have added two nodes invested_in and partners; invested_in represents the company raising funds and partners represents the people at this organization who are responsible for the funding round\",\n    \"4-0\": \"relationship\",\n    \"4-1\": \"memberships\",\n    \"4-2\": \"membership data has been deprecated, this field will always return an empty array\",\n    \"5-0\": \"relationship\",\n    \"5-1\": \"websites\",\n    \"5-2\": \"will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'\",\n    \"6-0\": \"relationship\",\n    \"6-1\": \"images\",\n    \"6-2\": \"duplicates primary_images field, support for multiple images has been deprecated\",\n    \"7-0\": \"relationship\",\n    \"7-1\": \"videos\",\n    \"7-2\": \"video data has been deprecated, this field will always return an empty array\",\n    \"8-0\": \"relationship\",\n    \"8-1\": \"news\",\n    \"8-2\": \"articles without a posted_on date will no longer be returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n ### /products\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"collection\",\n    \"0-1\": \"\",\n    \"0-2\": \"product data has been deprecated, this field will always return an empty array\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n ### /ipos/<uuid>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"field\",\n    \"0-1\": \"api_url\",\n    \"0-2\": \"new field that includes the full URL of the API endpoint\",\n    \"1-0\": \"field\",\n    \"1-1\": \"shares_sold\",\n    \"1-2\": \"shares sold data has been deprecated, this field will always return an empty array\",\n    \"2-0\": \"relationship\",\n    \"2-1\": \"stock_exchange\",\n    \"2-2\": \"UUID, created_at, and updated_at will all refer to the entity\",\n    \"3-0\": \"relationship\",\n    \"3-1\": \"websites\",\n    \"3-2\": \"will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'\",\n    \"4-0\": \"relationship\",\n    \"4-1\": \"images\",\n    \"4-2\": \"duplicates primary_images field, support for multiple images has been deprecated\",\n    \"5-0\": \"relationship\",\n    \"5-1\": \"videos\",\n    \"5-2\": \"video data has been deprecated, this field will always return an empty array\",\n    \"6-0\": \"relationship\",\n    \"6-1\": \"news\",\n    \"6-2\": \"articles without a posted_on date will no longer be returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n ### /funds/<uuid>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"relationship\",\n    \"0-1\": \"investors\",\n    \"0-2\": \"the investors node will contain a list of investors in the fund.  today, the investors node always returns an empty array.\",\n    \"1-0\": \"relationship\",\n    \"1-1\": \"websites\",\n    \"1-2\": \"will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'\",\n    \"2-0\": \"relationship\",\n    \"2-1\": \"images\",\n    \"2-2\": \"duplicates primary_images field, support for multiple images has been deprecated\",\n    \"3-0\": \"relationship\",\n    \"3-1\": \"videos\",\n    \"3-2\": \"video data has been deprecated, this field will always return an empty array\",\n    \"4-0\": \"relationship\",\n    \"4-1\": \"news\",\n    \"4-2\": \"articles without a posted_on date will no longer be returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n ### /funding-rounds/<uuid>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"relationship\",\n    \"0-1\": \"investments\",\n    \"0-2\": \"the investments nodes which appear within relationships will no longer include copies of the funding_round and  funding_organization nodes.  the investments will contain a new node for partners.\",\n    \"1-0\": \"relationship\",\n    \"1-1\": \"websites\",\n    \"1-2\": \"will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'\",\n    \"2-0\": \"relationship\",\n    \"2-1\": \"images\",\n    \"2-2\": \"duplicates primary_images field, support for multiple images has been deprecated\",\n    \"3-0\": \"relationship\",\n    \"3-1\": \"videos\",\n    \"3-2\": \"video data has been deprecated, this field will always return an empty array\",\n    \"4-0\": \"relationship\",\n    \"4-1\": \"news\",\n    \"4-2\": \"articles without a posted_on date will no longer be returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n ### /acquisitions/<uuid>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"relationship\",\n    \"0-1\": \"images\",\n    \"0-2\": \"duplicates primary_images field, support for multiple images has been deprecated\",\n    \"1-0\": \"relationship\",\n    \"1-1\": \"videos\",\n    \"1-2\": \"video data has been deprecated, this field will always return an empty array\",\n    \"2-0\": \"relationship\",\n    \"2-1\": \"news\",\n    \"2-2\": \"articles without a posted_on date will no longer be returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n ### /locations\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"field\",\n    \"0-1\": \"region_code2\",\n    \"0-2\": \"will be 'NULL' unless the location_type is region (previously was always filled)\",\n    \"1-0\": \"field\",\n    \"1-1\": \"country_code2\",\n    \"1-2\": \"will be 'NULL' unless the location_type is country (previously was always filled)\",\n    \"2-0\": \"field\",\n    \"2-1\": \"country_code3\",\n    \"2-2\": \"will be 'NULL' unless the location_type is country (previously was always filled)\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n ### /categories\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Item\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"field\",\n    \"0-1\": \"organizations_in_category\",\n    \"0-2\": \"field has been deprecated and will always return 'NULL'\",\n    \"1-0\": \"field\",\n    \"1-1\": \"products_in_category\",\n    \"1-2\": \"field has been deprecated and will always return 'NULL'\",\n    \"2-0\": \"field\",\n    \"2-1\": \"events_in_category\",\n    \"2-2\": \"field has been deprecated and will always return 'NULL'\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Changes to the CSV Exports\"\n}\n[/block]\nIn addition to changes to the REST API, there will be some changes to our CSV exports.\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"CSV File\",\n    \"h-1\": \"Field Name\",\n    \"h-2\": \"Changes in v3.1\",\n    \"0-0\": \"organizations.csv\",\n    \"0-1\": \"primary_image\",\n    \"0-2\": \"Sizing parameters have been removed from the primary_image URL.\",\n    \"1-0\": \"people.csv\",\n    \"1-1\": \"primary_image\",\n    \"1-2\": \"Sizing parameters have been removed from the primary_image URL.\",\n    \"2-0\": \"products.csv\",\n    \"2-1\": \"all\",\n    \"2-2\": \"Product data has been deprecated and CSV will be removed.\",\n    \"3-0\": \"has_competitor.csv\",\n    \"3-1\": \"all\",\n    \"3-2\": \"Competitor data has been deprecated and CSV will be removed.\",\n    \"4-0\": \"has_customer.csv\",\n    \"4-1\": \"all\",\n    \"4-2\": \"Customer data has been deprecated and CSV will be removed.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"api-v31","type":"basic","title":"API v3.1 Coming Soon"}

API v3.1 Coming Soon


We're excited to announce our new API v3.1 is coming this September! 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](#section-more-refined-searches) - Specify exactly what results you want to see. * [Batch Search Capabilities](#section-batch-search-capabilities) - Pass parameters for several query requests in a single HTTP call. * [Faster Pagination](#section-faster-pagination) - Key set pagination will enable you to traverse our dataset faster. [block:api-header] { "type": "basic", "title": "Accessing the New API & Timeline" } [/block] API v3.1 will go live mid September. To prepare, a beta version of v3.1 will be launched on August 10th. During the beta period, you’ll be able to make calls against a working version of v3.1 ahead of the official launch date. This version will have weekly data refreshes during the beta period, and then daily data refreshes the two weeks leading up to v3.1 launch. There will also be a dedicated support team on call to assist with any questions or potential issues. Once API v3.1 is officially launched, API v3 will still be available for three months, but we will no longer be pushing updated data to it. [block:api-header] { "title": "New API v3.1 Features" } [/block] ## 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. [block:code] { "codes": [ { "code": "https://api.crunchbase.com/v3.1/organizations/facebook?relationships=funding_rounds,investors?user_key=INSERT_KEY_HERE", "language": "text", "name": "Example API Call" } ] } [/block] ## 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: [block:code] { "codes": [ { "code": "http://api.crunchbase.com/v/3.1/batch", "language": "text", "name": "Batch Endpoint" } ] } [/block] 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) [block:code] { "codes": [ { "code": "{\"requests\": [\n { \"type\": \"<entity_type>\", \"uuid\": \"<entity_uuid>\", \"relationships\": [\"<relationship_name>\"]}\n]\n}", "language": "json", "name": "Single Request Example" }, { "code": "{\"requests\":[\n { \"type\":\"Organization\",\"uuid\":\"df6628127f970b439d3e12f64f504fbb\",\"relationships\": [\"investors\",\"funding_rounds\"]},\n { \"type\":\"Organization\",\"uuid\":\"fd80725f53fc70099878aeecf1e9ffbb\",\"relationships\": [\"news\",\"featured_team\"]},\n { \"type\":\"Organization\",\"uuid\":\"902deab4ec4168ced9dfc0c959578176\",\"relationships\": [\"investments\",\"funds\"]},\n { \"type\":\"Person\",\"uuid\":\"43b343a7ff56090a63fa5f833e55ea6d\",\"relationships\": [\"primary_location\",\"jobs\",\"investments\"]},\n { \"type\":\"Product\",\"uuid\":\"1767f73acc385927b66e51d1308d6c9d\",\"relationships\": [\"owner\",\"websites\"]},\n { \"type\":\"FundingRound\",\"uuid\":\"08c74f1c6f8d9a2b95a095e61e558ccf\",\"relationships\": [\"investments\",\"investors\",\"funded_organization\"]},\n { \"type\":\"Acquisition\",\"uuid\":\"11cc4a63be13d7d3191c50bd2cd73a71\",\"relationships\": [\"acquiree\",\"acquirer\",\"news\"]},\n { \"type\":\"Ipo\",\"uuid\":\"bee91e2e4cfb70deb19d42e4bf991848\",\"relationships\": [\"funded_company\",\"news\"]},\n { \"type\":\"Fund\",\"uuid\":\"a90b8ad0668ab1d2d5b4162277a3e6df\",\"relationships\": [\"venture_firm\",\"news\"]}\n ]\n}", "language": "json", "name": "Multiple Request Example" } ] } [/block] ## 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. [block:api-header] { "type": "basic", "title": "Changes to the API" } [/block] In the next section we list each endpoint with associated changes... ### /organizations/<permalink> [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "field", "0-1": "api_url", "0-2": "new field that includes the full URL of the API endpoint", "1-0": "relationship", "1-1": "primary_image", "1-2": "UUID, created_at, and updated_at will all refer to the entity; height, width, and filesize have been deprecated, these fields will always return 'null'", "2-0": "relationship", "2-1": "board_members_and_advisors", "2-2": "only current board members and advisors will be returned", "3-0": "relationship", "3-1": "headquarters", "3-2": "the following fields have been removed: region_code2, country_code2, country_code3, latitude and longitude", "4-0": "relationship", "4-1": "offices", "4-2": "will only return headquarters location, multiple office locations has been deprecated", "5-0": "relationship", "5-1": "products", "5-2": "product data has been deprecated, this field will always return an empty array", "6-0": "relationship", "6-1": "funding_rounds", "6-2": "the investments nodes which appear within relationships will no longer include copies of the funding_round and funding_organization nodes. the investments will contain a new node for partners.", "7-0": "relationship", "7-1": "investments", "7-2": "within relationships we have added two nodes invested_in and partners; invested_in represents the company raising funds and partners represents the people at this organization who are responsible for the funding round", "8-0": "relationship", "8-1": "acquisition", "8-2": "only the acquiree is returned in the response as the acquirer is implied", "9-0": "relationship", "9-1": "competitors", "9-2": "competitor data has been deprecated, this field will always return an empty array", "10-0": "relationship", "10-1": "customers", "10-2": "customer data has been deprecated, this field will always return an empty array", "11-0": "relationship", "11-1": "memberships", "11-2": "membership data has been deprecated, this field will always return an empty array", "12-0": "relationship", "12-1": "members", "12-2": "membership data has been deprecated, this field will always return an empty array", "13-0": "relationship", "13-1": "websites", "13-2": "will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'", "14-0": "relationship", "14-1": "images", "14-2": "duplicates primary_images field, support for multiple images has been deprecated", "15-0": "relationship", "15-1": "videos", "15-2": "video data has been deprecated, this field will always return an empty array", "16-0": "relationship", "16-1": "news", "16-2": "articles without a posted_on date will no longer be returned" }, "cols": 3, "rows": 16 } [/block] ### /people/<permalink> [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "field", "0-1": "api_url", "0-2": "new field that includes the full URL of the API endpoint", "1-0": "relationship", "1-1": "primary_image", "1-2": "UUID, created_at, and updated_at will all refer to the entity; height, width, and filesize have been deprecated, these fields will always return 'null'", "2-0": "relationship", "2-1": "advisory_roles", "2-2": "only current board members and advisors will be returned", "3-0": "relationship", "3-1": "investments", "3-2": "within relationships we have added two nodes invested_in and partners; invested_in represents the company raising funds and partners represents the people at this organization who are responsible for the funding round", "4-0": "relationship", "4-1": "memberships", "4-2": "membership data has been deprecated, this field will always return an empty array", "5-0": "relationship", "5-1": "websites", "5-2": "will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'", "6-0": "relationship", "6-1": "images", "6-2": "duplicates primary_images field, support for multiple images has been deprecated", "7-0": "relationship", "7-1": "videos", "7-2": "video data has been deprecated, this field will always return an empty array", "8-0": "relationship", "8-1": "news", "8-2": "articles without a posted_on date will no longer be returned" }, "cols": 3, "rows": 8 } [/block] ### /products [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "collection", "0-1": "", "0-2": "product data has been deprecated, this field will always return an empty array" }, "cols": 3, "rows": 1 } [/block] ### /ipos/<uuid> [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "field", "0-1": "api_url", "0-2": "new field that includes the full URL of the API endpoint", "1-0": "field", "1-1": "shares_sold", "1-2": "shares sold data has been deprecated, this field will always return an empty array", "2-0": "relationship", "2-1": "stock_exchange", "2-2": "UUID, created_at, and updated_at will all refer to the entity", "3-0": "relationship", "3-1": "websites", "3-2": "will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'", "4-0": "relationship", "4-1": "images", "4-2": "duplicates primary_images field, support for multiple images has been deprecated", "5-0": "relationship", "5-1": "videos", "5-2": "video data has been deprecated, this field will always return an empty array", "6-0": "relationship", "6-1": "news", "6-2": "articles without a posted_on date will no longer be returned" }, "cols": 3, "rows": 6 } [/block] ### /funds/<uuid> [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "relationship", "0-1": "investors", "0-2": "the investors node will contain a list of investors in the fund. today, the investors node always returns an empty array.", "1-0": "relationship", "1-1": "websites", "1-2": "will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'", "2-0": "relationship", "2-1": "images", "2-2": "duplicates primary_images field, support for multiple images has been deprecated", "3-0": "relationship", "3-1": "videos", "3-2": "video data has been deprecated, this field will always return an empty array", "4-0": "relationship", "4-1": "news", "4-2": "articles without a posted_on date will no longer be returned" }, "cols": 3, "rows": 4 } [/block] ### /funding-rounds/<uuid> [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "relationship", "0-1": "investments", "0-2": "the investments nodes which appear within relationships will no longer include copies of the funding_round and funding_organization nodes. the investments will contain a new node for partners.", "1-0": "relationship", "1-1": "websites", "1-2": "will only return 4 results: homepage, facebook, twitter, and linkedin; UUID, created_at, and updated_at will all refer to the entity; blogs have been deprecated, these fields will always return 'null'", "2-0": "relationship", "2-1": "images", "2-2": "duplicates primary_images field, support for multiple images has been deprecated", "3-0": "relationship", "3-1": "videos", "3-2": "video data has been deprecated, this field will always return an empty array", "4-0": "relationship", "4-1": "news", "4-2": "articles without a posted_on date will no longer be returned" }, "cols": 3, "rows": 4 } [/block] ### /acquisitions/<uuid> [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "relationship", "0-1": "images", "0-2": "duplicates primary_images field, support for multiple images has been deprecated", "1-0": "relationship", "1-1": "videos", "1-2": "video data has been deprecated, this field will always return an empty array", "2-0": "relationship", "2-1": "news", "2-2": "articles without a posted_on date will no longer be returned" }, "cols": 3, "rows": 2 } [/block] ### /locations [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "field", "0-1": "region_code2", "0-2": "will be 'NULL' unless the location_type is region (previously was always filled)", "1-0": "field", "1-1": "country_code2", "1-2": "will be 'NULL' unless the location_type is country (previously was always filled)", "2-0": "field", "2-1": "country_code3", "2-2": "will be 'NULL' unless the location_type is country (previously was always filled)" }, "cols": 3, "rows": 2 } [/block] ### /categories [block:parameters] { "data": { "h-0": "Item", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "field", "0-1": "organizations_in_category", "0-2": "field has been deprecated and will always return 'NULL'", "1-0": "field", "1-1": "products_in_category", "1-2": "field has been deprecated and will always return 'NULL'", "2-0": "field", "2-1": "events_in_category", "2-2": "field has been deprecated and will always return 'NULL'" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Changes to the CSV Exports" } [/block] In addition to changes to the REST API, there will be some changes to our CSV exports. [block:parameters] { "data": { "h-0": "CSV File", "h-1": "Field Name", "h-2": "Changes in v3.1", "0-0": "organizations.csv", "0-1": "primary_image", "0-2": "Sizing parameters have been removed from the primary_image URL.", "1-0": "people.csv", "1-1": "primary_image", "1-2": "Sizing parameters have been removed from the primary_image URL.", "2-0": "products.csv", "2-1": "all", "2-2": "Product data has been deprecated and CSV will be removed.", "3-0": "has_competitor.csv", "3-1": "all", "3-2": "Competitor data has been deprecated and CSV will be removed.", "4-0": "has_customer.csv", "4-1": "all", "4-2": "Customer data has been deprecated and CSV will be removed." }, "cols": 3, "rows": 4 } [/block]