README.md in crunchbase4-0.1.3 vs README.md in crunchbase4-0.1.4
- old
+ new
@@ -1,11 +1,11 @@
# Crunchbase
Crunchbase is a ruby wrapper based on Crunchbase V4 API. it provides easy to get the API data by each endpoint. [CB v4 DOC](https://app.swaggerhub.com/apis/Crunchbase/crunchbase-enterprise_api/1.0.1)
[](https://badge.fury.io/rb/crunchbase4)
-[](https://travis-ci.org/encoreshao/crunchbase4)
+[](https://travis-ci.org/ekohe/crunchbase4)
## Installation
Add this line to your application's Gemfile:
@@ -28,10 +28,11 @@
```ruby
require 'crunchbase4'
CB_CONFIG = YAML.load(File.read('crunchbase.yml'))
Crunchbase.config.user_key = CB_CONFIG['user_key']
+Crunchbase.config.user_key = false # If you want to know the request information, can set the debug = true
```
## Usage
#### Class: `Client` for API
@@ -41,13 +42,17 @@
```
#### API request for endpoint we completed
- [Entity](https://github.com/ekohe/crunchbase4#entity)
- - organizations
- - people
- - funding_rounds
+ - Organization
+ - fields
+ - cards: [raised_investments, participated_funds, child_organizations, participated_investments, investors, parent_organization, raised_funding_rounds, ipos, event_appearances, raised_funds, acquiree_acquisitions, acquirer_acquisitions, parent_ownership, jobs, founders, child_ownerships, participated_funding_rounds, press_references, headquarters_address]
+ - Person
+ - fields
+ - FundingRound
+ - fields
- [Searches](https://github.com/ekohe/crunchbase4#search)
- [Autocompletes](https://github.com/ekohe/crunchbase4#autocompletes)
- [Deleted Entities](https://github.com/ekohe/crunchbase4#deleted-entities)
```ruby
@@ -57,11 +62,17 @@
response = client.person('mark-zuckerberg')
response = client.person('mark-zuckerberg', 'participated_investments')
response = client.funding_round('371c20af8aa94bcba8da0694d138f247')
response = client.funding_round('371c20af8aa94bcba8da0694d138f247', 'investments')
response = client.acquisition('7638eae9-07b7-4fc6-ad20-5d99de3ff928')
+response = client.fund('aeaac12b-df56-7039-40f9-f1992f88e20e')
+response = client.ownership('4506d9ce-85d3-4a8f-89cd-07a225359d55')
+<!-- Get the JSON response of Entity -->
+
+response.as_json
+
<!-- Search -->
client.search_organizations(query_data)
client.search_people(query_data)
client.search_funding_rounds(query_data)
client.recent_updates({
@@ -153,11 +164,10 @@
```
##### Get the funding round data
```ruby
-=> #<Crunchbase::Client:0x00007f8806824c28>
pry(main)> response = client.funding_round('371c20af-8aa9-4bcb-a8da-0694d138f247')
=> #<Crunchbase::Models::FundingRound:0x00007f8806b55ca8
@announced_on="2013-06-30",
@closed_on=nil,
@created_at="2020-04-02T12:17:59Z",
@@ -173,11 +183,35 @@
pry(main)> response.name
=> "Secondary Market - Facebook"
pry(main)> response.uuid
=> "371c20af-8aa9-4bcb-a8da-0694d138f247"
```
+##### Get the fund data
+```ruby
+pry(main)> response = client.fund('aeaac12b-df56-7039-40f9-f1992f88e20e')
+=> #<Crunchbase::Models::Fund:0x00007ffa6a5a4080
+ @announced_on="2017-04-03",
+ @created_at="2017-04-04T04:40:49Z",
+ @entity_def_id="fund",
+ @image_id="v1491280776/azwvvy68ap2o29ffcnn7.png",
+ @investor_identifiers=["Betaworks", "Craig Newmark Philanthropies", "Democracy Fund", "Facebook", "Ford Foundation", "Knight Foundation", "Mozilla", "Tow Foundation"],
+ @money_raised=14000000,
+ @name="The News Integrity Initiative Fund I",
+ @num_investors=8,
+ @owner_identifier="The News Integrity Initiative",
+ @permalink="the-news-integrity-initiative-raised-the-news-integrity-initiative-fund-i--aeaac12b",
+ @short_description="The News Integrity Initiative raises new The News Integrity Initiative Fund I on 2017-04-03",
+ @started_on=nil,
+ @updated_at="2018-02-12T22:18:54Z",
+ @uuid="aeaac12b-df56-7039-40f9-f1992f88e20e">
+pry(main)> response.name
+=> "The News Integrity Initiative Fund I"
+pry(main)> response.uuid
+=> "aeaac12b-df56-7039-40f9-f1992f88e20e"
+```
+
##### Get the acquisition data
```ruby
pry(main)> response = client.acquisition('7638eae9-07b7-4fc6-ad20-5d99de3ff928')
=> #<Crunchbase::Models::Acquisition:0x00007fa01134da60
@@ -232,9 +266,30 @@
@organization_identifier="Facebook",
@partner_identifiers=nil,
@permalink="jean-brice-abrial-invested-in-facebook-secondary-market--371c20af--1368da0c",
@updated_at="2020-04-02T12:17:59Z",
@uuid="1368da0c-07b0-46ef-9a86-b518367e60d6">
+```
+
+##### Get the ownership data
+
+```ruby
+pry(main)> response = client.ownership('4506d9ce-85d3-4a8f-89cd-07a225359d55')
+=> #<Crunchbase::Models::Ownership:0x00007fbf2fdb78b0
+ @created_at="2015-03-04T20:04:23Z",
+ @entity_def_id="ownership",
+ @identifier=["4506d9ce-85d3-4a8f-89cd-07a225359d55", "Facebook owns Instagram", "facebook-owns-instagram--4506d9ce"],
+ @name="Facebook owns Instagram",
+ @ownee_identifier="Instagram",
+ @owner_identifier="Facebook",
+ @ownership_type="subsidiary",
+ @permalink="facebook-owns-instagram--4506d9ce",
+ @updated_at="2018-02-13T01:18:10Z",
+ @uuid="4506d9ce-85d3-4a8f-89cd-07a225359d55">
+pry(main)> response.name
+=> "Facebook owns Instagram"
+pry(main)> response.uuid
+=> "4506d9ce-85d3-4a8f-89cd-07a225359d55"
```
### Search
* Search query parameters for each endpoint