Introduction
Welcome to the REST API for Oracle DataFox. The Oracle DataFox API is a RESTful API. Communication happens over standard HTTPS, and responses are returned in JSON. You can use the API to:
Match Companies You can programmatically match companies in your target list with the canonical Oracle DataFox record using the company match endpoint by passing the name and or URL of the company as a query parameter. The endpoint supports matching by name and or URL and refining by location. The bulk company match endpoint supports bulk matching. You can use this endpoint to grab an Oracle DataFox ID for a record in your target list. Oracle recommends that you save this ID in your database for future use.
Enrich Data When you have the Oracle DataFox ID for a company on your target list, you can retrieve the detailed firmographic data on the company using the details endpoint.
View Company Data You can use this endpoint to retrieve company data. For a complete list of all the information you can retrieve, see Company Object.
View Signal Data You can use this endpoint to get the signal information found on the company profile page. For a complete list of all the signal tags available, see Signal-tag Object.
Get Started
Oracle Cloud Subscriptions
If you subscribed to Oracle DataFox using Oracle Cloud, you must use Oracle Identity Cloud Service to manage your access to the API. The first step is to create a new application in Oracle Identity Cloud Service. You will use this application’s Client ID and Client Secret later when accessing the API. For details on managing applications in Oracle Identity Cloud Service, see Manage Oracle Identity Cloud Service Applications.
For details on creating a confidential application in Oracle Identity Cloud Service, see Add Confidential Application. Let’s look at the steps to set up a confidential application so that it can call the API.
- Sign in to Oracle Identity Cloud Service, go to the navigation menu and click Applications.
- Click Add.
- On the Add Application page, click Confidential Application.
- On the Add Confidential Application wizard’s Details page, in the App Details section, enter the name of your new application.
- Click Next.
- On the Add Confidential Application wizard’s Client page, click Configure this application as a client now.
- On the Add Confidential Application wizard’s Client page, in the Authorization section, select
Client Credentials, Authorization Code and Refresh Token as Allowed Grant Types. Enter the Redirect URL where Oracle Identity Cloud Service will send the authorization code after the user authorizes your application to access the API. - On the Add Confidential Application wizard’s Client page, in the Token Issuance Policy section, click Add Scope.
- In the Select Scope dialog box, locate DATAFOX, and click the arrow next to it. Select the scope that ends with /full. Here’s an example of the scope value to select: https://example-customer.api.datafox.ocs.oraclecloud.com/full.
- Click Add. The selected scope now appears in the Resources section under Token Issuance Policy.
- On the Add Confidential Application wizard’s Client page, click Next.
- On the Add Confidential Application wizard’s Resources page, click Next.
- On the Add Confidential Application wizard’s Web Tier Policy page, click Next.
- On the Add Confidential Application wizard’s Authorization page, click Finish. The application has been added in a deactivated state.
- Record the Client ID and Client Secret that appear in the Application Added dialog box.
- Click Close. The new application’s details page is displayed.
- Click Activate.
- In the Confirmation dialog box, click OK to activate your new application.
Subscriptions Created Before December 10th, 2020
- To get started with the API authentication, sign in to your account and select the Settings wheel in the lower
left corner, then click Integrations in the middle of the page.
- Scroll toward the bottom of the page until you see OAuth2 Clients. Insert a name in the Name field and paste
https://localhost in the Redirect URL field. Then, select Generate New Client. If you don’t see this option,
contact support.
- After generating, you see the long alphanumeric Client ID and select show secret to view the Client Secret.
You can now exchange Client ID and Client Secret for an access token that is valid for four hours. If you only want to use the API for personal use, the easiest way to get an access token is to use the Client Credentials grant type to request an access token for the user associated with the client you are using.
Authentication: Oracle Cloud Subscriptions
The Oracle DataFox API uses a standard OAuth 2.0 flow to authorize and authenticate API clients and users. For details on OAuth 2.0, see IETF RFC 6749 and Abstract Protocol Flow.
Oracle DataFox uses Oracle Identity Cloud Service as an OAuth 2.0 authorization server.
In the Get started section, you created an application in Oracle Identity Cloud Service. Let’s learn how to use the Client ID and Client Secret to obtain tokens using various grant types.
Important Values Unique to Your Oracle DataFox Instance
Before you proceed, you must sign into Oracle Identity Cloud Service of your Oracle DataFox instance and get a few values. Here’s the list of values along with their description:
- IDCS-Service-Instance: Identifier of the Oracle Identity Cloud Service instance.
- API URL: This is URL to the API exposed by your Oracle DataFox instance.
- Fully Qualified Scopes: These are scope values unique to your Oracle DataFox instance. Oracle DataFox currently supports only one scope named /full (the other scope is for Oracle Cloud internal usage). The fully qualified scope is a concatenation of the API URL and the scope name. For example, http://myinstance.api.datafox.ocs.oraclecloud.com/full.
Here’s how you get the values after you sign in to Oracle Identity Cloud Service console:
- Get IDCS-Service-Instance value by inspecting the URL in the address bar of your browser. The URL has this structure:
https://<IDCS-Service-Instance>.identity.oraclecloud.com/<rest of the URL>
. - Go to the navigation menu and then click Oracle Cloud Services. Locate and click the DATAFOX service.
- On the DATAFOX service’s Configuration page, expand Resources section.
- Record the value of the Primary Audience field. This is your API URL.
- By concatenating the value of the Primary Audience field and values under the Scopes sub-section, compute the Fully Qualified Scopes for your Oracle DataFox instance.
Authorization Code Grant: Requesting an Authorization Code
Prompt users to authorize the application by sending them the URL that follows this structure:
GET https://<IDCS-Service-Instance>.identity.oraclecloud.com/oauth2/v1/authorize?client_id=CLIENT_ID&response_type=code&redirect_uri=REDIRECT_URI&scope=SCOPES&nonce=NONCE&state=STATE
SCOPES
is a space-separated list of scopes requested. To access the API, you need to provide a fully qualified scope
of your Oracle DataFox instance. Note that you can add additional scopes that will customize the tokens you will get in
exchange for the Authorization Code. The openid
scope instructs Oracle Identity Cloud Service to return more information
about the user’s identity in the form of an ID Token. The offline_access
scope instructs Oracle Identity Cloud Service
to return a Refresh Token. An Access Token is always returned.
STATE
is optional but recommended, as described in Cross-Site Request Forgery (CSRF).
If you’re using this parameter, ensure it’s an opaque value you generate and bind to the authorization code request.
Also make sure you store it in the user-agent’s authenticated state. For example, in the session, so you can cross-check the
value later.
NONCE
is optional but recommended, as described in Open ID Connect - Authentication Request.
If you’re using this parameter, ensure it’s a cryptographically strong value you generate and bind to the authorization code request.
Also make sure you store it in the user-agent’s authenticated state. For example, in the session, so you can cross-check the
value later. The nonce value will be embedded in the returned ID Token.
For details on the Authorization Code Grant Type, see Authorization Code Grant Type.
Authorization Code Grant: Exchanging the Authorization Code for the Access Token
curl --request POST \
--basic --user CLIENT_ID:CLIENT_SECRET \
--data code=AUTHORIZATION_CODE \
--data grant_type=authorization_code \
--data redirect_uri=REDIRECT_URI \
https://<IDCS-Service-Instance>.identity.oraclecloud.com/oauth2/v1/token
JSON Response:
{
"access_token": "eyJ4NXQjUzI1NiI6IkdoV0NodU41MjBzdUFNMUF2...",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_token": "AgAgNDZkN2RkYzU0ZTcyNGE0ZGE4MjlmODcz...",
"id_token": "eyJ4NXQjUzI1NiI6IkdoV0NodU41MjBzdUFNMUF2Uk..."
}
When the user accepts your application, they will be sent to your specified redirect URI with the authorization code and state as query parameters:
REDIRECT_URI?code=AUTHORIZATION_CODE&state=STATE
Use STATE
from the query string only if you have used it while requesting the authorization code. Also ensure it has
the exact value as mentioned in the authorization code request. If the value is different, do not proceed with the
authentication. You may be a victim of CSRF attack.
Extract AUTHORIZATION_CODE
from the query parameter to exchange it for an access token.
To get an access token (and optional ID and Refresh tokens) for the user, send the authorization code to Oracle Identity Cloud Service.
If you asked for ID Token using the openid
scope and provided the NONCE
value, you should check the received ID token and compare
the value of its nonce
claim with the value you bound to the authorization code request. When the values do not match, you should
not proceed with authentication as you may be a victim of ID Token Replay attack.
Client Credentials Grant
curl --request POST \
--basic --user CLIENT_ID:CLIENT_SECRET \
--data grant_type=client_credentials \
--data scope=<API URL>/full \
https://<IDCS-Service-Instance>.identity.oraclecloud.com/oauth2/v1/token
JSON Response:
{
"access_token": "eyJ4NXQjUzI1NiI6IkdoV0NodU41MjBzdUFNMUF2UkNHNUJyLW15TzZWc3d4V240QzlRTEVJ...",
"token_type": "Bearer",
"expires_in": 3600
}
Use this grant type when you want to access the API under a single identity of the application that you created in Oracle Identity Cloud Service. Note that when making the API call using this grant type, there is no user identity associated with it. Only the identity of the application is known. The access rights of the application are of an Oracle DataFox Admin role. This makes this grant type ideal when your use case is global to your organization, like implementing an automated process that enriches data in your system with the data in your Oracle DataFox instance.
For details on Client Credentials Code Grant Type, see Client Credentials Grant Type.
Refresh the Access Token
curl --request POST \
--basic --user CLIENT_ID:CLIENT_SECRET \
--data grant_type=refresh_token \
--data refresh_token=REFRESH_TOKEN \
--data scope=<API URL>/full \
https://<IDCS-Service-Instance>.identity.oraclecloud.com/oauth2/v1/token
JSON Response:
{
"access_token": "eyJ4NXQjUzI1NiI6IkdoV0NodU41MjBzdUFNMUF2...",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_token": "AgAgNDZkN2RkYzU0ZTcyNGE0ZGE4MjlmODcz..."
}
You can ask Oracle Identity Cloud Service to issue Refresh Token along with Access Token (see offline_access
scope in
Authorization Code Grant: Requesting an Authorization Code).
If you do so, you can get a new Access Token when the current one expires without user intervention using the Refresh
Token grant type. The scope
parameter is optional and if not provided, a new Access Token will be issued
with the same scopes as the original one.
For details on this grant type, see Refresh Token Grant Type.
Authenticated Requests
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://<API URL>/2.0/<ENDPOINT>
For all subsequent requests, pass the access token in the Authorization
header
with value Bearer ACCESS_TOKEN
.
Rate Limit
The default rate limit is set at 10 calls/second (increases available) to ensure service quality. Contact Oracle Support to discuss changes to your rate limit.
Authentication: Subscriptions Created Before December 10th, 2020
The Oracle DataFox API uses a standard OAuth 2.0 flow to authorize and authenticate API clients and users. See IETF RFC 6749 and especially the diagram of the Abstract Protocol Flow for a good reference on OAuth 2.0.
In Get started section, you created OAuth2 Client in DataFox and now you will learn how to use its Client ID and Client Secret to obtain tokens using various grant types.
Authorization Code Grant: Requesting an Authorization Code
Prompt users to authorize the application that uses your OAuth2 Client by sending them to the URL that follows this structure:
https://app.datafox.com/oauth2/authorize?response_type=code&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&scope=SCOPES&state=STATE
SCOPES
is a comma-separated list of scopes requested. As of now, full
is the only scope accepted.
STATE
is optional but recommended, as described in Cross-Site Request Forgery (CSRF).
If you’re using this parameter, ensure it’s an opaque value you generate and bind to the authorization code request.
Also make sure you store it in the user-agent’s authenticated state. For example, in the session, so you can cross-check the
value later.
Authorization Code Grant: Exchanging the Authorization Code for an Access Token
curl --request POST \
--basic --user CLIENT_ID:CLIENT_SECRET \
--data code=AUTHORIZATION_CODE \
--data grant_type=authorization_code \
--data redirect_uri=REDIRECT_URI \
--data scope=full \
https://api.datafox.com/2.0/oauth2/token
JSON Response:
{
"access_token": "7s27S0DuEbH4H5TkE7t9TXAzHl1y9qsC",
"refresh_token": "7Hk9pluHuBM6tTI5kM4QYp22D8HyShZH",
"expires_in": 3599
}
When the user accepts your application, they will be sent to your specified redirect URI with the authorization code and state as query parameters:
REDIRECT_URI?code=AUTHORIZATION_CODE&state=STATE
Use STATE
from the query string only if you’ve used it while requesting the authorization code. Also ensure
it has the exact value as mentioned in the authorization code request. If the value is different,
do not proceed with the authentication. You may be a victim of CSRF attack.
Extract AUTHORIZATION_CODE
from the query parameter to exchange it for an access token.
To get an access token for the user, send the authorization code to DataFox.
Client Credentials Grant
curl --request POST \
--basic --user CLIENT_ID:CLIENT_SECRET \
--data grant_type=client_credentials \
--data scope=full \
https://api.datafox.com/2.0/oauth2/token
JSON Response:
{
"access_token": "LLe2BJxAvYU2ZH0ZCGT69dcEhasN81SI",
"refresh_token": "QaNtutL9JBopX7rrFYCQLfnH6xv3H1o6",
"expires_in": 3599
}
If you only want to use the API for personal use, the easiest way to get an access token would be to use the Client Credentials grant type to request an access token for the user associated to the client you are using.
Refresh the Access Token
curl --request POST \
--basic --user CLIENT_ID:CLIENT_SECRET \
--data refresh_token=REFRESH_TOKEN \
--data grant_type=refresh_token \
https://api.datafox.com/2.0/oauth2/token
JSON Response:
{
"access_token": "LLe2BJxAvYU2ZH0ZCGT69dcEhasN81SI",
"refresh_token": "QaNtutL9JBopX7rrFYCQLfnH6xv3H1o6",
"expires_in": 3599
}
When an access token has expired, request a new one using the refresh token provided earlier.
Authenticated Requests
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/<ENDPOINT>
For all subsequent requests, pass the access token in the Authorization
header
with value Bearer ACCESS_TOKEN
.
Rate Limit
The default rate limit is set at 10 calls/second (increases available) to ensure service quality. Contact Oracle Support to discuss changes to your rate limit.
Types
The API responses are all JSON, but it is helpful to specify some of the types of values that are given in responses.
Type | Explanation |
---|---|
String | String |
Integer | Integer |
Float | Float |
Long | Long |
Boolean | Boolean (true or false ) |
ID | String matching [a-f0-9]{24} |
Date | Date formatted in ISO 8601 notation (e.g. "2015-03-14T16:26:53.589Z" ) |
Object Types
Company
Basic
{
"id": "51c6b9a5a9812aa90b123980",
"object_type": "company",
"name": "DataFox",
"slug": "datafox",
"url": "datafox.com",
"location": "San Francisco, CA",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of the company |
object_type | String | "company" |
name | String | company name |
slug | String | company slug |
url | String | company’s main URL |
location | String | company’s main location – usually city, state (in US) or city, country (outside of US) |
icon_url | String | URL to company favicon |
Full
{
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"legal_name": "Oracle",
"naics_code": null,
"naics_code_description": null,
"ein": null,
"founded_year": null,
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z",
"status": "acquired",
"ceo_name": "Bastiaan Janmaat",
"description": "DataFox is a company intelligence platform that helps sales, marketing, and investing teams find and prioritize target companies to source more opportunities. DataFox's team of 100+ human analysts verify AI-sourced insights on millions of businesses to provide robust Company Data, Growth Signals, and Account Scoring. Headquartered in San Francisco, CA, DataFox is backed by Goldman Sachs, Green Visor, Google Ventures, and Slack, and used by high-growth startups and Fortune 500 companies alike; examples include UPS, Accel Partners, Bain & Company, Twilio, Zendesk, and Outreach.",
"street1": "475 Sansome St",
"street2": "12th fl",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zipcode": "94111",
"top_keywords": [
"software and technical consulting",
"software",
"crm orchestration",
"company intelligence",
"marketing teams"
],
"revenue_estimate": 9500000,
"number_of_employees": 48,
"angellist_slug": "datafox",
"crunchbase_permalink": "datafox",
"linkedin_id": 3231060,
"twitter_handle": "datafoxco",
"blog_url": "http://datafox.com/blog",
"industry_code": "industry_055",
"industry_name": "Information Technology",
"subindustry_code": "subindustry_382",
"subindustry_name": "Enterprise Software"
}
In addition to the basic company fields, the full company will also have these fields:
Field | Type | Explanation |
---|---|---|
description | String | long description for the company |
status | String | company status |
ceo_name | String | name of the company’s CEO |
street1 | String | main location – first part of street |
street2 | String | main location – second part of street |
city | String | main location – city |
state | String | main location – state |
country | String | main location – country |
zipcode | String | main location – zipcode |
top_keywords | [String] | array of the company’s top keywords |
industry_name | String | company’s industry name |
industry_code | String | company’s industry code |
subindustry_name | String | company’s subindustry name |
subindustry_code | String | company’s subindustry code |
revenue_estimate | Integer | estimate of company’s annual revenue |
number_of_employees | Integer | estimate of the number of employees at the company |
angellist_slug | String | company’s angellist slug |
crunchbase_permalink | String | company’s crunchbase slug |
linkedin_id | Integer | company’s linkedin id number |
twitter_handle | String | company’s twitter handle |
blog_url | String | company’s blog url |
last_modified_date | Date | last modified date and time |
ein | String | nine-digit US tax ID |
legal_name | String | company’s legal name |
year_founded | Integer | year in which the company was established |
naics_code | String | six-digit NAICS industry code |
naics_code_description | String | description of the NAICS industry code |
MatchCompany
{
"confidence": "0.99999999",
"company": {
"id": "51c6b9a5a9812aa90b123980",
"object_type": "company",
"name": "DataFox",
"slug": "datafox",
"url": "datafox.com",
"location": "San Francisco, CA",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
}
}
Field | Type | Explanation |
---|---|---|
confidence | Float | The match score is a number between 0 and 1. The higher the score, the more confident is the match. The score is calibrated such that any score above 0.5 is a strong match. Oracle recommends using this threshold to determine if a match is confident. The match score depends on all the available attributes, including name, URL, and address. |
company | Company (basic) | Basic version of company object |
Funding Round
{
"id": "563befdd6a187ef3120000b4",
"object_type": "funding_round",
"round_code": "seed",
"raised_amount": 5000000,
"currency_code": null,
"date": "2015-07-22T00:00:00.000Z",
"company": {
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"object_type": "company",
"location" : "San Francisco, CA",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
},
"investments": [
{
"id": "563befdd6a187ef3120000c4",
"company": {
"id": "53af404abf9923352a0226c6",
"slug": "goldman-sachs",
"name": "Goldman Sachs",
"object_type": "company",
"location" : "New York, NY",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/53af404abf9923352a0226c6.ico"
},
"object_type": "investment",
"money_invested_amount": null,
"currency_code": "USD"
},
{
"id": "563befdd6a187ef3120000c3",
"company": {
"id": "53b34972e43739f942015df7",
"slug": "green-visor-capital",
"name": "Green Visor Capital",
"object_type": "company",
"location" : "San Francisco, CA",
"icon_url": null
},
"object_type": "investment",
"money_invested_amount": null,
"currency_code": "USD"
},
{
"id": "563befdd6a187ef3120000c2",
"company": {
"id": "5130f07a8989846a36025dbe",
"slug": "startx",
"name": "StartX",
"object_type": "company",
"location" : "Palo Alto, CA",
"icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130f07a8989846a36025dbe.ico"
},
"object_type": "investment",
"money_invested_amount": null,
"currency_code": "USD"
}
]
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of funding round |
object_type | String | "funding_round" |
round_code | String | round code (enumerated type) |
raised_amount | Long | amount raised in round |
currency_code | String | currency of raise |
date | Date | date of round |
investments | [Investment] | investors in the round |
company | Company (basic) | company receiving funding round |
Investment
{
"id": "563befdd6a187ef3120000c4",
"company": {
"id": "53af404abf9923352a0226c6",
"slug": "goldman-sachs",
"name": "Goldman Sachs",
"object_type": "company",
"location": "New York, NY",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/53af404abf9923352a0226c6.ico"
},
"object_type": "investment",
"money_invested_amount": null,
"currency_code": "USD"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of investment |
object_type | String | "investment" |
money_invested_amount | Integer | amount invested |
currency_code | String | currency of raise |
company | Company (basic) | company making the investment |
User
{
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of user |
object_type | String | "user" |
slug | String | user slug |
first_name | String | fist name of user |
last_name | String | last name of user |
team_id | ID | ID of the user’s team |
Acquisition
{
"id": "5371b2e3519c2a1c07027111",
"object_type": "acquisition",
"acquirer": {
"id": "5130f01b8989846a36011118",
"slug": "instagram",
"name": "Instagram",
"object_type": "company",
"location": "Menlo Park, CA",
"icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130f01b8989846a36011118.ico"
},
"target": {
"id": "5219e03807cca8d333187df0",
"slug": "luma-io",
"name": "Luma.io",
"object_type": "company",
"location" : "Palo Alto, CA",
"icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5219e03807cca8d333187df0.ico"
},
"price": null,
"currency_code": "USD",
"date": "2013-08-23T00:00:00.000Z"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of acquisition |
object_type | String | "acquisition" |
price | Long | cost of acquisition |
currency_code | String | currency of acquisition deal |
date | Date | date of acquisition |
acquirer | Company (basic) | buyer |
target | Company (basic) | company that was acquired |
IPO
{
"id": "552fdfe0382e2b8b47000abe",
"object_type": "ipo",
"company": {
"id": "5130efc78989846a36000ad8",
"slug": "etsy",
"name": "Etsy",
"object_type": "company",
"location" : "New York, NY",
"icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efc78989846a36000ad8.ico"
},
"money_raised": null,
"currency_code": null,
"date": "2015-04-01T00:00:00.000Z"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of ipo |
object_type | String | "ipo" |
money_raised | Long | money raised |
currency_code | String | currency of ipo |
date | Date | date of acquisition |
company | Company (basic) | company that was acquired |
Similar Company
{
"confidence": 0.6520620424036144,
"company": {
"id": "5130efc28989846a36000146",
"slug": "pandora",
"name": "Pandora Media",
"object_type": "company",
"location" : "Oakland, CA",
"icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efc28989846a36000146.ico"
}
}
Field | Type | Explanation |
---|---|---|
confidence | Float | measure of confidence in relatedness |
company | Company (basic) | basic version of company object |
Signal
{
"id": "5949deddc5de6bd638cac218",
"object_type": "signal",
"company": {
"id": "54536becdef752c62e0005a5",
"slug": "fourkites",
"name": "FourKites",
"url": "www.fourkites.com",
"location": "Chicago, IL",
"object_type": "company",
"icon_url": "//datafox-data.s3-us-west-1.amazonaws.com/favicons/54536becdef752c62e0005a5.ico"
},
"tag": "private-funding",
"date": "2016-10-12T00:00:00.000Z",
"sources": [
{
"id": "56b4e26d9c230b753403566a",
"object_type": "funding_round",
"round_code": "A",
"raised_amount": 13000000,
"currency_code": "USD",
"date": "2016-10-12T00:00:00.000Z",
"company": {
"id": "54536becdef752c62e0005a5",
"slug": "fourkites",
"name": "FourKites",
"url": "www.fourkites.com",
"location": "Chicago, IL",
"object_type": "company",
"icon_url": "//datafox-data.s3-us-west-1.amazonaws.com/favicons/54536becdef752c62e0005a5.ico"
},
"investments": [
{
"id": "59b3404e2bec96905f7f262e",
"company": {
"id": "558001e7753c9b6d18000170",
"slug": "otter",
"name": "Otter",
"url": "otter.sg",
"location": "Singapore, Singapore",
"object_type": "company",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/558001e7753c9b6d18000170.ico"
},
"object_type": "investment",
"money_invested_amount": null,
"currency_code": "USD"
},
{
"id": "59b3404e2bec96905f7f262d",
"company": {
"id": "51a1f5c7d6a57a57610f17f2",
"slug": "hyde-park-angels",
"name": "Hyde Park Angels",
"url": "hydeparkangels.com",
"location": "Chicago, IL",
"object_type": "company",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/51a1f5c7d6a57a57610f17f2.ico"
},
"object_type": "investment",
"money_invested_amount": null,
"currency_code": "USD"
},
{
"id": "59b3404e2bec96905f7f262c",
"company": {
"id": "53af4e40bf9923352a047902",
"slug": "hyde-park-venture-partners",
"name": "Hyde Park Venture Partners",
"url": "hydeparkvp.com",
"location": "Chicago, IL",
"object_type": "company",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/53af4e40bf9923352a047902.ico"
},
"object_type": "investment",
"money_invested_amount": null,
"currency_code": "USD"
},
{
"id": "59b3404e2bec96905f7f262b",
"company": {
"id": "51c6bacaa9812aa90b1283f3",
"slug": "bain-capital-ventures",
"name": "Bain Capital Ventures",
"url": "www.baincapitalventures.com",
"location": "Boston, MA",
"object_type": "company",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6bacaa9812aa90b1283f3.ico"
},
"object_type": "investment",
"money_invested_amount": null,
"currency_code": "USD"
}
]
},
{
"id": "580242824a75ab424a80f48b",
"object_type": "snippet",
"text": "Relief for shippers has finally come in the form of FourKites, a breakthrough platform for real-time shipment visibility, which today announced that it has raised $13 million in Series A funding led by Bain Capital Ventures.",
"company_tags": [
{
"object_type": "company_tag",
"company": "54536becdef752c62e0005a5",
"tag": "private-funding"
},
{
"object_type": "company_tag",
"company": "51c6bacaa9812aa90b1283f3",
"tag": "investment"
}
],
"article": {
"id": "57fe1a2179c645291f8735b3",
"object_type": "news",
"title": "FourKites Raises $13 Million to Enable \"Smart Trucking\" via Real-Time Logistics Connectivity for $700 Billion Transportation Industry",
"url": "http://www.marketwired.com/mw/release.do?id=2165776&sourceType=3",
"published": "2016-10-12T11:00:00.000Z",
"source": "Marketwired - Breaking News Releases"
}
}
]
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of signal object |
object_type | String | "signal" |
company | Company (Basic) | company signal belongs to |
tag | Signal Tag | signal tag |
date | Date | date of the signal |
sources | [Source] | array of sources |
Source is polymorphic and can be one of the following object types: News, Snippet (full), Acquisition, Funding Round, IPO, and Conference.
Signal Tag
A signal tag is a string that is part of the following enumeration:
List of Tags
joint-venture, market-share-growth, new-geography, new-initiative, new-patent, new-product, new-strategy, office-space-expansion, partnership, product-launch, regulatory, sales-growth, user-growth, customer-win, analyst-expectations, debt-financing, dividends, earnings, revenue, form-5500, investment, ipo-trading, ipo-s1, ipo-speculation, acquisition-acquirer, merger, ownership-change, private-funding, restructuring, form-10k, form-d, stock-performance, valuation, acquisition-acquiree, executive-publication, executive-quote, headcount-growth, job-posting, leadership-change, award, industry-list, industry-news, accelerator-participation, conference-exhibitor, marketing-activity, podcast, conference-presenter, conference-sponsorship, conference-attendee, video-presentation, corporate-purchase, name-change, outsourcing, real-estate-sale, relocation, reorganization, bankruptcy, competitive-challenge, customer-dissatisfaction, financial-challenge, industry-challenge, key-departure, layoff, legal-issue, regulatory-issue, security-challenge, turbulence, mention
Deprecated Tags
key-hire (now appearing as leadership-change), key-promotion (now appearing as leadership-change)
News
Full
{
"id": "56ac79e90c746a1f4a384034",
"object_type": "news",
"title": "Kanye West posts two nearly-new songs on Soundcloud",
"url": "http://www.theguardian.com/music/2015/oct/19/kanye-west-new-songs-soundcloud",
"published": "2015-10-19T22:25:59.000Z",
"source": "Guardian Unlimited Business",
"mentions": [
{
"id": "5130efd28989846a360027c6",
"slug": "soundcloud",
"name": "SoundCloud",
"object_type": "company",
"location" : "Berlin, Germany",
"icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efd28989846a360027c6.ico"
}
],
"snippets": [
{
"id": "56ac79e90c746a1f4a384037",
"object_type": "snippet",
"text": "Less than a month ago West told Vanity Fair that he was nowhere near to having his forthcoming album Swish, the follow-up to 2013's Yeezus, ready, but the two tracks emerged on a new Soundcloud account on Monday.",
"company_tags": [
{
"object_type": "company_tag",
"company": "5130efd28989846a360027c6",
"tag": "new-strategy"
}
]
},
{
"id": "56ac79e90c746a1f4a384035",
"object_type": "snippet",
"text": "Whether fans will be able to glean anything about a new direction from a remix and a cover, but West embracing Soundcloud and launching surprise releases is an exciting prospect from an artist whose focus has been elsewhere recently.",
"company_tags": [
{
"object_type": "company_tag",
"company": "5130efd28989846a360027c6",
"tag": "partnership"
}
]
}
]
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of news item |
object_type | String | "news" |
title | Integer | title of article |
url | String | original url of the article |
published | Date | date the article was published |
source | String | name of publication |
mentions | [Company (basic)] | companies mentioned in the article |
snippets | [Snippet (basic)] | highlighted parts of the article |
Basic
{
"id": "56ac79e90c746a1f4a384034",
"object_type": "news",
"title": "Kanye West posts two nearly-new songs on Soundcloud",
"url": "http://www.theguardian.com/music/2015/oct/19/kanye-west-new-songs-soundcloud",
"published": "2015-10-19T22:25:59.000Z",
"source": "Guardian Unlimited Business"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of news item |
object_type | String | "news" |
title | Integer | title of article |
url | String | original url of the article |
published | Date | date the article was published |
source | String | name of publication |
Snippet
Full
{
"id": "580242824a75ab424a80f48b",
"object_type": "snippet",
"text": "Relief for shippers has finally come in the form of FourKites, a breakthrough platform for real-time shipment visibility, which today announced that it has raised $13 million in Series A funding led by Bain Capital Ventures.",
"company_tags": [
{
"object_type": "company_tag",
"company": "54536becdef752c62e0005a5",
"tag": "private-funding"
},
{
"object_type": "company_tag",
"company": "51c6bacaa9812aa90b1283f3",
"tag": "investment"
}
],
"article": {
"id": "57fe1a2179c645291f8735b3",
"object_type": "news",
"title": "FourKites Raises $13 Million to Enable \"Smart Trucking\" via Real-Time Logistics Connectivity for $700 Billion Transportation Industry",
"url": "http://www.marketwired.com/mw/release.do?id=2165776&sourceType=3",
"published": "2016-10-12T11:00:00.000Z",
"source": "Marketwired - Breaking News Releases"
}
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of the snippet |
object_type | String | "snippet" |
text | String | highlighted part of an article |
company_tags | [Company Tag] | pairs of companies and tags |
article | News (basic) | the source article for the snippet |
Basic
{
"id": "56fe32e87a4bd1a1065ad24d",
"object_type": "snippet",
"text": "SoundCloud has launched a new $9.99-a-month subscription service this week, as it looks to take advantage of the growing number of people subscribing to music streaming services.",
"company_tags": [
{
"object_type": "company_tag",
"company": "5130efd28989846a360027c6",
"tag": "new-product"
}
]
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of the snippet |
object_type | String | "snippet" |
text | String | highlighted part of an article |
tags | [Signal Tag] | represent the type of signal |
company_tags | [Company Tag] | pairs of companies and tags |
Company Tag
{
"object_type": "company_tag",
"company": "54536becdef752c62e0005a5",
"tag": "private-funding"
}
Field | Type | Explanation |
---|---|---|
object_type | String | "company_tag" |
company | ID | company ID |
tag | Signal Tag | represent the type of signal |
Conference
{
"id": "582f7500a03b29c76b2d9a0a",
"object_type": "conference",
"name": "SXSW 2017",
"slug": "sxsw-2017",
"start_date": "2017-03-10T00:00:00.000Z",
"end_date": "2017-03-19T00:00:00.000Z",
"description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
"short_description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
"sector": "Media & Entertainment",
"url": "www.sxsw.com/",
"registration_url": "cart.sxsw.com/?_ga=1.79086484.186073030.1479435740",
"screenshot_url": "//datafox-data.s3-us-west-1.amazonaws.com/images/conference_582f7500a03b29c76b2d9a0a",
"city": "Austin",
"state": "TX",
"street1": null,
"street2": null,
"zipcode": null,
"country": "US",
"participant_lists": [
{
"id": "58342e9348be2f9a570d7df8",
"participation_type": "Speakers"
},
{
"id": "58342e9948be2f9a570d86e3",
"participation_type": "Sponsors"
},
{
"id": "58342e9948be2f9a570d8711",
"participation_type": "Partners"
},
{
"id": "58aafd884cdd4bfc2fe14a04",
"participation_type": "Exhibitors"
},
{
"id": "58aafd894cdd4bfc2fe14b3a",
"participation_type": "Participants"
}
]
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of conference object |
object_type | String | "conference" |
name | String | name of the conference |
slug | String | conference slug |
start_date | Date | date the conference starts |
end_date | Date | date the conference ends |
description | String | description of the conference |
short_description | String | short description of the conference |
sector | String | sector the conference belongs to |
url | String | conference’s main URL |
registration_url | String | conference’s registration URL |
screenshot_url | String | URL to conference website screenshot |
city | String | city the conference takes place in |
state | String | state the conference takes place in |
street1 | String | street address for conference |
street2 | String | street address for conference |
zipcode | String | zipcode for conference |
country | String | country the conference takes place in |
participant_lists | [Participant List] | array of participant lists |
Participant List
{
"id": "58342e9348be2f9a570d7df8",
"object_type": "participant_list",
"participation_type": "Speakers"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of conference object |
object_type | String | "participant_list" |
participation_type | String | the type of participant list |
List
{
"id": "0ba3a0ffd1b6dfea8d71ad40",
"object_type": "list",
"name": "Unicorns",
"slug": "unicorns",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Datåa",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2015-03-14T16:26:53.589Z",
"modified_at": "2015-10-11T13:15:13.819Z",
"is_public": false,
"num_followers": 1,
"num_companies": 42,
"num_collaborators": 3,
"acting_user_is_following": true,
"acting_user_is_collaborator": true,
"acting_user_is_owner": true,
"is_shared_with_team": false
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of list |
object_type | String | "list" |
name | String | name of list |
slug | String | slug for list |
owner | User | owner of list |
created_at | Date | date list was created |
modified_at | Date | date list was last modified |
is_public | Boolean | whether the list is public |
num_followers | Integer | number of users following the list |
num_companies | Integer | number of companies in the list |
num_collaborators | Integer | number of collaborators on the list |
acting_user_is_following | Boolean | whether the current user is following the list |
acting_user_is_collaborator | Boolean | whether the current user is a collaborator on the list |
acting_user_is_owner | Boolean | whether the current user is the owner of the list |
is_shared_with_team | Boolean | whether the list is shared within the owner’s team |
Dynamic List
{
"id": "599f1891460cc86b9ae5e88d",
"object_type": "dynamic_list",
"name": "Target Cybersecurity Bay Area Opportunities",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2016-04-12T00:05:44.022Z",
"modified_at": "2016-10-17T21:46:04.105Z"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of dynamic list |
object_type | String | "dynamic_list" |
name | String | name of dynamic list |
owner | User | owner of list |
created_at | Date | date dynamic list was created |
modified_at | Date | date dynamic list itself was last modified, not the date companies were last to the list |
Dynamic List Company
{
"object_type": "dynamic_list_company",
"dynamic_list_id": "599f1891460cc86b9ae5e88d",
"company": {
"id": "51c6b9a5a9812aa90b123980",
"object_type": "company",
"name": "DataFox",
"slug": "datafox",
"url": "datafox.com",
"location": "San Francisco, CA",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
},
"date_added": "2017-08-24T08:11:04.469Z"
}
Field | Type | Explanation |
---|---|---|
object_type | String | "dynamic_list" |
dynamic_list_id | ID | ID of dynamic list company is in |
company | Company (basic) | company in dynamic list |
date_added | Date | date company was added to dynamic list |
Error
{
"object_type": "error",
"status_code": 400,
"error_code": "bad_request",
"request_id": "5ad15d06-0eed-4861-9690-bee87f4d4efd",
"details": []
}
Field | Type | Explanation |
---|---|---|
object_type | String | "error" |
status_code | Integer | status code for error |
error_code | String | error code for error |
request_id | String | unique identifier for request - helpful for support |
details | [Object] | array of details, each element of which has the key text |
Account Score
{
"id": "5c9317768e2dc51d0479d590",
"object_type": "account_score",
"score": 220,
"tier": "Tier 2",
"last_updated_date": "2019-09-04T06:59:33.293Z",
"last_modified_date": "2019-03-21T04:47:50.956Z",
"account_scoring_criteria": [
{
"criterion": {
"id": "5c92fd9c8e2dc51d04798a76",
"object_type": "account_scoring_criterion",
"name": "Headcount: 50 - 2k",
"weight": 50
}
},
{
"criterion": {
"id": "5c92fd9c8e2dc51d04798a77",
"object_type": "account_scoring_criterion",
"name": "Keyword: b2b, saas, software, manufacturing",
"weight": 50
}
},
{
"criterion": {
"id": "5c930cc68e2dc51d04798a78",
"object_type": "account_scoring_criterion",
"name": "Industry Categories: Information Technology",
"weight": 50
}
},
{
"criterion": {
"id": "5c9313908e2dc51d04798a7c",
"object_type": "account_scoring_criterion",
"name": "Technographics: HubSpot OR Marketo OR Eloqua",
"weight": 50
}
},
{
"criterion": {
"id": "5c9316578e2dc51d04798a7f",
"object_type": "account_scoring_criterion",
"name": "Conference: SaaStr Annual 2018",
"weight": 20
}
}
]
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of account score |
object_type | String | "account_score" |
score | Float | account score of this company |
tier | String | tier this company’s account score falls under Note: Response does not include this field if score is below tier threshold. |
last_updated_date | Date | date that this company’s account score was last calculated Note: The score may not have changed since the last calculation. |
last_modified_date | Date | date that this company’s account score was last changed |
account_scoring_criteria | [Account Scoring Criterion] | array of Account Scoring criteria |
Account Scoring Criterion
{
"id": "5c90320acb144c8b782c492e",
"object_type": "account_scoring_criterion",
"name": "Industry Categories: Information Technology",
"weight": "20"
}
Field | Type | Explanation |
---|---|---|
id | ID | ID of account scoring criterion |
object_type | String | "account_scoring_criterion" |
name | String | Name of custom Account Scoring criterion matched by this company |
weight | Float | Value assigned to this matched Account Scoring criterion |
Companies
Retrieve
This endpoint allows you to get basic information on a particular company.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/companies/51c6b9a5a9812aa90b123980
JSON Response:
{
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
}
HTTP Endpoint
https://api.datafox.com/2.0/companies/:id
Response
Company
List
This endpoint allows you to get companies based upon IDs, name, URL, list, or date updated.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/companies\?url\=datafox.co
JSON Response:
{
"total_count": 1,
"entries": [
{
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/companies
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
ids | String | Comma-separated list of company ids (maximum is 100) | |
url | String | The URL to search on | |
name | String | The name of the company | |
last_modified_date_after | Date | The date the company was last modified (after or equal). | |
last_modified_date_before | Date | Combine with last_modified_date_after to filter between a range. | |
fields | String | Comma-separated list of fields to format [Company] entries with | |
offset | Integer | 0 | Number of results to skip |
limit | Integer | 10 | Number of results to show (maximum is 100) |
Response
Field | Type |
---|---|
total_count | Integer |
entries | [Company] (basic or with selected fields) |
Details
This endpoint allows you to get more detailed information on a particular company.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/companies/51c6b9a5a9812aa90b123980/details
JSON Response:
{
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"legal_name": "Oracle",
"naics_code": null,
"naics_code_description": null,
"ein": null,
"founded_year": null,
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z",
"status": "acquired",
"ceo_name": "Bastiaan Janmaat",
"description": "DataFox is a company intelligence platform that helps sales, marketing, and investing teams find and prioritize target companies to source more opportunities. DataFox's team of 100+ human analysts verify AI-sourced insights on millions of businesses to provide robust Company Data, Growth Signals, and Account Scoring. Headquartered in San Francisco, CA, DataFox is backed by Goldman Sachs, Green Visor, Google Ventures, and Slack, and used by high-growth startups and Fortune 500 companies alike; examples include UPS, Accel Partners, Bain & Company, Twilio, Zendesk, and Outreach.",
"street1": "475 Sansome St",
"street2": "12th fl",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zipcode": "94111",
"top_keywords": [
"software and technical consulting",
"software",
"crm orchestration",
"company intelligence",
"marketing teams"
],
"revenue_estimate": 9500000,
"number_of_employees": 48,
"angellist_slug": "datafox",
"crunchbase_permalink": "datafox",
"linkedin_id": 3231060,
"twitter_handle": "datafoxco",
"blog_url": "http://datafox.com/blog",
"industry_code": "industry_055",
"industry_name": "Information Technology",
"subindustry_code": "subindustry_382",
"subindustry_name": "Enterprise Software"
}
HTTP Endpoint
https://api.datafox.com/2.0/companies/:id/details
Response
Company
(full)
Account Score
This endpoint allows you to get the Account Score for any company enabling you to prioritize your accounts. You must set up your Account Scoring criteria in the DataFox application. This may require an account upgrade for this feature.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/companies/51c6b9a5a9812aa90b123980/account-score
JSON Response:
{
"id": "5c9317768e2dc51d0479d590",
"object_type": "account_score",
"score": 270,
"tier": "Tier 2",
"last_updated_date": "2020-12-09T16:18:58.562Z",
"last_modified_date": "2020-05-24T05:38:38.766Z",
"account_scoring_criteria": [
{
"criterion": {
"id": "5c92fd9c8e2dc51d04798a76",
"object_type": "account_scoring_criterion",
"name": "Headcount: 50 - 2k",
"weight": 50
}
},
{
"criterion": {
"id": "5c92fd9c8e2dc51d04798a77",
"object_type": "account_scoring_criterion",
"name": "Keyword: b2b, saas, software, manufacturing",
"weight": 50
}
},
{
"criterion": {
"id": "5c930cc68e2dc51d04798a78",
"object_type": "account_scoring_criterion",
"name": "Industry Categories: Information Technology",
"weight": 50
}
},
{
"criterion": {
"id": "5c93138a8e2dc51d04798a7b",
"object_type": "account_scoring_criterion",
"name": "Technographics: Oracle Cloud",
"weight": 50
}
},
{
"criterion": {
"id": "5c9313908e2dc51d04798a7c",
"object_type": "account_scoring_criterion",
"name": "Technographics: HubSpot OR Marketo OR Eloqua",
"weight": 50
}
},
{
"criterion": {
"id": "5c9316578e2dc51d04798a7f",
"object_type": "account_scoring_criterion",
"name": "Conference: SaaStr Annual 2018",
"weight": 20
}
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/companies/:id/account-score
Response
Account Score
Matching
Company Match
This endpoint allows you to match to a DataFox company from the company information that you have. It supports querying by name or URL and also allows refining by location parameters.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/match/companies\?name\=DataFox
JSON Response:
{
"matches": [
{
"confidence": 0.9525741268224334,
"company": {
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
}
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/match/companies
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
name | String | The name to match against | |
url | String | The URL to match against | |
street1 | String | Street part of address | |
street2 | String | Second street part of address | |
city | String | City of company | |
state | String | State of company | |
country | String | Country of company | |
zipcode | String | Zipcode of company | |
limit | Integer | 1 | Number of match results to show (maximum is 10) |
Response
Field | Type |
---|---|
matches | [MatchCompany] |
Bulk Company Match
This endpoint allows you to match multiple companies to DataFox companies in one request. The query must be provided in the body of the request.
curl --request POST \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/match/companies \
--header "Content-Type: application/json" \
--data '{"limit": 2, "queries": [{"name": "DataFox"}, {"url": "pagerduty.com"}]}' \
JSON Response:
{
"results": [
{
"matches": [
{
"confidence": 0.9525741268224334,
"company": {
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
}
},
{
"confidence": 0.5498339973124778,
"company": {
"object_type": "company",
"id": "58bdb116d547dd447ac8aeac",
"slug": "datafox-srl",
"name": "DataFox srl",
"url": "www.datafox.it",
"location": "Fatsa, Turkey",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/58bdb116d547dd447ac8aeac.ico",
"last_modified_date": "2020-09-12T23:21:52.066Z"
}
}
]
},
{
"matches": [
{
"confidence": 0.9308615796566531,
"company": {
"object_type": "company",
"id": "5130f00a8989846a3600d870",
"slug": "pagerduty",
"name": "PagerDuty",
"url": "pagerduty.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130f00a8989846a3600d870.ico",
"last_modified_date": "2020-11-21T03:35:47.463Z"
}
}
]
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/match/companies
Query Structure
{"limit": limit, "queries": [Match Query]}
where the limit, as above, is the number of desired match results to show. It defaults to 1 and has a maximum of 10.
Match Query Parameters
These are the same parameters as the query parameters for the single matching endpoint.
Parameter | Type | Default | Description |
---|---|---|---|
name | String | The name to match against | |
url | String | The URL to match against | |
street1 | String | Street part of address | |
street2 | String | Second street part of address | |
city | String | City of company | |
state | String | State of company | |
country | String | Country of company | |
zipcode | String | Zipcode of company |
Response Structure
{"results": [{"matches": [MatchCompany]}]}
People Match to Companies
This endpoint allows you to match a person (e.g. lead) to one or more DataFox companies based on the person’s contact and company information that you have. It supports querying by email, company name, and company URL.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/match/people-to-companies\?email\=someone@datafox.com\&company_name=datafox\&company_url=datafox.com
JSON Response:
{
"matches": [
{
"confidence": 0.99,
"company": {
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
}
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/match/people-to-companies
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
String | Person’s email to match against | ||
company_name | String | The company name to match against | |
company_url | String | The company URL to match against | |
limit | Integer | 1 | Number of match results to show (maximum is 10) |
Response
Field | Type |
---|---|
matches | [MatchCompany] |
Bulk People Match to Companies
This endpoint allows you to match multiple people to DataFox companies in one request. The queries must be provided in the body of the request.
curl --request POST \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/match/people-to-companies \
--header "Content-Type: application/json" \
--data '{"limit": 2, "queries": [{"company_name": "DataFox"}, {"company_url": "pagerduty.com"}]}' \
JSON Response:
{
"results": [
{
"matches": [
{
"confidence": 0.9525741268224334,
"company": {
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
}
},
{
"confidence": 0.5498339973124778,
"company": {
"object_type": "company",
"id": "58bdb116d547dd447ac8aeac",
"slug": "datafox-srl",
"name": "DataFox srl",
"url": "www.datafox.it",
"location": "Fatsa, Turkey",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/58bdb116d547dd447ac8aeac.ico",
"last_modified_date": "2020-09-12T23:21:52.066Z"
}
}
]
},
{
"matches": [
{
"confidence": 0.9308615796566531,
"company": {
"object_type": "company",
"id": "5130f00a8989846a3600d870",
"slug": "pagerduty",
"name": "PagerDuty",
"url": "pagerduty.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130f00a8989846a3600d870.ico",
"last_modified_date": "2020-11-21T03:35:47.463Z"
}
}
]
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/match/people-to-companies
Query Structure
{"limit": limit, "queries": [Person Match Query]}
where the limit, as above, is the number of desired match results to show. It defaults to 1 and has a maximum of 10.
Person Match Query Parameters
These are the same parameters as the query parameters for the single matching endpoint.
Parameter | Type | Default | Description |
---|---|---|---|
String | Person’s email to match against | ||
company_name | String | The company name to match against | |
company_url | String | The company URL to match against | |
limit | Integer | 1 | Number of match results to show (maximum is 10) |
Response Structure
{"results": [{"matches": [MatchCompany]}]}
Similar Companies
List
This endpoint allows you to get related companies for a particular company.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
"https://api.datafox.com/2.0/similar-companies?company=51c6b9a5a9812aa90b123980"
JSON Response:
{
"total_count": 10,
"entries": [
{
"confidence": 0.5639174226285482,
"company": {
"object_type": "company",
"id": "51c6b7b2a9812aa90b11d27d",
"slug": "mattermark",
"name": "Mattermark",
"url": "mattermark.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b7b2a9812aa90b11d27d.ico",
"last_modified_date": "2020-05-12T17:22:30.664Z"
}
},
{
"confidence": 0.5073147064979667,
"company": {
"object_type": "company",
"id": "51f4e687f7cd59a178137c26",
"slug": "cb-insights",
"name": "CB Insights",
"url": "cbinsights.com",
"location": "New York, NY",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51f4e687f7cd59a178137c26.ico",
"last_modified_date": "2020-06-06T05:16:36.279Z"
}
},
{
"confidence": 0.3978382219447399,
"company": {
"object_type": "company",
"id": "5130f0398989846a3601723a",
"slug": "quid",
"name": "Quid",
"url": "quid.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130f0398989846a3601723a.ico",
"last_modified_date": "2020-09-19T02:29:22.523Z"
}
},
{
"confidence": 0.2846154464595723,
"company": {
"object_type": "company",
"id": "5130efd48989846a36002fac",
"slug": "bloomberg",
"name": "Bloomberg",
"url": "bloomberg.com",
"location": "New York, NY",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130efd48989846a36002fac.ico",
"last_modified_date": "2020-08-01T10:26:59.306Z"
}
},
{
"confidence": 0.2833930466575534,
"company": {
"object_type": "company",
"id": "5130efcd8989846a360019e2",
"slug": "s-p-capital-iq-1",
"name": "S&P Capital IQ",
"url": "www.capitaliq.com",
"location": "New York, NY",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130efcd8989846a360019e2.ico",
"last_modified_date": "2020-03-15T00:00:55.714Z"
}
},
{
"confidence": 0.22684437311378905,
"company": {
"object_type": "company",
"id": "5130f0c58989846a360371ec",
"slug": "crunchbase",
"name": "Crunchbase",
"url": "www.crunchbase.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130f0c58989846a360371ec.ico",
"last_modified_date": "2020-09-09T15:06:58.501Z"
}
},
{
"confidence": 0.18538803696908698,
"company": {
"object_type": "company",
"id": "5130efc28989846a3600008e",
"slug": "google-llc",
"name": "Google",
"url": "google.com",
"location": "Mountain View, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130efc28989846a3600008e.ico",
"last_modified_date": "2020-05-05T20:57:45.366Z"
}
},
{
"confidence": 0.17237070699736376,
"company": {
"object_type": "company",
"id": "5130efd88989846a36003bc6",
"slug": "thomson-reuters",
"name": "Thomson Reuters",
"url": "www.thomsonreuters.com",
"location": "Toronto, Canada",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130efd88989846a36003bc6.ico",
"last_modified_date": "2020-05-03T16:41:43.258Z"
}
},
{
"confidence": 0.16426611752390127,
"company": {
"object_type": "company",
"id": "535156477602002c1c088be9",
"slug": "disruption-corp",
"name": "Disruption Corp",
"url": "disruption.vc",
"location": "Arlington, VA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/535156477602002c1c088be9.ico",
"last_modified_date": "2020-07-25T07:04:34.960Z"
}
},
{
"confidence": 0.11661710755849686,
"company": {
"object_type": "company",
"id": "5130f0008989846a3600bacc",
"slug": "ihs-markit-1",
"name": "IHS Markit",
"url": "www.ihsmarkit.com",
"location": "London, United Kingdom",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130f0008989846a3600bacc.ico",
"last_modified_date": "2020-11-18T09:28:56.213Z"
}
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/similar-companies
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
company | ID | Which company to query for similar companies |
Response
Field | Type |
---|---|
total_count | Integer |
entries | [SimilarCompany] |
Signals
Access Oracle DataFox company signals across categories such as growth, finance, and more. A given signal consists of a DataFox company, a signal tag, the signal date, and the backing sources. See the available Signal Tags for a full list of possible tags. There can be multiple sources for a given signal, spanning multiple object types. For more information on the types of signals, see Signal Types
Retrieve
This endpoint allows you to get information on a particular signal.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
"https://api.datafox.com/2.0/signals/5994f2526403c15c74bc2725"
JSON Response:
{
"id": "5994f2526403c15c74bc2725",
"object_type": "signal",
"company": {
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
},
"tag": "marketing-activity",
"date": "2017-08-17T00:04:47.000Z",
"sources": [
{
"id": "5994f24e4b1e59d92e666617",
"object_type": "snippet",
"text": "DataFox today announced it has launched DataFox Company Intelligence & CRM Orchestration on the Salesforce AppExchange, empowering businesses to connect with their customers, partners and employees in entirely new ways.",
"company_tags": [
{
"object_type": "company_tag",
"company": "51c6b9a5a9812aa90b123980",
"tag": "marketing-activity"
},
{
"object_type": "company_tag",
"company": "58f414e63b65109960b6ef81",
"tag": "marketing-activity"
}
],
"article": {
"id": "5994dee6b9543b5c7928c9dd",
"object_type": "news",
"title": "DataFox Announces DataFox Company Intelligence & CRM Orchestration on the Salesforce AppExchange, the World's Leading Enterprise Apps Marketplace",
"url": "http://www.pressreleaserocket.net/datafox-announces-datafox-company-intelligence-crm-orchestration-on-the-salesforce-appexchange-the-worlds-leading-enterprise-apps-marketplace-2/585576/",
"published": "2017-08-17T00:04:47.000Z",
"source": "Press Release Rocket"
}
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/signals/:id
Response
Signal
List
This endpoint allows you to get signals for companies.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
"https://api.datafox.com/2.0/signals?companies=51c6b9a5a9812aa90b123980&limit=1&after=2017-08-17&sort=asc"
JSON Response:
{
"total_count": 93,
"entries": [
{
"id": "5ecddfe9c32e940100c58a45",
"object_type": "signal",
"company": {
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
},
"tag": "mention",
"date": "2019-06-17T13:15:01.000Z",
"sources": [
{
"id": "5ecddfcb67d54801006de53a",
"object_type": "news",
"title": "Oracle (ORCL) to Report Q4 Earnings: What's in the Offing?",
"url": "https://finance.yahoo.com/news/oracle-orcl-report-q4-earnings-131501030.html?.tsrc=rss",
"published": "2019-06-17T13:15:01.000Z",
"source": "Yahoo! Finance - PGR News",
"mentions": [
{
"object_type": "company",
"id": "5130efc98989846a3600107a",
"slug": "oracle",
"name": "Oracle",
"url": "www.oracle.com",
"location": "Redwood City, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130efc98989846a3600107a.ico",
"last_modified_date": "2020-10-08T22:37:20.447Z"
},
{
"object_type": "company",
"id": "51c6b9a5a9812aa90b123980",
"slug": "datafox",
"name": "DataFox",
"url": "www.datafox.com",
"location": "San Francisco, CA",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/51c6b9a5a9812aa90b123980.ico",
"last_modified_date": "2020-05-16T16:30:40.268Z"
},
{
"object_type": "company",
"id": "5130f00e8989846a3600eb1e",
"slug": "grapeshot",
"name": "Grapeshot",
"url": "www.grapeshot.com",
"location": "Cambridge, United Kingdom",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130f00e8989846a3600eb1e.ico",
"last_modified_date": "2020-10-31T06:25:43.233Z"
}
],
"snippets": [
]
}
]
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/signals
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
companies | String | Comma-separated list of company ids (maximum is 10) | |
tags | String | all tags | Comma-separated list of Signal Tags |
offset | Integer | 0 | Number of signals to skip |
limit | Integer | 10 | Number of signals to receive |
after | Date | Date threshold to limit signal recency | |
before | Date | Date threshold to limit signal recency | |
sort_direction | String | desc | Sort direction (“asc” or “desc”) |
Response
Field | Type |
---|---|
total_count | Integer |
entries | [Signal] |
Conferences
Retrieve
This endpoint allows you to get information on a particular conference.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/conferences/582f7500a03b29c76b2d9a0a
JSON Response:
{
"id": "582f7500a03b29c76b2d9a0a",
"object_type": "conference",
"name": "South by Southwest (SXSW) 2017",
"slug": "sxsw-2017",
"start_date": "2017-03-10T00:00:00.000Z",
"end_date": "2017-03-19T00:00:00.000Z",
"description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
"short_description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
"sector": "Media & Entertainment",
"url": "www.sxsw.com/",
"registration_url": "cart.sxsw.com/?_ga=1.79086484.186073030.1479435740",
"screenshot_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/images/conference_fd50ace7-e39d-4675-83b7-78dc394cb47b",
"city": "Austin",
"state": "TX",
"street1": null,
"street2": null,
"zipcode": null,
"country": "US",
"participant_lists": [
{
"id": "58342e9348be2f9a570d7df8",
"object_type": "participant_list",
"participation_type": "Speakers"
},
{
"id": "58342e9948be2f9a570d86e3",
"object_type": "participant_list",
"participation_type": "Sponsors"
},
{
"id": "58342e9948be2f9a570d8711",
"object_type": "participant_list",
"participation_type": "Partners"
},
{
"id": "58aafd884cdd4bfc2fe14a04",
"object_type": "participant_list",
"participation_type": "Exhibitors"
},
{
"id": "58aafd894cdd4bfc2fe14b3a",
"object_type": "participant_list",
"participation_type": "Participants"
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/conferences/:id
Response
Conference
List
This endpoint allows you to get conferences by ids, name, and/or date.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/conferences\?name\=SXSW\&starts_after=2017-01-01\&ends_before=2018-01-01
JSON Response:
{
"total_count": 1,
"entries": [
{
"id": "582f7500a03b29c76b2d9a0a",
"object_type": "conference",
"name": "South by Southwest (SXSW) 2017",
"slug": "sxsw-2017",
"start_date": "2017-03-10T00:00:00.000Z",
"end_date": "2017-03-19T00:00:00.000Z",
"description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
"short_description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
"sector": "Media & Entertainment",
"url": "www.sxsw.com/",
"registration_url": "cart.sxsw.com/?_ga=1.79086484.186073030.1479435740",
"screenshot_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/images/conference_fd50ace7-e39d-4675-83b7-78dc394cb47b",
"city": "Austin",
"state": "TX",
"street1": null,
"street2": null,
"zipcode": null,
"country": "US",
"participant_lists": [
{
"id": "58342e9348be2f9a570d7df8",
"object_type": "participant_list",
"participation_type": "Speakers"
},
{
"id": "58342e9948be2f9a570d86e3",
"object_type": "participant_list",
"participation_type": "Sponsors"
},
{
"id": "58342e9948be2f9a570d8711",
"object_type": "participant_list",
"participation_type": "Partners"
},
{
"id": "58aafd884cdd4bfc2fe14a04",
"object_type": "participant_list",
"participation_type": "Exhibitors"
},
{
"id": "58aafd894cdd4bfc2fe14b3a",
"object_type": "participant_list",
"participation_type": "Participants"
}
]
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/conferences
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
ids | String | Comma-separated list of conference ids (maximum is 100) | |
name | String | The name of the conference | |
company | ID | Search conferences attended by this company | |
starts_after | Date | Date threshold for the conference to start after | |
ends_before | Date | Date threshold for the conference to end before | |
offset | Integer | 0 | Number of results to skip |
limit | Integer | 10 | Number of results to show (maximum is 100) |
Response
Field | Type |
---|---|
total_count | Integer |
entries | [Conference] |
Participant Lists
This endpoint allows you to retrieve the companies in a given participant list for a conference.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/conferences/582f7500a03b29c76b2d9a0a/participant-lists/58aafd884cdd4bfc2fe14a04\?offset=0\&limit=1
JSON Response:
{
"total_count": 308,
"entries": [
{
"object_type": "company",
"id": "5130efc38989846a360001a8",
"slug": "scripps-networks-interactive",
"name": "Scripps Networks Interactive",
"url": "www.scrippsnetworks.com",
"location": "Knoxville, TN",
"icon_url": "//axdprrulpfmh.compat.objectstorage.us-phoenix-1.oraclecloud.com/datafox-public-prod/favicons/5130efc38989846a360001a8.ico",
"last_modified_date": "2020-05-16T04:30:41.812Z"
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/conferences/:conference_id/participant-lists/:participant-list-id
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
offset | Integer | 0 | Number of results to skip |
limit | Integer | 10 | Number of results to show (maximum is 100) |
Response
Field | Type |
---|---|
total_count | Integer |
entries | [Company] (basic) |
Lists
Create
curl --request POST \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"name": "My New List"}' \
https://api.datafox.com/2.0/lists
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"object_type": "list",
"name": "My Example List",
"slug": "my-example-list",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2015-03-14T16:26:53.589Z",
"modified_at": "2015-03-14T16:26:53.589Z",
"is_public": false,
"num_followers": 1,
"num_companies": 0,
"num_collaborators": 0,
"acting_user_is_following": true,
"acting_user_is_collaborator": false,
"acting_user_is_owner": true,
"is_shared_with_team": false
}
HTTP Endpoint
https://api.datafox.com/2.0/lists
Response
List
Retrieve
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"object_type": "list",
"name": "My Example List",
"slug": "my-example-list",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2015-03-14T16:26:53.589Z",
"modified_at": "2015-03-14T16:26:53.589Z",
"is_public": false,
"num_followers": 1,
"num_companies": 0,
"num_collaborators": 0,
"acting_user_is_following": true,
"acting_user_is_collaborator": false,
"acting_user_is_owner": true,
"is_shared_with_team": false
}
HTTP Endpoint
https://api.datafox.com/2.0/lists/:id
Response
List
Update
curl --request PUT \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"is_public": true}' \
https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"object_type": "list",
"name": "My Example List",
"slug": "my-example-list",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2015-03-14T16:26:53.589Z",
"modified_at": "2015-03-14T16:36:53.589Z",
"is_public": true,
"num_followers": 1,
"num_companies": 0,
"num_collaborators": 0,
"acting_user_is_following": true,
"acting_user_is_collaborator": false,
"acting_user_is_owner": true,
"is_shared_with_team": false
}
HTTP Endpoint
https://api.datafox.com/2.0/lists/:id
Response
List
Delete
curl --request DELETE \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"deleted": true
}
HTTP Endpoint
https://api.datafox.com/2.0/lists/:id
Response
Field | Type |
---|---|
id | ID |
deleted | Boolean |
List
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/lists
JSON Response:
{
"count": 2,
"entries": [
{
"id": "561d4b599ae49efd0500002d",
"object_type": "list",
"name": "My Example List",
"slug": "my-example-list",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2015-03-14T16:26:53.589Z",
"modified_at": "2015-03-14T16:36:53.589Z",
"is_public": false,
"num_followers": 1,
"num_companies": 0,
"num_collaborators": 0,
"acting_user_is_following": true,
"acting_user_is_collaborator": false,
"acting_user_is_owner": true,
"is_shared_with_team": false
}, {
"id": "751d639483d98a6fe2e682ca",
"object_type": "list",
"name": "Another Example List",
"slug": "another-example-list",
"owner": {
"id": "d2603610a584c5d5ed375ed9",
"object_type": "user",
"slug": "foxy-data",
"first_name": "Foxy",
"last_name": "Data",
"team_id": "993030d175609a0e7e5fc7c9"
},
"created_at": "2013-02-13T20:40:16.944Z",
"modified_at": "2015-10-10T07:12:45.811Z",
"is_public": false,
"num_followers": 2,
"num_companies": 42,
"num_collaborators": 0,
"acting_user_is_following": false,
"acting_user_is_collaborator": true,
"acting_user_is_owner": false,
"is_shared_with_team": false
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/lists
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
sort | String | created_at | What to sort on (“created_at” or “updated_at”) |
sort_direction | String | desc | Sort direction (“asc” or “desc”) |
Response
Field | Type |
---|---|
count | Integer |
entries | [List] |
Add Companies
curl --request POST \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"companies": ["51c6b9a5a9812aa90b123980"]}' \
https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d/companies
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"object_type": "list",
"name": "My Example List",
"slug": "my-example-list",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2015-03-14T16:26:53.589Z",
"modified_at": "2015-03-14T16:46:53.589Z",
"is_public": true,
"num_followers": 1,
"num_companies": 1,
"num_collaborators": 0,
"acting_user_is_following": true,
"acting_user_is_collaborator": false,
"acting_user_is_owner": true,
"is_shared_with_team": false
}
HTTP Endpoint
https://api.datafox.com/2.0/lists/:id/companies
Form Values
Parameter | Type | Description |
---|---|---|
companies | [String] | Array of company ids to add to list |
Remove Companies
curl --request DELETE \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"companies": ["51c6b9a5a9812aa90b123980"]}' \
https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d/companies
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"object_type": "list",
"name": "My Example List",
"slug": "my-example-list",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2015-03-14T16:26:53.589Z",
"modified_at": "2015-03-14T16:46:53.589Z",
"is_public": true,
"num_followers": 1,
"num_companies": 0,
"num_collaborators": 0,
"acting_user_is_following": true,
"acting_user_is_collaborator": false,
"acting_user_is_owner": true,
"is_shared_with_team": false
}
HTTP Endpoint
https://api.datafox.com/2.0/lists/:id/companies
Form Values
Parameter | Type | Description |
---|---|---|
companies | [String] | Array of company ids to remove from the list |
Dynamic Lists
Retrieve
Retrieves a specific dynamic list.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/dynamic-lists/599f1891460cc86b9ae5e88d
JSON Response:
{
"id": "599f1891460cc86b9ae5e88d",
"object_type": "dynamic_list",
"name": "Target Cybersecurity Bay Area Opportunities",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2016-04-12T00:05:44.022Z",
"modified_at": "2016-10-17T21:46:04.105Z"
}
HTTP Endpoint
https://api.datafox.com/2.0/dynamic-lists/:id
Response
Dynamic List
List
Lists the dynamic lists available to the authenticated user.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/dynamic-lists?limit=1
JSON Response:
{
"total_count": 2,
"entries": [
{
"id": "599f1891460cc86b9ae5e88d",
"object_type": "dynamic_list",
"name": "Target Cybersecurity Bay Area Opportunities",
"owner": {
"id": "ccb2d9e21b41b0ffe0193dbd",
"object_type": "user",
"slug": "data-fox",
"first_name": "Data",
"last_name": "Fox",
"team_id": "3e3e613c30ebc7f60e3a8d72"
},
"created_at": "2016-04-12T00:05:44.022Z",
"modified_at": "2016-10-17T21:46:04.105Z"
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/dynamic-lists
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
ids | String | 0 | Comma-separated list of dynamic list ids (maximum is 100) |
offset | Integer | 0 | Number of results to skip |
limit | Integer | 10 | Number of results to show (maximum is 100) |
Response
Field | Type |
---|---|
total_count | Integer |
entries | [Dynamic List] |
List Companies
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/dynamic-lists/599f1891460cc86b9ae5e88d/companies?limit=1
JSON Response:
{
"total_count": 8632,
"entries": [
{
"object_type": "dynamic_list_company",
"dynamic_list_id": "599f1891460cc86b9ae5e88d",
"company": {
"id": "51c6b9a5a9812aa90b123980",
"object_type": "company",
"name": "DataFox",
"slug": "datafox",
"url": "datafox.com",
"location": "San Francisco, CA",
"icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
},
"date_added": "2017-08-24T08:11:04.469Z"
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/dynamic-lists/:id/companies
Query Parameters
Parameter | Type | Default | Description |
---|---|---|---|
added_after | Date | Filters results by companies added after a certain date | |
added_before | Date | Filters results by companies added before a certain date | |
offset | Integer | 0 | Number of results to skip |
limit | Integer | 10 | Number of results to show (maximum is 100) |
Response
Field | Type |
---|---|
total_count | Integer |
entries | [Dynamic List Company] |
Users
Create
This endpoint will create users in the same team as the authenticated user. It can only be performed by an authenticated user with administrator role.
curl --request POST \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"first_name": "John", "last_name": "Doe", email: "john.doe@example.com"}' \
https://api.datafox.com/2.0/users
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"object_type": "user",
"first_name": "John",
"last_name": "Doe",
"slug": "john-doe-5",
"team_id": "ccb2d9e21b41b0ffe0193dbd"
}
HTTP Endpoint
https://api.datafox.com/2.0/users
Form Values
Parameter | Type | Description |
---|---|---|
first_name | [String] | First name of user |
last_name | [String] | Last name of user |
[String] | Unique email of user |
Response
User
Retrieve
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/users/561d4b599ae49efd0500002d
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"object_type": "user",
"first_name": "John",
"last_name": "Doe",
"slug": "john-doe-5",
"team_id": "ccb2d9e21b41b0ffe0193dbd"
}
HTTP Endpoint
https://api.datafox.com/2.0/users/:id
Response
User
Update
This endpoint will update a user. It can only be performed by an authenticated user with administrator role or to update the currently authenticated user’s information.
curl --request PATCH \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"first_name": "Jill"}' \
https://api.datafox.com/2.0/users/561d4b599ae49efd0500002d
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"object_type": "user",
"first_name": "Jill",
"last_name": "Doe",
"slug": "john-doe-5",
"team_id": "ccb2d9e21b41b0ffe0193dbd"
}
HTTP Endpoint
https://api.datafox.com/2.0/users/:id
Form Values
Parameter | Type | Description |
---|---|---|
first_name | [String] | First name of user |
last_name | [String] | Last name of user |
[String] | Unique email of user |
Response
User
Delete
This endpoint will delete a user. It can only be performed by authenticated user with administrator role. Cannot be used to delete the currently authenticated user.
curl --request DELETE \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/users/561d4b599ae49efd0500002d
JSON Response:
{
"id": "561d4b599ae49efd0500002d",
"deleted": true
}
HTTP Endpoint
https://api.datafox.com/2.0/users/:id
Response
Field | Type |
---|---|
id | ID |
deleted | Boolean |
List
This endpoint lists all users in the same team as the authenticated user.
curl --request GET \
--header "Authorization: Bearer ACCESS_TOKEN" \
https://api.datafox.com/2.0/users
JSON Response:
{
"count": 2,
"entries": [
{
"id": "561d4b599ae49efd0500002d",
"object_type": "user",
"first_name": "Jill",
"last_name": "Doe",
"slug": "john-doe-5",
"team_id": "ccb2d9e21b41b0ffe0193dbd"
}, {
"id": "acb2d9e21b41b0ffe0193dac",
"object_type": "user",
"first_name": "Sally",
"last_name": "Dot",
"slug": "sally-dot-1",
"team_id": "ccb2d9e21b41b0ffe0193dbd"
}
]
}
HTTP Endpoint
https://api.datafox.com/2.0/users
Response
Field | Type |
---|---|
count | Integer |
entries | [List] |
Errors
Errors will be returned following the Error Object Type as described above.
All error responses will use appropriate HTTP status codes (matching the
error object’s status_code
field).
The following is a list of the status codes and error codes sent by the API:
Status Code | Error Code |
---|---|
400 | "bad_request" |
401 | "unauthorized" |
403 | "forbidden" |
404 | "not_found" |
405 | "method_not_allowed" |
409 | "conflict" |
429 | "too_many_requests" |
500 | "internal_server_error" |
Change History
Review what’s new in this document.
December 2020
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Get Started | Updated Documentation | Included information to get started with Oracle DataFox API using Oracle Identity Cloud Service. |
Authentication | Updated Documentation | Updated authentication information to use the APIs with Oracle Identity Cloud Service. |
November 2020
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Tweet | Removed Documentation | Removed the tweet object type. |
October 2020
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Companies | Updated Documentation | Added legal_name, naics_code, naics_code_description, ein, founded_year and last_modified_date to the Full table in Companies object type. |
May 2020
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Authentication | Added the State parameter to the authorization code URL | Added State as an optional query parameter to the authorization URL. Use this parameter to identify and deny any malicious requests while authorizing the Oracle DataFox app for a user. |
November 2019
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Object Types | Updated Documentation | Clarified the confidence for the MatchCompany object type. |
October 2019
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Object Types | Deleted Attribute | Removed Technology from the API. |
Companies | Deleted Endpoints | Removed Technologies, Preferred Technologies, and HG Data Technologies endpoints from the API. |
September 2019
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Users | New Endpoints | Added Create, Update, List, and Delete endpoints to Users API response. Use these endpoints to manage your users if you have set up single sign-on to access Oracle DataFox. |
Account Score | Update to Endpoint | Added last_modified_date to the Account Score endpoint. |
August 2019
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Similar Companies | Update to Attribute | Added a disclaimer to the Similar Companies endpoint. You may now require an upgrade to use this endpoint. |
July 2019
The following table lists changes introduced in this version of the document.
Change | Type | Description |
---|---|---|
Companies/Account Score | New Attribute | Added last_updated_date to Account Score API response. |