Overview
Compile’s RESTful API gives you access to Compile’s deep intelligence on businesses in the US. To use this API, you must have a key. Please reach us at [email protected] for the access key if you are interested in exploring the data.
Endpoints
- LIST: Generate a list of organizations based on filter parameters. Returns basic firmographic data. (eg
/organization/?hq_state=US.CAwill return organizations with an HQ in California) - DETAIL: Returns the full profile of an organization, including advanced firmographics, company trends, IT profile and alerts (eg., the
/organization/<pk>/endpoint will fetch you the full profile for a particular Organization)
Request fields
- ORDERING: Order results by a particular parameter (eg.,
?order=employee_count) - SEARCH: Fuzzy search for a particular Organization (eg.,
?query=walmart) - FILTER: Filter the results by various parameters (eg.,
?hq_state=US.CA)
Pagination
We provide 10 results per API call. Use the page param to fetch more. https://v2.compileapi.com/organization/?hq_state=US.CA&page=2 will fetch you results 11-20 of Organizations in California
Examples
- Get all organizations in California with an employee size of 100K+
https://v2.compileapi.com/organization/?hq_state=US.CA&employee_range=100K+ - Sort this list by revenue in decreasing order
https://v2.compileapi.com/organization/?hq_state=US.CA&employee_range=100K+&order=-revenue_count - Search for Walmart
https://v2.compileapi.com/organization/?query=walmart - Get all SEC filings for Walmart (id 344677)
https://v2.compileapi.com/secfiling/?organization=344677
Authentication
To authorize, use this code:
curl -X GET -H "apikey: compileapikey"\
"https://v2.compileapi.com/<endpoint>/"
import requests
url = "https://v2.compileapi.com/<endpoint>/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/<endpoint>/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/<endpoint>");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
Make sure to replace
compileapikeywith your API key.
For clients to authenticate, the token key should be included in an apikey HTTP header or as part of the url query string. For example:
apikey: compileapikey
or
https://v2.compileapi.com/<endpoint>/?apikey=compileapikey
Organization
Listing
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/organization/"
import requests
url = "https://v2.compileapi.com/organization/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/organization/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/organization/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":1,
"previous":null,
"results":[
{
"hq_country":"United States",
"hq_location":"New York City",
"revenue_range":"10B+",
"student_count":null,
"name":"Verizon Communications Inc",
"revenue_count":131620000000,
"primary_industry":"Telecommunications",
"hq_postal_code":"10036",
"median_income_count":null,
"employee_range":"100K+",
"tuition_count":null,
"hq_state":"New York",
"population_count":null,
"budget_count":null,
"website_domain":"http://verizon.com",
"financial":131620000000,
"employee_count":177700,
"teacher_count":null,
"id":341539,
"size":177700
}
],
"next":null
}
This endpoint returns a set of organizations based on your query parameters. You can filter companies based on firmographic criteria (e.g. location, employee range, state etc.) or particular types of events (companies that have raised funds, companies that have won a federal contract etc.).
The results include basic profiling data on the organizations that match the criteria. Note that all the return fields will not be applicable to every organization. For instance, if an organization is of sector “commercial”, the values under tuition_count and population_count will be empty. These will only be included for educational institutions and local government bodies respectively. The “id” attached to an organization will be used for more detailed queries.
HTTP Request
GET /organization/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
SEARCH | website | ||
FILTER | name | String | |
FILTER | employee_range | String (Choice) | Choices |
FILTER | revenue_range | String (Choice) | Choices |
FILTER | primary_industry | String (Choice) | Choices |
FILTER | sector | String (Choice) | Choices |
FILTER | has_officeexpansion | String | |
FILTER | has_vulnerability | String | |
FILTER | has_violation | String | |
FILTER | has_employmentchange | String | |
FILTER | has_securitybreach | String | |
FILTER | has_mna | String | |
FILTER | has_executivechange | String | |
FILTER | has_funding | String | |
FILTER | has_federalcontract | String | |
FILTER | has_federalgrant | String | |
FILTER | hq_state | String (Choice) | Choices |
order choices
| ASC | DESC |
|---|---|
| employee_count | -employee_count |
| revenue_count | -revenue_count |
| student_count | -student_count |
| tuition_count | -tuition_count |
| budget_count | -budget_count |
| median_income_count | -median_income_count |
Filter choices
employee_range
| Verbose | Value |
|---|---|
| 0-25 | 0-25 |
| 26-100 | 26-100 |
| 101-250 | 101-250 |
| 251-1K | 251-1K |
| 1001-10K | 1001-10K |
| 10001-50K | 10001-50K |
| 50001-100K | 50001-100K |
| 100K+ | 100K+ |
revenue_range
| Verbose | Value |
|---|---|
| <0 | <0 |
| 0-1M | 0-1M |
| 1M-10M | 1M-10M |
| 10M-50M | 10M-50M |
| 50M-100M | 50M-100M |
| 100M-250M | 100M-250M |
| 250M-500M | 250M-500M |
| 500M-1B | 500M-1B |
| 1B-5B | 1B-5B |
| 5B-10B | 5B-10B |
| 10B+ | 10B+ |
primary_industry
| Verbose | Value |
|---|---|
| Agriculture & Mining | Agriculture & Mining |
| Business Services | Business Services |
| Computers & Electronics | Computers & Electronics |
| Consumer Services | Consumer Services |
| Education | Education |
| Energy & Utilities | Energy & Utilities |
| Financial Services | Financial Services |
| Government | Government |
| Healthcare, Pharmaceuticals, & Biotech | Healthcare, Pharmaceuticals, & Biotech |
| Manufacturing | Manufacturing |
| Media & Entertainment | Media & Entertainment |
| Non-Profit | Non-Profit |
| Other | Other |
| Real Estate & Construction | Real Estate & Construction |
| Retail | Retail |
| Software & Internet | Software & Internet |
| Telecommunications | Telecommunications |
| Transportation & Storage | Transportation & Storage |
| Travel, Recreation, and Leisure | Travel, Recreation, and Leisure |
| Wholesale & Distribution | Wholesale & Distribution |
sector
| Verbose | Value |
|---|---|
| Commercial | commercial |
| Bank | bank |
| Education | education |
| Government | government |
hq_state
| Verbose | Value |
|---|---|
| United States - Alabama | US.AL |
| United States - Alaska | US.AK |
| United States - Arizona | US.AZ |
| United States - Arkansas | US.AR |
| United States - California | US.CA |
| United States - Colorado | US.CO |
| United States - Connecticut | US.CT |
| United States - Delaware | US.DE |
| United States - Florida | US.FL |
| United States - Georgia | US.GA |
| United States - Hawaii | US.HI |
| United States - Idaho | US.ID |
| United States - Illinois | US.IL |
| United States - Indiana | US.IN |
| United States - Iowa | US.IA |
| United States - Kansas | US.KS |
| United States - Kentucky | US.KY |
| United States - Louisiana | US.LA |
| United States - Maine | US.ME |
| United States - Maryland | US.MD |
| United States - Massachusetts | US.MA |
| United States - Michigan | US.MI |
| United States - Minnesota | US.MN |
| United States - Mississippi | US.MS |
| United States - Missouri | US.MO |
| United States - Montana | US.MT |
| United States - Nebraska | US.NE |
| United States - Nevada | US.NV |
| United States - New Hampshire | US.NH |
| United States - New Jersey | US.NJ |
| United States - New Mexico | US.NM |
| United States - New York | US.NY |
| United States - North Carolina | US.NC |
| United States - North Dakota | US.ND |
| United States - Ohio | US.OH |
| United States - Oklahoma | US.OK |
| United States - Oregon | US.OR |
| United States - Pennsylvania | US.PA |
| United States - Rhode Island | US.RI |
| United States - South Carolina | US.SC |
| United States - South Dakota | US.SD |
| United States - Tennessee | US.TN |
| United States - Texas | US.TX |
| United States - Utah | US.UT |
| United States - Vermont | US.VT |
| United States - Virginia | US.VA |
| United States - Washington | US.WA |
| United States - Washington, D.C. | US.DC |
| United States - West Virginia | US.WV |
| United States - Wisconsin | US.WI |
| United States - Wyoming | US.WY |
Details
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/organization/<pk>/"
import requests
url = "https://v2.compileapi.com/organization/<pk>/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/organization/<pk>/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/organization/<pk>/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"id": 341539,
"name": "Verizon Communications Inc",
"website_domain": "http://verizon.com",
"primary_industry": "Telecommunications",
"naics_codes": [
"517"
],
"size": 177300,
"financial": 131620000000,
"it_budget": "3298471500",
"stock_symbols": [
"NYSE:VZ",
"XNYS:VZ",
"NYSE:VZA",
"XNYS:VZA"
],
"address": "1095 Avenue of the Americas, New York City, New York, 10036, United States",
"hq_location": "New York City",
"hq_state": "New York",
"hq_postal_code": "10036",
"hq_country": "United States",
"phone_numbers": [
{
"phone": "+1 212-321-8136",
"type": "ph"
},
{
"phone": "+1 212-395-1000",
"type": "ph"
},
{
"phone": "+1 212395100 ext. 0",
"type": "ph"
},
{
"phone": "+1 908-559-3620",
"type": "ph"
}
],
"wikipedia_url": "https://en.wikipedia.org/wiki/Verizon_Communications",
"facebook_url": "http://www.facebook.com/verizon",
"twitter_url": "http://twitter.com/Verizonnews",
"linkedin_url": "https://www.linkedin.com/company/verizon",
"affiliates": [
{
"website_domain": "http://networkfleet.com",
"type": "subsidiary",
"id": 397052,
"name": "Networkfleet, Inc."
},
{
"website_domain": "http://nctechsales.com",
"type": "subsidiary",
"id": 1057047,
"name": "North Coast Technical Sales, Inc."
},
{
"website_domain": "http://mci.com",
"type": "subsidiary",
"id": 698280,
"name": "MCI, INC."
},
{
"website_domain": "http://msimgmt.com",
"type": "subsidiary",
"id": 1062865,
"name": "Msi Management Services, Inc."
},
{
"website_domain": "http://armcorp.com",
"type": "subsidiary",
"id": 1006536,
"name": "American Resurgens Management Corp."
},
{
"website_domain": "http://bennetttelecom.net",
"type": "subsidiary",
"id": 1054120,
"name": "Bennett Telecom Inc"
},
{
"website_domain": "http://servicelamp.com",
"type": "subsidiary",
"id": 924149,
"name": "Service Lamp Corporation"
},
{
"website_domain": "http://aol.com",
"type": "acquisition",
"id": 342250,
"name": "Aol"
},
{
"website_domain": "http://www.fleetmatics.com",
"type": "acquisition",
"id": 594307,
"name": "FleetMatics Group PLC"
},
{
"website_domain": null,
"type": "subsidiary",
"id": null,
"name": "CyberTrust"
},
{
"website_domain": "http://icsalabs.com",
"type": "subsidiary",
"id": null,
"name": "International Computer Security Association"
}
],
"peers": [
{
"website_domain": "http://att.com",
"id": 338628,
"name": "At&T Inc"
},
{
"website_domain": "http://www.ups.com",
"id": 340262,
"name": "Ups"
},
{
"website_domain": "http://centurylink.com",
"id": 340420,
"name": "CenturyLink Inc"
},
{
"website_domain": "http://www.virginmobileusa.com/",
"id": 341306,
"name": "Virgin Mobile USA, L.P."
},
{
"website_domain": "http://t-mobile.com",
"id": 344264,
"name": "T-Mobile US, Inc."
},
{
"website_domain": "http://cspire.com",
"id": 347554,
"name": "Cellular South, Inc."
},
{
"website_domain": "http://www.sprint.com",
"id": 347958,
"name": "Sprint Nextel"
},
{
"website_domain": "http://tracfone.com",
"id": 361305,
"name": "TracFone Wireless, Inc."
},
{
"website_domain": "http://mci.com",
"id": 698280,
"name": "MCI, INC."
}
],
"identifiers": [
{
"identifier": "232259884",
"type": "ein"
},
{
"identifier": "950510200",
"type": "ein"
},
{
"identifier": "223372889",
"type": "ein"
},
{
"identifier": "0000732712",
"type": "cik"
},
{
"identifier": "0001175215",
"type": "cik"
},
{
"identifier": "590397520",
"type": "ein"
}
]
}
This endpoint returns a set of organizations based on your query parameters. You can filter companies based on firmographic criteria (e.g. location, employee range, state etc.) or particular types of events (companies that have raised funds, companies that have won a federal contract etc.).
The results include basic profiling data on the organizations that match the criteria. Note that all the return fields will not be applicable to every organization. For instance, if an organization is of sector “commercial”, the values under tuition_count and population_count will be empty. These will only be included for educational institutions and local government bodies respectively. The “id” attached to an organization will be used for more detailed queries.
HTTP Request
GET /organization/<pk>/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
SEARCH | website | ||
FILTER | name | String | |
FILTER | employee_range | String (Choice) | Choices |
FILTER | revenue_range | String (Choice) | Choices |
FILTER | primary_industry | String (Choice) | Choices |
FILTER | sector | String (Choice) | Choices |
FILTER | has_officeexpansion | String | |
FILTER | has_vulnerability | String | |
FILTER | has_violation | String | |
FILTER | has_employmentchange | String | |
FILTER | has_securitybreach | String | |
FILTER | has_mna | String | |
FILTER | has_executivechange | String | |
FILTER | has_funding | String | |
FILTER | has_federalcontract | String | |
FILTER | has_federalgrant | String | |
FILTER | hq_state | String (Choice) | Choices |
order choices
| ASC | DESC |
|---|---|
| employee_count | -employee_count |
| revenue_count | -revenue_count |
| student_count | -student_count |
| tuition_count | -tuition_count |
| budget_count | -budget_count |
| median_income_count | -median_income_count |
Trends
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/organization/<pk>/trends/"
import requests
url = "https://v2.compileapi.com/organization/<pk>/trends/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/organization/<pk>/trends/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/organization/<pk>/trends/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"web_popularity_index": [
{
"period": "2015 Q4",
"value": 38
},
{
"period": "2015 Q3",
"value": 46
},
{
"period": "2015 Q2",
"value": 43
},
{
"period": "2015 Q1",
"value": 43
},
{
"period": "2014 Q4",
"value": 41
},
{
"period": "2014 Q3",
"value": 48
},
{
"period": "2014 Q2",
"value": 45
},
{
"period": "2014 Q1",
"value": 45
},
{
"period": "2013 Q4",
"value": 41
},
{
"period": "2013 Q3",
"value": 58
},
{
"period": "2013 Q2",
"value": 54
},
{
"period": "2013 Q1",
"value": 39
},
{
"period": "2012 Q4",
"value": 34
},
{
"period": "2012 Q3",
"value": 42
},
{
"period": "2012 Q2",
"value": 37
}
],
"job_posts": [
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 29
},
{
"department": "Architecture, Engineering and Research",
"value": 30
},
{
"department": "Computer and Information Technology",
"value": 19
},
{
"department": "Education, Training, and Library",
"value": 19
},
{
"department": "Finance and Business Operations",
"value": 155
},
{
"department": "Food, Hotel and Travel Service",
"value": 8
},
{
"department": "Healthcare Practitioners and Technical",
"value": 6
},
{
"department": "Human Resources",
"value": 18
},
{
"department": "Healthcare Support",
"value": 17
},
{
"department": "Installation, Maintenance, and Repair",
"value": 25
},
{
"department": "Management",
"value": 15
},
{
"department": "Office, Administrative, and Customer Support",
"value": 29
},
{
"department": "Production",
"value": 73
},
{
"department": "Protective Service",
"value": 9
},
{
"department": "Sales and Marketing",
"value": 262
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 27
},
{
"department": null,
"value": 826
}
],
"period": "2017 Q1",
"value": 1567
},
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 30
},
{
"department": "Architecture, Engineering and Research",
"value": 30
},
{
"department": "Construction, Building, Grounds Cleaning and Maintenance",
"value": 1
},
{
"department": "Computer and Information Technology",
"value": 15
},
{
"department": "Community, Social Services, and Nonprofit",
"value": 1
},
{
"department": "Education, Training, and Library",
"value": 18
},
{
"department": "Finance and Business Operations",
"value": 116
},
{
"department": "Farming, Fishing, and Forestry",
"value": 1
},
{
"department": "Food, Hotel and Travel Service",
"value": 7
},
{
"department": "Healthcare Practitioners and Technical",
"value": 4
},
{
"department": "Human Resources",
"value": 12
},
{
"department": "Healthcare Support",
"value": 17
},
{
"department": "Installation, Maintenance, and Repair",
"value": 38
},
{
"department": "Management",
"value": 24
},
{
"department": "Office, Administrative, and Customer Support",
"value": 22
},
{
"department": "Personal Care and Consumer Service",
"value": 3
},
{
"department": "Production",
"value": 53
},
{
"department": "Protective Service",
"value": 9
},
{
"department": "Sales and Marketing",
"value": 172
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 33
},
{
"department": null,
"value": 955
}
],
"period": "2016 Q4",
"value": 1561
},
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 30
},
{
"department": "Architecture, Engineering and Research",
"value": 147
},
{
"department": "Computer and Information Technology",
"value": 228
},
{
"department": "Education, Training, and Library",
"value": 21
},
{
"department": "Finance and Business Operations",
"value": 118
},
{
"department": "Farming, Fishing, and Forestry",
"value": 1
},
{
"department": "Food, Hotel and Travel Service",
"value": 12
},
{
"department": "Healthcare Practitioners and Technical",
"value": 6
},
{
"department": "Human Resources",
"value": 14
},
{
"department": "Healthcare Support",
"value": 6
},
{
"department": "Installation, Maintenance, and Repair",
"value": 14
},
{
"department": "Management",
"value": 6
},
{
"department": "Office, Administrative, and Customer Support",
"value": 25
},
{
"department": "Personal Care and Consumer Service",
"value": 3
},
{
"department": "Production",
"value": 28
},
{
"department": "Protective Service",
"value": 14
},
{
"department": "Sales and Marketing",
"value": 127
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 19
},
{
"department": null,
"value": 376
}
],
"period": "2016 Q3",
"value": 1195
},
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 36
},
{
"department": "Architecture, Engineering and Research",
"value": 332
},
{
"department": "Construction, Building, Grounds Cleaning and Maintenance",
"value": 1
},
{
"department": "Computer and Information Technology",
"value": 767
},
{
"department": "Education, Training, and Library",
"value": 15
},
{
"department": "Finance and Business Operations",
"value": 140
},
{
"department": "Food, Hotel and Travel Service",
"value": 3
},
{
"department": "Healthcare Practitioners and Technical",
"value": 7
},
{
"department": "Human Resources",
"value": 5
},
{
"department": "Healthcare Support",
"value": 10
},
{
"department": "Installation, Maintenance, and Repair",
"value": 12
},
{
"department": "Legal",
"value": 2
},
{
"department": "Life, Physical, and Social Science",
"value": 9
},
{
"department": "Management",
"value": 31
},
{
"department": "Office, Administrative, and Customer Support",
"value": 24
},
{
"department": "Personal Care and Consumer Service",
"value": 3
},
{
"department": "Production",
"value": 29
},
{
"department": "Protective Service",
"value": 9
},
{
"department": "Sales and Marketing",
"value": 147
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 30
},
{
"department": null,
"value": 224
}
],
"period": "2016 Q2",
"value": 1836
},
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 46
},
{
"department": "Architecture, Engineering and Research",
"value": 370
},
{
"department": "Computer and Information Technology",
"value": 825
},
{
"department": "Education, Training, and Library",
"value": 14
},
{
"department": "Finance and Business Operations",
"value": 163
},
{
"department": "Food, Hotel and Travel Service",
"value": 18
},
{
"department": "Healthcare Practitioners and Technical",
"value": 5
},
{
"department": "Human Resources",
"value": 7
},
{
"department": "Healthcare Support",
"value": 2
},
{
"department": "Installation, Maintenance, and Repair",
"value": 6
},
{
"department": "Legal",
"value": 5
},
{
"department": "Life, Physical, and Social Science",
"value": 17
},
{
"department": "Management",
"value": 9
},
{
"department": "Office, Administrative, and Customer Support",
"value": 52
},
{
"department": "Personal Care and Consumer Service",
"value": 2
},
{
"department": "Production",
"value": 23
},
{
"department": "Protective Service",
"value": 2
},
{
"department": "Sales and Marketing",
"value": 178
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 15
},
{
"department": null,
"value": 143
}
],
"period": "2016 Q1",
"value": 1902
},
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 74
},
{
"department": "Architecture, Engineering and Research",
"value": 402
},
{
"department": "Construction, Building, Grounds Cleaning and Maintenance",
"value": 3
},
{
"department": "Computer and Information Technology",
"value": 1156
},
{
"department": "Education, Training, and Library",
"value": 78
},
{
"department": "Finance and Business Operations",
"value": 161
},
{
"department": "Farming, Fishing, and Forestry",
"value": 1
},
{
"department": "Food, Hotel and Travel Service",
"value": 12
},
{
"department": "Healthcare Practitioners and Technical",
"value": 7
},
{
"department": "Human Resources",
"value": 16
},
{
"department": "Healthcare Support",
"value": 11
},
{
"department": "Installation, Maintenance, and Repair",
"value": 39
},
{
"department": "Legal",
"value": 11
},
{
"department": "Life, Physical, and Social Science",
"value": 24
},
{
"department": "Management",
"value": 14
},
{
"department": "Office, Administrative, and Customer Support",
"value": 52
},
{
"department": "Personal Care and Consumer Service",
"value": 1
},
{
"department": "Production",
"value": 51
},
{
"department": "Protective Service",
"value": 22
},
{
"department": "Sales and Marketing",
"value": 253
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 17
},
{
"department": null,
"value": 350
}
],
"period": "2015 Q4",
"value": 2755
},
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 50
},
{
"department": "Architecture, Engineering and Research",
"value": 299
},
{
"department": "Construction, Building, Grounds Cleaning and Maintenance",
"value": 3
},
{
"department": "Computer and Information Technology",
"value": 939
},
{
"department": "Education, Training, and Library",
"value": 48
},
{
"department": "Finance and Business Operations",
"value": 278
},
{
"department": "Food, Hotel and Travel Service",
"value": 13
},
{
"department": "Healthcare Practitioners and Technical",
"value": 13
},
{
"department": "Human Resources",
"value": 45
},
{
"department": "Healthcare Support",
"value": 8
},
{
"department": "Installation, Maintenance, and Repair",
"value": 20
},
{
"department": "Legal",
"value": 10
},
{
"department": "Life, Physical, and Social Science",
"value": 22
},
{
"department": "Management",
"value": 22
},
{
"department": "Office, Administrative, and Customer Support",
"value": 48
},
{
"department": "Personal Care and Consumer Service",
"value": 2
},
{
"department": "Production",
"value": 68
},
{
"department": "Protective Service",
"value": 10
},
{
"department": "Sales and Marketing",
"value": 223
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 17
},
{
"department": null,
"value": 232
}
],
"period": "2015 Q3",
"value": 2370
},
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 47
},
{
"department": "Architecture, Engineering and Research",
"value": 430
},
{
"department": "Construction, Building, Grounds Cleaning and Maintenance",
"value": 7
},
{
"department": "Computer and Information Technology",
"value": 1375
},
{
"department": "Education, Training, and Library",
"value": 63
},
{
"department": "Finance and Business Operations",
"value": 308
},
{
"department": "Food, Hotel and Travel Service",
"value": 18
},
{
"department": "Healthcare Practitioners and Technical",
"value": 13
},
{
"department": "Human Resources",
"value": 70
},
{
"department": "Healthcare Support",
"value": 12
},
{
"department": "Installation, Maintenance, and Repair",
"value": 19
},
{
"department": "Legal",
"value": 6
},
{
"department": "Life, Physical, and Social Science",
"value": 25
},
{
"department": "Management",
"value": 148
},
{
"department": "Office, Administrative, and Customer Support",
"value": 63
},
{
"department": "Personal Care and Consumer Service",
"value": 1
},
{
"department": "Production",
"value": 76
},
{
"department": "Protective Service",
"value": 16
},
{
"department": "Sales and Marketing",
"value": 424
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 18
},
{
"department": null,
"value": 455
}
],
"period": "2015 Q2",
"value": 3594
},
{
"department_wise": [
{
"department": "Arts, Design, Entertainment, Sports, and Media",
"value": 50
},
{
"department": "Architecture, Engineering and Research",
"value": 567
},
{
"department": "Construction, Building, Grounds Cleaning and Maintenance",
"value": 7
},
{
"department": "Computer and Information Technology",
"value": 1414
},
{
"department": "Education, Training, and Library",
"value": 163
},
{
"department": "Finance and Business Operations",
"value": 266
},
{
"department": "Food, Hotel and Travel Service",
"value": 22
},
{
"department": "Healthcare Practitioners and Technical",
"value": 10
},
{
"department": "Human Resources",
"value": 67
},
{
"department": "Healthcare Support",
"value": 9
},
{
"department": "Installation, Maintenance, and Repair",
"value": 12
},
{
"department": "Legal",
"value": 13
},
{
"department": "Life, Physical, and Social Science",
"value": 28
},
{
"department": "Management",
"value": 192
},
{
"department": "Office, Administrative, and Customer Support",
"value": 24
},
{
"department": "Production",
"value": 42
},
{
"department": "Protective Service",
"value": 18
},
{
"department": "Sales and Marketing",
"value": 989
},
{
"department": "Transportation, Material Moving and Warehousing",
"value": 189
},
{
"department": null,
"value": 1479
}
],
"period": "2015 Q1",
"value": 5561
}
],
"employee_count_index": [
{
"period": "2016",
"value": 79512
},
{
"period": "2015",
"value": 67368
},
{
"period": "2014",
"value": 56759
},
{
"period": "2013",
"value": 53713
}
],
"patent": [
{
"period": "2016 Q4",
"value": 87
},
{
"period": "2016 Q3",
"value": 326
},
{
"period": "2016 Q2",
"value": 345
},
{
"period": "2016 Q1",
"value": 376
},
{
"period": "2015 Q4",
"value": 274
},
{
"period": "2015 Q3",
"value": 880
},
{
"period": "2015 Q2",
"value": 595
},
{
"period": "2015 Q1",
"value": 434
},
{
"period": "2014 Q4",
"value": 298
},
{
"period": "2014 Q3",
"value": 937
},
{
"period": "2014 Q2",
"value": 693
},
{
"period": "2014 Q1",
"value": 554
},
{
"period": "2013 Q4",
"value": 434
},
{
"period": "2013 Q3",
"value": 470
},
{
"period": "2013 Q2",
"value": 527
},
{
"period": "2013 Q1",
"value": 597
}
],
"trademark": [
{
"period": "2016 Q3",
"value": 4
},
{
"period": "2016 Q2",
"value": 1
},
{
"period": "2016 Q1",
"value": 4
},
{
"period": "2015 Q4",
"value": 6
},
{
"period": "2015 Q3",
"value": 16
},
{
"period": "2015 Q2",
"value": 3
},
{
"period": "2015 Q1",
"value": 25
},
{
"period": "2014 Q4",
"value": 9
},
{
"period": "2014 Q3",
"value": 9
},
{
"period": "2014 Q2",
"value": 1
},
{
"period": "2014 Q1",
"value": 17
},
{
"period": "2013 Q4",
"value": 15
},
{
"period": "2013 Q3",
"value": 12
},
{
"period": "2013 Q2",
"value": 21
},
{
"period": "2013 Q1",
"value": 8
}
],
"perm": [
{
"period": "2016 Q2",
"value": 1
},
{
"period": "2016 Q1",
"value": 177
},
{
"period": "2015 Q4",
"value": 175
},
{
"period": "2015 Q3",
"value": 176
},
{
"period": "2015 Q2",
"value": 188
},
{
"period": "2015 Q1",
"value": 170
},
{
"period": "2014 Q4",
"value": 120
},
{
"period": "2014 Q3",
"value": 126
},
{
"period": "2014 Q2",
"value": 73
},
{
"period": "2014 Q1",
"value": 6
},
{
"period": "2013 Q4",
"value": 4
},
{
"period": "2013 Q3",
"value": 12
},
{
"period": "2013 Q2",
"value": 8
}
],
"visaapplication": [
{
"period": "2016 Q4",
"value": 229
},
{
"period": "2016 Q3",
"value": 25
},
{
"period": "2016 Q2",
"value": 377
},
{
"period": "2016 Q1",
"value": 478
},
{
"period": "2015 Q4",
"value": 813
},
{
"period": "2015 Q3",
"value": 382
},
{
"period": "2015 Q2",
"value": 533
},
{
"period": "2015 Q1",
"value": 404
},
{
"period": "2014 Q4",
"value": 234
},
{
"period": "2014 Q3",
"value": 340
},
{
"period": "2014 Q2",
"value": 387
},
{
"period": "2014 Q1",
"value": 529
},
{
"period": "2013 Q4",
"value": 215
},
{
"period": "2013 Q3",
"value": 331
},
{
"period": "2013 Q2",
"value": 337
},
{
"period": "2013 Q1",
"value": 323
}
]
}
This endpoint gives trends about the organization which involve job postings, visa applications patent applications etc.
HTTP Request
GET /organization/<pk>/trends/
Technology installs
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/installs/"
import requests
url = "https://v2.compileapi.com/installs/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/installs/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/installs/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count": 1278,
"next": "https://v2.compileapi.com/installs/?organization=341539&page=2",
"previous": null,
"results": [
{
"vendor_organization": {
"website_domain": "http://google.com",
"id": 344988,
"name": "Google Inc."
},
"subcategory_name": "Email",
"subcategory_id": "5",
"vendor_id": "462",
"category_name": "Productivity Tools",
"vendor_name": "Google",
"product_id": null,
"install_date": "2011-02-12",
"category_id": "3",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://www.acumatica.com",
"id": 650044,
"name": "Acumatica"
},
"subcategory_name": "Enterprise Resource Planning (ERP)",
"subcategory_id": "28",
"vendor_id": "776",
"category_name": "Enterprise Operations",
"vendor_name": "Acumatica",
"product_id": null,
"install_date": "2011-12-16",
"category_id": "10",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://bomgar.com",
"id": 392324,
"name": "Bomgar"
},
"subcategory_name": "Remote Computer/Server Solutions",
"subcategory_id": "84",
"vendor_id": "1689",
"category_name": "Web Technologies",
"vendor_name": "Bomgar",
"product_id": null,
"install_date": "2010-12-31",
"category_id": "23",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://jquery.org",
"id": 1090222,
"name": "JS Foundation"
},
"subcategory_name": "Web & Portal Technology",
"subcategory_id": "88",
"vendor_id": "2192",
"category_name": "Web Technologies",
"vendor_name": "The jQuery Foundation",
"product_id": null,
"install_date": "2008-05-01",
"category_id": "23",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://yahoo.com",
"id": 347053,
"name": "Yahoo! Inc."
},
"subcategory_name": "Enterprise Content Management (ECM)",
"subcategory_id": "39",
"vendor_id": "2263",
"category_name": "Content Management",
"vendor_name": "Yahoo! Inc",
"product_id": null,
"install_date": "2009-10-01",
"category_id": "11",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://emc.com",
"id": 347014,
"name": "EMC Corp/Ma"
},
"subcategory_name": "Document Management",
"subcategory_id": "38",
"vendor_id": "23",
"category_name": "Content Management",
"vendor_name": "EMC Corporation",
"product_id": null,
"install_date": "2010-11-15",
"category_id": "11",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://netapp.com",
"id": 343411,
"name": "NetApp Inc"
},
"subcategory_name": "Cloud Infrastructure",
"subcategory_id": "1",
"vendor_id": "39",
"category_name": "Cloud Infrastructure",
"vendor_name": "NetApp",
"product_id": null,
"install_date": "2012-05-01",
"category_id": "1",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://symantec.com",
"id": 344863,
"name": "Symantec Corporation"
},
"subcategory_name": "Security Information and Event Management (SIEM)",
"subcategory_id": "21",
"vendor_id": "55",
"category_name": "IT Security",
"vendor_name": "Symantec",
"product_id": null,
"install_date": "2011-12-15",
"category_id": "4",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://vmware.com",
"id": 345595,
"name": "VMware Inc"
},
"subcategory_name": "Platform as a Service (PaaS)",
"subcategory_id": "3",
"vendor_id": "62",
"category_name": "Cloud Infrastructure",
"vendor_name": "VMware",
"product_id": null,
"install_date": "2014-03-06",
"category_id": "1",
"product_name": null
},
{
"vendor_organization": {
"website_domain": "http://apache.org",
"id": 379744,
"name": "The Apache Software Foundation"
},
"subcategory_name": "Search Engine Software",
"subcategory_id": "70",
"vendor_id": "221",
"category_name": "Software",
"vendor_name": "The Apache Software Foundation",
"product_id": null,
"install_date": "2012-02-10",
"category_id": "9",
"product_name": null
}
]
}
This endpoint gives detailed information on the technology products used in an organization.
This includes the vendor name, product and version (where available). The I.T. products tracked include both webfacing technology (inferred from a businesses website) as well as technologies that reside behind the firewall and aren’t easily discernible.
HTTP Request
GET /installs/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
SEARCH | query | ||
FILTER | organization | Integer |
SEC filings
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/secfiling/"
import requests
url = "https://v2.compileapi.com/secfiling/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/secfiling/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/secfiling/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":632,
"previous":null,
"results":[
{
"cik":732712,
"filing_url":"ftp://ftp.sec.gov/edgar/data/732712/0001193125-08-190292.txt",
"form":"8-K",
"adsh":"0001193125-08-190292",
"filed":"2008-09-04"
},
{
"cik":732712,
"filing_url":"ftp://ftp.sec.gov/edgar/data/732712/0001193125-08-160338.txt",
"form":"8-K",
"adsh":"0001193125-08-160338",
"filed":"2008-07-29"
},
{
"cik":732712,
"filing_url":"ftp://ftp.sec.gov/edgar/data/732712/0000000000-10-028012.txt",
"form":"UPLOAD",
"adsh":"0000000000-10-028012",
"filed":"2010-05-20"
}
],
"next":"https://v2.compileapi.com/secfiling/?organization=341539&page=2"
}
This endpoint returns the most recent SEC filings for an entity. It categorizes the major filings (e.g. annual reports, form D filings, 8-K etc) and includes the source to the filing.
HTTP Request
GET /secfiling/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
FILTER | form | String | |
FILTER | filed | String (Date YYYY-mm-dd) | |
FILTER | organization | Integer |
Security breaches
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/securitybreach/"
import requests
url = "https://v2.compileapi.com/securitybreach/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/securitybreach/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/securitybreach/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":2,
"previous":null,
"results":[
{
"event_type":"Data breach",
"date_of_breach":"2016-03-16",
"date_made_public":"2016-03-16",
"source_url":"http://www.breachlevelindex.com/#!breach-database",
"snippet":"Verizon Enterprise Solutions : Nuisance - 1,500,000 Records Breached, ",
"date_of_report":"2016-03-16"
},
{
"event_type":"Data breach",
"date_of_breach":null,
"date_made_public":null,
"source_url":"http://news.softpedia.com/news/recent-verizon-data-breach-was-preceded-by-another-screw-up-502516.shtml",
"snippet":"It appears that Verizon had problems securing MongoDB databases months before the most recent data breach that allowed hackers to steal at least 1.5 million customer records and then put them up for sale on the Dark Web.\r\n ",
"date_of_report":"2016-04-03"
}
],
"next":null
}
This endpoint returns the most recent security breaches that affected the organization.
HTTP Request
GET /securitybreach/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Executive changes
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/executivechange/"
import requests
url = "https://v2.compileapi.com/executivechange/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/executivechange/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/executivechange/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":19,
"previous":null,
"results":[
{
"previous_org_id":"341539",
"current_org_id":"637065",
"role_text":"Vice President of API Management Division",
"linkedin_url":"https://www.linkedin.com/in/jeffrey-nibler-5848574b",
"source_url":"http://www.prnewswire.com/news-releases/acclaim-consulting-group-forms-api-management-division-300226496.html",
"snippet":"Acclaim Consulting Group, Inc. welcomes Jeff Nibler as the new API Management Division Vice President.\r\n",
"name_of_execuitive":"Jeff Nibler ",
"department":"Computer and Information Technology",
"date_of_report":"2016-02-26"
},
{
"previous_org_id":"341539",
"current_org_id":"347958",
"role_text":"President of Northeast Area",
"linkedin_url":"https://www.linkedin.com/in/pat-devlin-63081217",
"source_url":"http://www.businesswire.com/news/home/20160401005573/en/Pat-Devlin-Joins-Sprint-President-Northeast-Area",
"snippet":"Former Verizon Wireless New York metro regional president Pat Devlin joins Sprint as president of the Northeast Area",
"name_of_execuitive":"Pat Devlin",
"department":"Management",
"date_of_report":"2016-04-01"
},
{
"previous_org_id":"341539",
"current_org_id":"341539",
"role_text":"Chief Financial Officer",
"linkedin_url":"",
"source_url":"http://blogs.wsj.com/cfo/2016/09/01/verizon-names-new-financial-chief-to-replace-retiring-shammo/?mod=WSJBlog",
"snippet":"Matthew Ellis, currently CFO for Verizon\u2019s wireless and wireline businesses, will become the company\u2019s new finance chief, effective Nov. 1, and Mr. Shammo will stay on until the end of the year to help the transition.",
"name_of_execuitive":"Matthew Ellis",
"department":"Finance and Business Operations",
"date_of_report":"2016-09-01"
}
],
"next":"https://v2.compileapi.com/executivechange/?organization=341539&page=2"
}
This endpoint returns the most recent executive changes in the company.
HTTP Request
GET /executivechange/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Office expansions
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/officeexpansion/"
import requests
url = "https://v2.compileapi.com/officeexpansion/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/officeexpansion/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/officeexpansion/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":2,
"previous":null,
"results":[
{
"state_name":"Pennsylvania",
"source_url":"http://www.costar.com/News/Article/Office-Lease-Up-Mar-30-MetLife-Leases-Another-335000-SF-at-its-Namesake-Building/170124",
"snippet":"Wireless technology provider Verizon Wireless has leased 27,786 square feet of office space at 512 Township Line Rd. in Blue Bell, PA. ",
"amount":"",
"sq_foot":27786,
"city_name":"Blue Bell",
"date_of_report":"2015-03-30",
"type":"Lease"
},
{
"state_name":"New York",
"source_url":"http://www.prnewswire.com/news-releases/verizon-partners-with-grind-to-open-coworking-space-in-historic-lower-manhattan-building-to-support-startups-freelancers--creatives-300157963.html",
"snippet":"Verizon today announced an initiative designed to connect with New York City's tech community, in which it will open a coworking space at its landmark building at 140 West Street in lower Manhattan, across from One World Trade Center.",
"amount":"",
"sq_foot":null,
"city_name":"New York City",
"date_of_report":"2015-10-12",
"type":"Lease"
}
],
"next":null
}
This endpoint returns the most office expansions like store opening, new office locations etc.
HTTP Request
GET /officeexpansion/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Merger, acquisition & divestitures
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/mna/"
import requests
url = "https://v2.compileapi.com/mna/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/mna/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/mna/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":14,
"previous":null,
"results":[
{
"alert_type":"mna",
"deal_size":"",
"acquiree":{
"website_domain":"http://xo.com",
"id":341337,
"name":"XO Communications"
},
"source_url":"http://www.prnewswire.com/news-releases/verizon-completes-purchase-of-xo-communications-fiber-business-300400440.html",
"snippet":"Verizon completes purchase of XO Communications' fiber business\r\n",
"deal_type":"Acquisition",
"date_of_report":"2017-02-01",
"acquirer":{
"website_domain":"http://verizon.com",
"id":341539,
"name":"Verizon Communications Inc"
}
},
{
"alert_type":"mna",
"deal_size":"$10.54B",
"acquiree":{
"website_domain":"http://verizon.com",
"id":341539,
"name":"Verizon Communications Inc"
},
"source_url":"http://www.businesswire.com/news/home/20160401005508/en/Frontier-Communications-Completes-Acquisition-Verizon-Wireline-Operations",
"snippet":"Frontier Communications Corporation (NASDAQ:FTR) today announced completion of its $10.54 billion acquisition of Verizon Communications, Inc.",
"deal_type":"Acquisition",
"date_of_report":"2016-04-01",
"acquirer":{
"website_domain":"http://frontier.com",
"id":339430,
"name":"Frontier Communications Corporation"
}
},
{
"alert_type":"mna",
"deal_size":"",
"acquiree":{
"website_domain":"http://www.complex.com",
"id":603183,
"name":"Complex Media"
},
"source_url":"http://variety.com/2016/digital/news/verizon-hearst-acquire-complex-media-1201755876/",
"snippet":"Verizon have agreed to jointly acquire Complex Media.",
"deal_type":"Acquisition",
"date_of_report":"2016-04-18",
"acquirer":{
"website_domain":"http://verizon.com",
"id":341539,
"name":"Verizon Communications Inc"
}
}
],
"next":"https://v2.compileapi.com/mna/?organization=341539&page=2"
}
This endpoint returns the most recent merger, acquisition and divestiture the company has been part of.
HTTP Request
GET /mna/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Employment changes
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/employmentchange/"
import requests
url = "https://v2.compileapi.com/employmentchange/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/employmentchange/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/employmentchange/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":8,
"previous":null,
"results":[
{
"employment_change_type":"Layoffs",
"cities_names":"",
"state_name":"Iowa",
"alert_class":"WarnNotice",
"snippet":"Cost cutting at Verizon Communications Inc in Iowa",
"effective_date":"2015-09-13",
"no_of_workers":102,
"date_of_report":"2015-07-16"
},
{
"employment_change_type":"Layoffs",
"cities_names":"",
"state_name":"New York",
"alert_class":"WarnNotice",
"snippet":"The company said Thursday a consolidation of its call centers will impact about 3,200 workers near Rochester and New York City; Bangor, Maine; Lincoln, Nebraska; Wallingford and Meriden, Connecticut, and Rancho Cordova, California.",
"effective_date":null,
"no_of_workers":3200,
"date_of_report":"2016-10-12"
},
{
"employment_change_type":"Layoffs",
"cities_names":"",
"state_name":"Alabama",
"alert_class":"WarnNotice",
"snippet":"175 job cuts at Huntsville's Verizon Center at Research Park. Jobs moving from Huntsville to Maryland facility",
"effective_date":null,
"no_of_workers":175,
"date_of_report":"2016-10-13"
}
],
"next":null
}
This endpoint returns the most recent mass employement changes in the organization including hiring, layoffs, and location shutdowns.
HTTP Request
GET /employmentchange/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Violations
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/violation/"
import requests
url = "https://v2.compileapi.com/violation/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/violation/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/violation/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":28,
"previous":null,
"results":[
{
"snippet":"Verizon Communications Inc has been charged by Occupational Safety & Health Administration on 2015-05-29 for a penalty of $7000",
"state_name":"California",
"penalty_amount":7000,
"alert_class":"Violation",
"enforcement_date":"2015-05-29",
"penalty":"$7000",
"agency_name":"Occupational Safety & Health Administration",
"city_name":"San Bernardino",
"event_date":"2016-04-05",
"date_of_report":"2015-05-29"
},
{
"snippet":"Verizon Communications Inc has been charged by Occupational Safety & Health Administration on 2015-12-14",
"state_name":"Virginia",
"penalty_amount":null,
"alert_class":"Violation",
"enforcement_date":"2015-12-14",
"penalty":null,
"agency_name":"Occupational Safety & Health Administration",
"city_name":"Alexandria",
"event_date":null,
"date_of_report":"2015-12-14"
},
{
"snippet":"Verizon Communications Inc has been charged by Occupational Safety & Health Administration on 2015-03-03",
"state_name":"Virginia",
"penalty_amount":null,
"alert_class":"Violation",
"enforcement_date":"2015-03-03",
"penalty":null,
"agency_name":"Occupational Safety & Health Administration",
"city_name":"Fairfax",
"event_date":null,
"date_of_report":"2015-03-03"
}
],
"next":"https://v2.compileapi.com/violation/?organization=341539&page=2"
}
This endpoint returns the most regulatory violations charged against the organization.
HTTP Request
GET /violation/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Technology vulnerabilities
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/vulnerability/"
import requests
url = "https://v2.compileapi.com/vulnerability/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/vulnerability/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/vulnerability/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":2,
"previous":null,
"results":[
{
"alert_type":"vulnerability",
"title":"Verizon Fios Router MI424WR-GEN3I - CSRF Vulnerability",
"source_url":"https://www.exploit-db.com/exploits/24860",
"snippet":"Vulnerability: Verizon Fios Router MI424WR-GEN3I - CSRF Vulnerability filed on: 2013-03-19",
"source":"Exploit-DB",
"cve_ids":null,
"date_of_report":"2013-03-19"
},
{
"alert_type":"vulnerability",
"title":"Verizon Fios Router MI424WR-GEN3I CSRF Vulnerability",
"source_url":"http://0day.today/exploit/description/20537",
"snippet":"Verizon Fios Router MI424WR-GEN3I CSRF Vulnerability reported on 2013-03-20 00:00:00",
"source":"0day.today",
"cve_ids":[
"CVE-2013-0126"
],
"date_of_report":"2013-03-20"
}
],
"next":null
}
This endpoint returns the most recent technology vulnerabilities in products released by the organization.
HTTP Request
GET /vulnerability/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Federal contracts
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/federalcontract/"
import requests
url = "https://v2.compileapi.com/federalcontract/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/federalcontract/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/federalcontract/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":58302,
"previous":null,
"results":[
{
"contracting_office_agency_id":"97AK: DEFENSE INFORMATION SYSTEMS AGENCY (DISA)",
"maj_agency_cat":"9700: DEPT OF DEFENSE",
"snippet":"Defense Information Systems Agency (Disa) awarded a contract to Verizon Communications Inc on 2013-08-27 for $-32",
"desciption_of_contract_req":"IGF::OT::IGF DS000018EBM",
"pop_city":null,
"date_of_report":"2013-08-27",
"dollars_obligated":-32
},
{
"contracting_office_agency_id":"1700: DEPT OF THE NAVY",
"maj_agency_cat":"9700: DEPT OF DEFENSE",
"snippet":"Dept Of The Navy awarded a contract to Verizon Communications Inc on 2013-08-27",
"desciption_of_contract_req":"WIRELESS SERVICES",
"pop_city":null,
"date_of_report":"2013-08-27",
"dollars_obligated":0
},
{
"contracting_office_agency_id":"7014: U.S. CUSTOMS AND BORDER PROTECTION",
"maj_agency_cat":"7000: HOMELAND SECURITY, DEPARTMENT OF",
"snippet":"U.S. Customs And Border Protection awarded a contract to Verizon Communications Inc on 2013-08-27 for $5600",
"desciption_of_contract_req":"IGF::OT::IGF MONTHLY CELL PHONE SERVICE",
"pop_city":null,
"date_of_report":"2013-08-27",
"dollars_obligated":5600
}
],
"next":"https://v2.compileapi.com/federalcontract/?organization=341539&page=2"
}
This endpoint returns the most recent federal contracts won by the organization.
HTTP Request
GET /federalcontract/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Federal grants & loans
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/federalgrant/"
import requests
url = "https://v2.compileapi.com/federalgrant/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/federalgrant/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/federalgrant/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":20,
"previous":null,
"results":[
{
"project_description":"P00002- NCE and PM replacement.",
"assistance_type":"Co-operative agreement",
"recipient_name":"HEWLETT-PACKARD COMPANY",
"snippet":"DEPT OF DEFENSE is providing a Co-operative agreement of 503865 to Hp Inc. on 2014-08-15",
"agency_name":"DEPT OF DEFENSE",
"action_type":"C: Revision (any change in Federal Government's financial obligation or contingent liability in existing assistance transaction amount of the change in funding; or any change in Recipient Name, Recipient Address, Project Period or Project Scope)",
"principal_place_country_code":"USA",
"principal_place_cc":"Palo Alto",
"date_of_report":"2014-08-15",
"total_funding_amount":503865
},
{
"project_description":"Modification to change the company name: LOW-ENERGY OPERATION OF COMPLEX NANOPHOTONIC CIRCUITS",
"assistance_type":"Co-operative agreement",
"recipient_name":"HEWLETT-PACKARD COMPANY",
"snippet":"DEPARTMENT OF DEFENSE is providing a Co-operative agreement of 2297910 to Hp Inc. on 2015-11-04",
"agency_name":"DEPARTMENT OF DEFENSE",
"action_type":"C: Revision (any change in Federal Government's financial obligation or contingent liability in existing assistance transaction amount of the change in funding; or any change in Recipient Name, Recipient Address, Project Period or Project Scope)",
"principal_place_country_code":"USA",
"principal_place_cc":"Palo Alto",
"date_of_report":"2015-11-04",
"total_funding_amount":2297910
},
{
"project_description":"P00005- COMPANY NAME CHANGE.",
"assistance_type":"Co-operative agreement",
"recipient_name":"HEWLETT-PACKARD COMPANY",
"snippet":"DEPARTMENT OF DEFENSE is providing a Co-operative agreement of 503865 to Hp Inc. on 2015-11-04",
"agency_name":"DEPARTMENT OF DEFENSE",
"action_type":"C: Revision (any change in Federal Government's financial obligation or contingent liability in existing assistance transaction amount of the change in funding; or any change in Recipient Name, Recipient Address, Project Period or Project Scope)",
"principal_place_country_code":"USA",
"principal_place_cc":"Herndon",
"date_of_report":"2015-11-04",
"total_funding_amount":503865
}
],
"next":"https://v2.compileapi.com/federalgrant/?organization=347125&page=2"
}
This endpoint returns the most recent federal grants or loans awarded to the organization.
HTTP Request
GET /federalgrant/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Fund raisings
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/fundraising/"
import requests
url = "https://v2.compileapi.com/fundraising/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/fundraising/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/fundraising/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":5,
"previous":null,
"results":[
{
"security_types_list":[
"Equity",
"Other"
],
"amount_sold":500000000,
"alert_type":"fundraising",
"is_amended_filing":false,
"is_offered_indefinite":false,
"source_url":"https://www.sec.gov/Archives/edgar/data/1321655/0001321655-15-000001-index.htm",
"snippet":"Palantir Technologies Inc. raised $500000000 on 2015-07-23",
"date_of_report":"2015-07-23",
"amount_offered":500000000
},
{
"security_types_list":[
"Equity",
"Other"
],
"amount_sold":879829998,
"alert_type":"fundraising",
"is_amended_filing":true,
"is_offered_indefinite":false,
"source_url":"https://www.sec.gov/Archives/edgar/data/1321655/0001321655-15-000004-index.htm",
"snippet":"Palantir Technologies Inc. raised $879829998 on 2015-12-23",
"date_of_report":"2015-12-23",
"amount_offered":879829998
},
{
"security_types_list":[
"Equity",
"Other"
],
"amount_sold":554830000,
"alert_type":"fundraising",
"is_amended_filing":true,
"is_offered_indefinite":false,
"source_url":"https://www.sec.gov/Archives/edgar/data/1321655/0001321655-15-000002-index.htm",
"snippet":"Palantir Technologies Inc. raised $554830000 on 2015-10-21",
"date_of_report":"2015-10-21",
"amount_offered":554830000
}
],
"next":null
}
This endpoint returns the most recent fund raised by the company.
HTTP Request
GET /fundraising/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Other events
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/otherevent/"
import requests
url = "https://v2.compileapi.com/otherevent/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/otherevent/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/otherevent/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":3,
"previous":null,
"results":[
{
"snippet":"Verizon Communications Inc. (the \"Purchaser\") entered into a stock purchase agreement (the \"Purchase Agreement\") with Yahoo! Inc.,",
"date_of_report":"2016-07-23",
"source_url":"https://www.sec.gov/Archives/edgar/data/732712/0000898822-16-000404-index.htm"
},
{
"snippet":"Verizon and Verizon Business International Holdings B.V., a company incorporated in the Netherlands and an indirect wholly-owned subsidiary of Verizon (\u201cVBIH\u201d), entered into a Transaction Agreement (the \u201cTransaction Agreement\u201d) with Fleetmatics Group PLC",
"date_of_report":"2016-07-30",
"source_url":"https://www.sec.gov/Archives/edgar/data/732712/0000903423-16-001181-index.htm"
},
{
"snippet":"On April 1, 2016, Verizon Communications Inc. (Verizon) completed the sale of its local exchange business and related landline activities in California, Florida and Texas (Divested Businesses).\r\n",
"date_of_report":"2016-07-29",
"source_url":"https://www.sec.gov/Archives/edgar/data/732712/0001193125-16-664170-index.htm"
}
],
"next":null
}
This endpoint returns the most recent uncategorized news related events about the organization.
HTTP Request
GET /otherevent/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| date_of_report | -date_of_report |
Visa applications
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/visaapplication/"
import requests
url = "https://v2.compileapi.com/visaapplication/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/visaapplication/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/visaapplication/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":2495547,
"previous":null,
"results":[
{
"status":"Certified",
"worksite_city":"HOUSTON",
"visa_class":"H-1B",
"worksite_postal_code":"77002",
"worksite_state":"Texas",
"prevailing_wage":"56472.00",
"is_full_time":true,
"employment_end":null,
"prevailing_unit_of_pay":"Year",
"employer_wage":null,
"employment_start":null,
"total_workers":null,
"case_submitted":"2016-05-02",
"case_number":"I-200-16123-848582",
"decision_date":"2016-05-06",
"employer_wage_unit_of_pay":null,
"employer_wage_max":null,
"prevailing_wage_level":null,
"job_title":"COMPUTER SYSTEM ANALYST"
},
{
"status":"Certified",
"worksite_city":"BELLEVUE",
"visa_class":"H-1B",
"worksite_postal_code":"98004",
"worksite_state":"Washington",
"prevailing_wage":"101088.00",
"is_full_time":true,
"employment_end":null,
"prevailing_unit_of_pay":"Year",
"employer_wage":null,
"employment_start":null,
"total_workers":null,
"case_submitted":"2016-05-10",
"case_number":"I-200-16123-860178",
"decision_date":"2016-05-16",
"employer_wage_unit_of_pay":null,
"employer_wage_max":null,
"prevailing_wage_level":null,
"job_title":"SOFTWARE DEVELOPMENT ENGINEER"
},
{
"status":"Certified",
"worksite_city":"REDMOND",
"visa_class":"H-1B",
"worksite_postal_code":"98052",
"worksite_state":"Washington",
"prevailing_wage":"85176.00",
"is_full_time":true,
"employment_end":null,
"prevailing_unit_of_pay":"Year",
"employer_wage":null,
"employment_start":null,
"total_workers":null,
"case_submitted":"2016-05-02",
"case_number":"I-200-16123-863635",
"decision_date":"2016-05-06",
"employer_wage_unit_of_pay":null,
"employer_wage_max":null,
"prevailing_wage_level":null,
"job_title":"SERVICE ENGINEER"
}
],
"next":"https://v2.compileapi.com/visaapplication/?organization=341539&page=2"
}
This endpoint returns the most recent visa applications filed by the organization. visa_class indicates the type of visa applied.
HTTP Request
GET /visaapplication/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer | |
FILTER | status | String | Choices |
FILTER | case_submitted | String (Date YYYY-mm-dd) | |
FILTER | visa_class | String | Choices |
FILTER | is_full_time | Boolean (1 for Yes, 0 for No) |
order choices
| ASC | DESC |
|---|---|
| case_submitted | -case_submitted |
| decision_date | -decision_date |
Filter choices
status
| Verbose | Value |
|---|---|
| Certified-Withdrawn | CERTIFIED-WITHDRAWN |
| Certified-Expired | CERTIFIED-EXPIRED |
| Withdrawn | WITHDRAWN |
| Certified | CERTIFIED |
| Denied | DENIED |
| Invalidated | INVALIDATED |
| Rejected | REJECTED |
visa_class
| Verbose | Value |
|---|---|
| E-3 | E-3 |
| H-1B | H-1B |
| C | C |
| S | S |
Green Card (PERM) applications
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/perm/"
import requests
url = "https://v2.compileapi.com/perm/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/perm/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/perm/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":419410,
"previous":null,
"results":[
{
"status":"Certified-Expired",
"worksite_city":"Windsor",
"visa_class":"H-1B",
"is_refile":false,
"employer_country":"United States",
"swa_job_order_start":null,
"application_type":"PERM",
"worksite_state":null,
"prevailing_wage":"107266.00",
"employer_state":"Ohio",
"prevailing_unit_of_pay":"Year",
"swa_job_order_end":null,
"employer_wage":"130000.00",
"case_submitted":null,
"case_number":"A-10214-11447",
"worksite_postal_code":null,
"decision_date":"2010-11-02",
"employer_wage_unit_of_pay":"Year",
"employer_wage_max":null,
"prevailing_wage_level":null,
"job_title":"Treasurers, Controllers, and Chief Financial Officers"
},
{
"status":"Certified-Expired",
"worksite_city":"Grand Rapids",
"visa_class":"H-1B",
"is_refile":false,
"employer_country":"United States",
"swa_job_order_start":null,
"application_type":"PERM",
"worksite_state":null,
"prevailing_wage":"50600.00",
"employer_state":"Michigan",
"prevailing_unit_of_pay":"Year",
"swa_job_order_end":null,
"employer_wage":"50600.00",
"case_submitted":null,
"case_number":"A-10214-11451",
"worksite_postal_code":null,
"decision_date":"2011-02-01",
"employer_wage_unit_of_pay":"Year",
"employer_wage_max":null,
"prevailing_wage_level":null,
"job_title":"Dietitians and Nutritionists, Non R&D"
},
{
"status":"Certified-Expired",
"worksite_city":"New York",
"visa_class":"H-1B",
"is_refile":false,
"employer_country":"United States",
"swa_job_order_start":null,
"application_type":"PERM",
"worksite_state":null,
"prevailing_wage":"68266.00",
"employer_state":"New York",
"prevailing_unit_of_pay":"Year",
"swa_job_order_end":null,
"employer_wage":"80000.00",
"case_submitted":null,
"case_number":"A-10214-11464",
"worksite_postal_code":null,
"decision_date":"2010-11-12",
"employer_wage_unit_of_pay":"Year",
"employer_wage_max":null,
"prevailing_wage_level":null,
"job_title":"Accountants"
}
],
"next":"https://v2.compileapi.com/perm/?organization=341539&page=2"
}
This endpoint returns the most recent Green card (PERM) applications filed by the organization. visa_class indicates the type of visa that was previous to the application. status indicates the status of the current application.
HTTP Request
GET /perm/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer | |
FILTER | status | String | Choices |
FILTER | case_submitted | String (Date YYYY-mm-dd) | |
FILTER | visa_class | String | Choices |
FILTER | employer_state | String (Region/State) | Choices |
order choices
| ASC | DESC |
|---|---|
| case_submitted | -case_submitted |
| decision_date | -decision_date |
Filter choices
status
| Verbose | Value |
|---|---|
| Certified-Withdrawn | CERTIFIED-WITHDRAWN |
| Certified-Expired | CERTIFIED-EXPIRED |
| Withdrawn | WITHDRAWN |
| Certified | CERTIFIED |
| Denied | DENIED |
| Invalidated | INVALIDATED |
| Rejected | REJECTED |
visa_class
| Verbose | Value |
|---|---|
| A-3 | A-3 |
| A1/A2 | A1/A2 |
| AOS | AOS |
| AOS/H-1B | AOS/H-1B |
| B-1 | B-1 |
| B-2 | B-2 |
| C-1 | C-1 |
| C-3 | C-3 |
| D-1 | D-1 |
| E-1 | E-1 |
| E-2 | E-2 |
| E-3 | E-3 |
| EWI | EWI |
| F-1 | F-1 |
| F-2 | F-2 |
| G-1 | G-1 |
| G-2 | G-2 |
| G-3 | G-3 |
| G-4 | G-4 |
| G-5 | G-5 |
| H-1A | H-1A |
| H-1B | H-1B |
| H-1B/I-485 app | H-1B/I-485 app |
| H-1B1 | H-1B1 |
| H-1C | H-1C |
| H-2A | H-2A |
| H-2B | H-2B |
| H-3 | H-3 |
| H-4 | H-4 |
| H1B | H1B |
| H1B1 | H1B1 |
| I | I |
| J-1 | J-1 |
| J-2 | J-2 |
| K-1 | K-1 |
| K-2 | K-2 |
| K-3 | K-3 |
| L-1 | L-1 |
| L-1B | L-1B |
| L-2 | L-2 |
| M-1 | M-1 |
| M-2 | M-2 |
| N | N |
| O-1 | O-1 |
| O-2 | O-2 |
| O-3 | O-3 |
| OOS | OOS |
| P-1 | P-1 |
| P-2 | P-2 |
| P-3 | P-3 |
| P-4 | P-4 |
| Q | Q |
| R-1 | R-1 |
| R-2 | R-2 |
| T-1 | T-1 |
| TD | TD |
| TN | TN |
| TPS | TPS |
| U-1 | U-1 |
| U-3 | U-3 |
| U-4 | U-4 |
| V-1 | V-1 |
| V-2 | V-2 |
| VWB | VWB |
| VWT | VWT |
| Parol | Parol |
| Parolee | Parolee |
| Not in USA | Not in USA |
employer_state
| Verbose | Value |
|---|---|
| United States - Alabama | US.AL |
| United States - Alaska | US.AK |
| United States - Arizona | US.AZ |
| United States - Arkansas | US.AR |
| United States - California | US.CA |
| United States - Colorado | US.CO |
| United States - Connecticut | US.CT |
| United States - Delaware | US.DE |
| United States - Florida | US.FL |
| United States - Georgia | US.GA |
| United States - Hawaii | US.HI |
| United States - Idaho | US.ID |
| United States - Illinois | US.IL |
| United States - Indiana | US.IN |
| United States - Iowa | US.IA |
| United States - Kansas | US.KS |
| United States - Kentucky | US.KY |
| United States - Louisiana | US.LA |
| United States - Maine | US.ME |
| United States - Maryland | US.MD |
| United States - Massachusetts | US.MA |
| United States - Michigan | US.MI |
| United States - Minnesota | US.MN |
| United States - Mississippi | US.MS |
| United States - Missouri | US.MO |
| United States - Montana | US.MT |
| United States - Nebraska | US.NE |
| United States - Nevada | US.NV |
| United States - New Hampshire | US.NH |
| United States - New Jersey | US.NJ |
| United States - New Mexico | US.NM |
| United States - New York | US.NY |
| United States - North Carolina | US.NC |
| United States - North Dakota | US.ND |
| United States - Ohio | US.OH |
| United States - Oklahoma | US.OK |
| United States - Oregon | US.OR |
| United States - Pennsylvania | US.PA |
| United States - Rhode Island | US.RI |
| United States - South Carolina | US.SC |
| United States - South Dakota | US.SD |
| United States - Tennessee | US.TN |
| United States - Texas | US.TX |
| United States - Utah | US.UT |
| United States - Vermont | US.VT |
| United States - Virginia | US.VA |
| United States - Washington | US.WA |
| United States - Washington, D.C. | US.DC |
| United States - West Virginia | US.WV |
| United States - Wisconsin | US.WI |
| United States - Wyoming | US.WY |
Patents
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/patent/"
import requests
url = "https://v2.compileapi.com/patent/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/patent/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/patent/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":647,
"previous":null,
"results":[
{
"application_number":"11460499",
"title":"Optical network terminal power failure management",
"url":"http://patft1.uspto.gov/netacgi/nph-Parser?Sect1=PTO2&Sect2=HITOFF&p=1&u=%2Fnetahtml%2FPTO%2Fsearch-bool.html&r=1&f=G&l=50&co1=AND&d=PTXT&s1=11460499&OS=11460499&RS=11460499",
"filed_date":"2006-07-27",
"is_granted":true,
"publication_date":"2010-07-06"
},
{
"application_number":"11560954",
"title":"Automated packet switch carrier health monitoring process",
"url":"http://patft1.uspto.gov/netacgi/nph-Parser?Sect1=PTO2&Sect2=HITOFF&p=1&u=%2Fnetahtml%2FPTO%2Fsearch-bool.html&r=1&f=G&l=50&co1=AND&d=PTXT&s1=11560954&OS=11560954&RS=11560954",
"filed_date":"2006-11-17",
"is_granted":true,
"publication_date":"2010-03-09"
},
{
"application_number":"11507611",
"title":"Method and apparatus for measurement of service disruption interval",
"url":"http://patft1.uspto.gov/netacgi/nph-Parser?Sect1=PTO2&Sect2=HITOFF&p=1&u=%2Fnetahtml%2FPTO%2Fsearch-bool.html&r=1&f=G&l=50&co1=AND&d=PTXT&s1=11507611&OS=11507611&RS=11507611",
"filed_date":"2006-08-22",
"is_granted":true,
"publication_date":"2011-03-01"
}
],
"next":"https://v2.compileapi.com/patent/?organization=341539&page=2"
}
This endpoint returns the most recent patents filed by the organization. The is_granted field will tell you if the patent is granted or not.
HTTP Request
GET /patent/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| filed_date | -filed_date |
Trademarks
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/trademark/"
import requests
url = "https://v2.compileapi.com/trademark/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/trademark/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/trademark/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":107,
"previous":null,
"results":[
{
"url":"http://tsdr.uspto.gov/#caseNumber=85023977&caseSearchType=US_APPLICATION&caseType=DEFAULT&searchType=statusSearch",
"filed_date":"2010-04-27",
"last_status_code":700,
"last_status_date":"2011-02-15",
"last_status_verbose":"Registered",
"serial_number":85023977,
"first_use_date":"2010-06-28"
},
{
"url":"http://tsdr.uspto.gov/#caseNumber=77396211&caseSearchType=US_APPLICATION&caseType=DEFAULT&searchType=statusSearch",
"filed_date":"2008-02-13",
"last_status_code":710,
"last_status_date":"2016-05-13",
"last_status_verbose":"Cancelled-Section 8",
"serial_number":77396211,
"first_use_date":"2008-07-28"
},
{
"url":"http://tsdr.uspto.gov/#caseNumber=77730406&caseSearchType=US_APPLICATION&caseType=DEFAULT&searchType=statusSearch",
"filed_date":"2009-05-06",
"last_status_code":700,
"last_status_date":"2011-06-21",
"last_status_verbose":"Registered",
"serial_number":77730406,
"first_use_date":"2009-12-14"
}
],
"next":"https://v2.compileapi.com/trademark/?organization=341539&page=2"
}
This endpoint returns the most recent trademarks filed by the organization. last_status_code and last_status_verbose indicates the status of each application.
HTTP Request
GET /trademark/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
ORDERING | order | Choices | |
FILTER | organization | Integer |
order choices
| ASC | DESC |
|---|---|
| filed_date | -filed_date |
Feeds
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/feed/"
import requests
url = "https://v2.compileapi.com/feed/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/feed/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/feed/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"count":16,
"previous":null,
"results":[
{
"feed_type":"trademark",
"feed_url":"https://compileis-prod.s3.amazonaws.com/feed/trademark.xml"
},
{
"feed_type":"patent",
"feed_url":"https://compileis-prod.s3.amazonaws.com/feed/patent.xml"
},
{
"feed_type":"perm",
"feed_url":"https://compileis-prod.s3.amazonaws.com/feed/perm.xml"
}
],
"next":"https://v2.compileapi.com/feed/?page=2"
}
This endpoint returns links to all feeds from Compile. Feeds are updated weekly and contain data for the past 30 days. Make sure you query this API endpoint to get the latest feed url. This changes every week.
HTTP Request
GET /feed/
URL Parameters
| Field action | Field name | Field Type | Choices |
|---|---|---|---|
FILTER | feed_type | String | Choices |
Filter choices
feed_type
| Verbose | Value |
|---|---|
| SEC filings | secfiling |
| Security breaches | securitybreach |
| Executive changes | executivechange |
| Office expansions | officeexpansion |
| Merger, acquisition & divestitures | mna |
| Employment changes | employmentchange |
| Violations | violation |
| Technology vulnerabilities | vulnerability |
| Federal contract | federalcontract |
| Federal grants & loans | federalgrant |
| Fund raising | fundraising |
| Other events | otherevent |
| Visa applications | visaapplication |
| Green Card (PERM) applications | perm |
| Patents | patent |
| Trademarks | trademark |
| Technology installs | install |
Usage
Sample code
curl -X GET -H "apikey: compileapikey" \
"https://v2.compileapi.com/usage/"
import requests
url = "https://v2.compileapi.com/usage/"
headers = {'apikey': "compileapikey"}
response = requests.request("GET", url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI("https://v2.compileapi.com/usage/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["apikey"] = 'compileapikey'
response = http.request(request)
puts response.read_body
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://v2.compileapi.com/usage/");
xhr.setRequestHeader("apikey", "compileapikey");
xhr.send(data);
This endpoint returns JSON structured like this:
{
"current":{
"usage":{
"/organization/":6431,
"/perm/":5214,
"/mna/":0,
"/organization/<pk>/":6409,
"/trademark/":0,
"/organization/<pk>/trends/":8,
"/securitybreach/":0,
"/federalgrant/":0,
"/installs/":1,
"/patent/":0,
"/violation/":0,
"/otherevent/":0,
"/officeexpansion/":0,
"/employmentchange/":0,
"/executivechange/":0,
"/feed/":9,
"/federalcontract/":0,
"/fundraising/":0,
"/visaapplication/":9193,
"/vulnerability/":0,
"/organization/<pk>/health_scores/":0,
"/secfiling/":0
},
"window":[
"2017-04-01",
"2017-04-30"
]
},
"previous":{
"usage":{
"/organization/":33,
"/perm/":0,
"/mna/":0,
"/organization/<pk>/":22,
"/trademark/":0,
"/organization/<pk>/trends/":0,
"/securitybreach/":0,
"/federalgrant/":0,
"/installs/":11,
"/patent/":0,
"/violation/":0,
"/otherevent/":0,
"/officeexpansion/":0,
"/employmentchange/":0,
"/executivechange/":3,
"/feed/":0,
"/federalcontract/":0,
"/fundraising/":0,
"/visaapplication/":0,
"/vulnerability/":0,
"/organization/<pk>/health_scores/":0,
"/secfiling/":2
},
"window":[
"2017-03-01",
"2017-03-31"
]
}
}
API usage current and previous billing cycle.
Returns: The total number of countable requests made to Compile API for each path
HTTP Request
GET /usage/