Orb API Version 2 Documentation
<host> is api2.orb-intelligence.com
<port> is 80
<api_key> is your API key.
You must specify a version number of the API in the URL (see examples below). The current version is 2
Version 2 is not backwards compatible with 1.x. Version 2 has a slightly different output format: mainly some fields are missing in version 2. Here is a list of changes in the output format:
- id field is replaced with orb_num
- webdomain field is removed. Use webdomains instead.
- addresses field is removed.
- parent_orb_num field is added
- linkedin_accounts, facebook_accounts, twitter_accounts, googleplus_accounts, youtube_accounts are removed. Use linkedin_account, facebook_account, twitter_account, googleplus_account, youtube_account instead.
- technologies field does not contain category anymore, only name of the technology. Use technologies/categories call described below to map technologies onto categories.
Searches companies by one or many parameters.
|Parameter name||Possible values||Default Values|
|orb_num||Company’s Orb Number|
|entity_type||Type of the entity: company, branch. If not specified the result will contain entities of all types.|
|name_prefix||Company’s name prefix|
|webdomain||Company’s web domain (eg marklogic.com)|
|industry||Company’s industry. Use GET /dictionaries/industries to get a list of all industry names.|
|naics_codes||Semicolon-separated list of NAICS codes. Use GET /dictionaries/naics_codes to get a list of all NAICS codes and their descriptions. The search is performed through all NAICS codes, not only primary code. It is a prefix search: it matches a given code and more specific codes (for example, if you search for 42 the result will include companies with codes 42, 4238, 42399, etc)|
|sic_codes||Semicolon-separated list of SIC codes. Use GET /dictionaries/sic_codes to get a list of all SIC codes and their descriptions. The search is performed through all SIC codes, not only primary code. It is a prefix search: it matches a given code and more specific codes (for example, if you search for 07 the result will include companies with codes 07, 0752, 0783, etc)|
|employees||Semicolon-separated list of employee ranges: 1-10, 10-50, 50-200, 200-500, 500-1k, 1k-5k, 5k-10k, 10k (for >10k)|
|revenue||Semicolon-separated list of revenue ranges: 0-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, 1b (for >1b)|
|state||State name (eg CA)|
|zip||ZIP code (eg 94301). It is a prefix search by five first digits.
IMPORTANT: zip search works only for the United States (returns unpredictable results for other countries).
|country||Country name (eg United States)|
|parent_orb_num||Company’s Orb Number. The result will return all subsidiaries and branches of the company. Add entity_type to get subsidiaries or branches only.|
|rankings||Semicolon-separated list of company rankings. The result will contain companies that are included in any of the rankings.
Use GET /dictionaries/technologies/categories to get a list of all rankings.
|technologies||Semicolon-separated list of technology names. The result will contain companies that use any of the technologies. Use GET /dictionaries/technologies to get a list of all technology names.|
|tech_categories||Semicolon-separated list of names of technology categories.
The result will contain companies that use any of the technologies from the categories.
Use GET /dictionaries/technologies/categories to get a list of all technology categories.
|importance_score||Importance score: A, B, C|
|limit||Number of records to return. Maximum value: 100||10|
|offset||The start point for records to be returned. An offset value of 10 starts returning at the 11th record. Default value: 0. Maximum value:
http://api2.orb-intelligence.com/2/search/companies?api_key=<your api key>&webdomain=marklogic.com
Returns a list of all industries.
http://api2.orb-intelligence.com/2/dictionaries/industries?api_key=<your api key>
Returns a list of all NAICS codes and their description. The codes are based on the “NAICS 2012” standard, which is the latest version of the standard. For more information on NAICS 2012 and mappings to the previous versions see US Census NAICS page (mappings).
http://api2.orb-intelligence.com/2/dictionaries/naics_codes?api_key=<your api key>
Returns a list of all SIC codes and their description.
http://api2.orb-intelligence.com/2/dictionaries/sic_codes?api_key=<your api key>
Returns a list of all technologies.
http://api2.orb-intelligence.com/2/dictionaries/technologies?api_key=<your api key>
Returns a list of all technology categories and related technologies.
http://api2.orb-intelligence.com/2/dictionaries/technologies/categories?api_key=<your api key>
Returns a list of all company rankings.
http://api2.orb-intelligence.com/2/dictionaries/rankings?api_key=<your api key>