NAV Navbar
Logo pl
curl

Introduction

The PredictLeads APIs are used to discover new companies or enrich company profiles with insights. Use cases range from CRM enrichment with account intelligence to lead generation using our set of buying signals.

Our APIs are RESTful with responses delivered in JSON and XML format.

In order to use this API, you must first register with PredictLeads to get an authentication token. Register here.

Authentication

Authentication using Authorization header.

curl "https://predictleads.com/api/v1/followings" \
  -H 'X-User-Email: miha@predictleads.com' \
  -H 'X-User-Token: 1G8_s7P-V-4MGojaKD7a'

Alternatively pass email and token in query parameters.

curl "https://predictleads.com/api/v1/followings \
    ?user_token={key}&user_email=miha@predictleads.com"

Authentication is done via the API token which you can find in your account settings.

In order to use the API you need to call an endpoint URL with your API token and chosen email.

The primary and recommended method for authenticating with PredictLeads is to specify the API key in the HTTP request header using an extended header field.

Pagination

curl -X GET "https://predictleads.com/api/v1/companies/discover \
    ?event_categories=hires&page=2"

Responses with a list of objects (like GET /companies/discover) are paginated. Use page parameter to get more results. Total number of all possible results is displayed inside meta attributes as count.

Webhooks

Example of data we’ll POST to segment subscription url.

{
   "data":[
      {
         "domain":"acast.com",
         "company_name":"Acast",
         "events":[
            {
               "id":"7175c775-bdac-4a1e-b4d0-c8264a03baa2",
               "type":"events",
               "attributes":{
                  "categories":[
                     "launches"
                  ],
                  "title":"Acast launches app for Windows 10 devices on Jul 14th 16'.",
                  "url":"http://mspoweruser.com/acast-for-windows-10-now-available/",
                  "found_at":"2016-07-14T15:58:07Z",
                  "additional_data":{
                     "product":"app for Windows 10 devices",
                     "product_tags":[
                        "mobile",
                        "online_technology"
                     ],
                     "date":"2016-07-14"
                  }
               },
               "relationships":{
                  "companies":{
                     "data":[
                        {
                           "type":"companies",
                           "domain":"acast.com"
                        }
                     ]
                  }
               }
            }
         ]
      },
      {
         "domain":"breezie.com",
         "company_name":"Breezie Inc.",
         "events":[
            {
               "id":"671d0686-65a3-46d2-8047-c8b9f7dd6186",
               "type":"events",
               "attributes":{
                  "categories":[
                     "is_developing"
                  ],
                  "title":"Breezie Inc. is developing tablet solution for seniors",
                  "url":"http://www.crn.com.au/news/samsung-australia-and-ethan-group-team-up-to-bring-tablets-to-seniors-442801",
                  "found_at":"2016-11-28T12:10:17Z",
                  "additional_data":{
                     "product":"tablet solution for seniors",
                     "product_tags":[
                        "mobile"
                     ]
                  }
               },
               "relationships":{
                  "companies":{
                     "data":[
                        {
                           "type":"companies",
                           "domain":"breezie.com"
                        }
                     ]
                  }
               }
            }
         ]
      }
   ]
}

Webhooks enable our customers to receive data on a continuous basis without the need to issue unnecessary API requests.

Signals

Anytime we find a new buying signal for one of the companies you’re tracking, we’ll send a POST request to your general webhook url with the Signal object. Go to account settings to enter your general webhook url.

Companies

When creating a segment of companies you can set a webhook url optionally. Every week we’ll send a POST request to that webhook url with new companies in your segment. Under relationships we’ll include Signal objects corresponding to Segment parameters. In case no new companies are found in your segment, we won’t send anything.

Authentication

To validate the webhook came from PredictLeads we suggest verifying the webhook payloads with the X-Predict-Signature header (which we pass with every webhook). Header payload is a SHA1 HMAC hexdigest computed with your API key and the raw body of the request.

Track

Track companies to receive buying signals data when found. We’ll issue a POST request with the data to your general webhook url. More on webhooks here.

Followed companies

curl -X GET "https://predictleads.com/api/v1/followings"
[
  "hubspot.com", 
  "clearbit.com", 
  "segment.com", 
  "outreach.io",
  "..."
]

Returns a list of followed companies.

HTTP Request

GET https://predictleads.com/api/v1/followings

Follow company

curl -X POST "https://predictleads.com/api/v1/companies/madkudu.com/follow"
{
  "success": {
    "type":"follow_successful",
    "message":"Company with domain madkudu.com was successfully followed."
  }
}

Enables the authenticated user to follow the company specified with the company domain parameter.

HTTP Request

POST https://predictleads.com/api/v1/companies/:domain/follow

Unfollow company

curl -X POST "https://predictleads.com/api/v1/companies/kitedesk.com/unfollow"
{
  "success": {
    "type":"unfollow_successful",
    "message":"Company with domain kitedesk.com was successfully unfollowed."
  }
}

Enables the authenticated user to unfollow the company specified with the domain parameter.

HTTP Request

POST https://predictleads.com/api/v1/companies/:domain/unfollow

Enrich

Access all recent signals for a given company by providing its domain. Each signal type has its own endpoint: /events, /job_openings and /technologies. Every call returns most recent 10 signals. In case the company isn’t in our database, the system will immediately start searching for signals and return them to the specified webhook url when finished. Alternatively, you can call the endpoint again in 48 hours.

Events

curl -X GET "https://predictleads.com/api/v1/companies/hubspot.com/events"
{
   "data":[
      {
         "id":"1afd1381-0075-4f18-bfb3-d9d0c1318226",
         "type":"events",
         "attributes":{
            "categories":[
               "expands_offices_to"
            ],
            "title":"HubSpot, Inc. expands offices to Berlin, Germany",
            "url":"https://www.hubspot.com/company-news/hubspot-to-open-second-emea-office-in-berlin-germany-in-2017",
            "found_at":"2016-11-16T06:00:00Z",
            "additional_data":{
               "assets":"office",
               "location":"Berlin, Germany",
               "location_data":{
                  "country":"Germany",
                  "fuzzy_match":false
               }
            }
         },
         "relationships":{
            "companies":{
               "data":[
                  {
                     "type":"companies",
                     "domain":"hubspot.com"
                  }
               ]
            }
         }
      },
      {
         "id":"5614a25a-d437-4daa-b9e8-47bd176d60c1",
         "type":"events",
         "attributes":{
            "categories":[
               "recognized_as"
            ],
            "title":"HubSpot, Inc. recognized as best customer relationship management software",
            "url":"http://www.marketwired.com/press-release/hubspot-awarded-best-customer-relationship-management-software-on-crowdreviewscom-2096777.htm",
            "found_at":"2016-02-16T21:30:12Z",
            "additional_data":{
               "recognition":"best customer relationship management software"
            }
         },
         "relationships":{
            "companies":{
               "data":[
                  {
                     "type":"companies",
                     "domain":"hubspot.com"
                  }
               ]
            }
         }
      },
      {
         "id":"65e58c11-c24f-411e-b056-3b68321b0ba5",
         "type":"events",
         "attributes":{
            "categories":[
               "launches"
            ],
            "title":"HubSpot, Inc. launches HubSpot Sales Referral Program on Feb 6th 17'.",
            "url":"https://www.hubspot.com/company-news/hubspot-launches-sales-partner-program-to-help-transform-the-way-the-world-sells",
            "found_at":"2017-02-06T14:00:00Z",
            "additional_data":{
               "product":"HubSpot Sales Referral Program",
               "product_tags":[
                  "programs"
               ],
               "date":"2017-02-06"
            }
         },
         "relationships":{
            "companies":{
               "data":[
                  {
                     "type":"companies",
                     "domain":"hubspot.com"
                  }
               ]
            }
         }
      },
      {
         "id":"87acf496-b5b3-470b-8425-9d934ad746c7",
         "type":"events",
         "attributes":{
            "categories":[
               "hires"
            ],
            "title":"HubSpot, Inc. hires Katie Burke as Chief People Officer on Jan 30th 17'.",
            "url":"https://www.hubspot.com/company-news/katie-burke-becomes-hubspots-chief-people-officer",
            "found_at":"2017-01-31T12:30:00Z",
            "additional_data":{
               "contact":"Katie Burke",
               "job_title":"Chief People Officer",
               "date":"2017-01-30"
            }
         },
         "relationships":{
            "companies":{
               "data":[
                  {
                     "type":"companies",
                     "domain":"hubspot.com"
                  }
               ]
            }
         }
      },
      {
         "id":"da2af2c6-983a-4657-abb7-bc9cb85883d5",
         "type":"events",
         "attributes":{
            "categories":[
               "integrates_with"
            ],
            "title":"LeadGnome, Inc. integrates with HubSpot, Inc.",
            "url":"http://satprnews.com/2016/12/06/leadgnome-integrates-with-hubspot-to-increase-sales-velocity/",
            "found_at":"2016-12-06T22:31:24Z",
            "additional_data":{

            }
         },
         "relationships":{
            "companies":{
               "data":[
                  {
                     "type":"companies",
                     "domain":"leadgnome.com"
                  },
                  {
                     "type":"companies",
                     "domain":"hubspot.com"
                  }
               ]
            }
         }
      },
      {
         "id":"f5137825-b6d0-40fb-9317-51a5146249ba",
         "type":"events",
         "attributes":{
            "categories":[
               "launches"
            ],
            "title":"HubSpot, Inc. launches GrowthBot on Jul 14th 16'.",
            "url":"http://venturebeat.com/2016/07/14/hubspot-releases-powerful-growthbot-thats-a-marketers-dream/",
            "found_at":"2016-07-14T13:31:56Z",
            "additional_data":{
               "product":"GrowthBot",
               "date":"2016-07-14"
            }
         },
         "relationships":{
            "companies":{
               "data":[
                  {
                     "type":"companies",
                     "domain":"hubspot.com"
                  }
               ]
            }
         }
      }
   ],
   "meta":{
      "count":11
   }
}

Returns a list of event signals for a given company. Event signals are found in press releases, industry news, blogs and other media.

HTTP Request

GET https://predictleads.com/api/v1/companies/:domain/events

Request Parameters

Parameter Description
categories string All event categories are listed below. Split by a comma (,).
limit string Limit the number of shown events per page. Default is 30, maximum is 100.

List of event categories

Job openings

curl -X GET "https://predictleads.com/api/v1/companies/clearbit.com/job_openings"
{
   "data":[
      {
         "id":"bb2a89bf-76fb-4102-a1e2-7a068b7d3b8b",
         "type":"job_openings",
         "attributes":{
            "categories":[
               "sales",
            ],
            "title":"Business Development Representative",
            "url":"https://clearbit.com/jobs#bdr",
            "found_at":"2017-01-25T08:50:30Z",
            "additional_data":{
               "job_title":"Business Development Representative",
               "job_title_seniority":"undefined",
               "tags":[
                  "Salesforce",
                  "Growth",
                  "Business Development",
                  "Outbound",
                  "Sales Prospecting"
               ]
            }
         }
      },
      {
         "id":"92f95b06-8ee2-43c3-b698-b590b111f78b",
         "type":"job_openings",
         "attributes":{
            "categories":[
               "engineering",
               "software_development"
            ],
            "title":"Software Engineer",
            "url":"https://clearbit.com/jobs#software-engineer",
            "found_at":"2017-01-17T17:14:15Z",
            "additional_data":{
               "job_title":"Software Engineer",
               "job_title_seniority":"undefined",
               "tags":[
                  "GitHub",
                  "Ruby"
               ]
            }
         }
      },
      {
         "id":"5c215bdc-c560-4a82-ab2d-80524b491b64",
         "type":"job_openings",
         "attributes":{
            "categories":[
               "design"
            ],
            "title":"Lead Designer",
            "url":"https://clearbit.com/jobs#design",
            "found_at":"2017-01-17T17:14:15Z",
            "additional_data":{
               "job_title":"Lead Designer",
               "job_title_seniority":"undefined",
               "tags":[
                  "Adobe Creative Suite",
                  "GitHub"
               ]
            }
         }
      },
      {
         "id":"45c4a905-ac7f-4a0a-bb70-97dcbe0c52cd",
         "type":"job_openings",
         "attributes":{
            "categories":[
               "sales"
            ],
            "title":"Account Executive",
            "url":"https://clearbit.com/jobs#account-executive",
            "found_at":"2017-01-17T17:14:15Z",
            "additional_data":{
               "job_title":"Account Executive",
               "job_title_seniority":"undefined",
               "tags":[
                  "Salesforce",
                  "Growth",
                  "Outbound"
               ]
            }
         }
      }
   ],
   "meta":{
      "count":4
   }
}

Returns a list of job openings for a given company. Job openings are found on companies career sites and job boards.

HTTP Request

GET https://predictleads.com/api/v1/companies/:domain/job_openings

Request Parameters

Parameter Description
categories string All job opening categories are listed below. Split by a comma (,).

List of job openings categories

Technologies

curl -X GET "https://predictleads.com/api/v1/companies/madkudu.com/technologies"
{
   "data":[
      {
         "id":"d108d45c-9553-4b89-a02c-9e1daff1ca20",
         "type":"technologies",
         "attributes":{
            "categories":[
               "analytics"
            ],
            "title":"Segment",
            "url":"http://www.madkudu.com",
            "found_at":"2017-01-26T01:30:38Z",
            "additional_data":{ }
         }
      },
      {
         "id":"c331a4c1-4fe3-44c6-82a6-04fbf007056a",
         "type":"technologies",
         "attributes":{
            "categories":[
               "analytics"
            ],
            "title":"Mixpanel",
            "url":"http://www.madkudu.com",
            "found_at":"2017-01-26T01:30:38Z",
            "additional_data":{ }
         }
      },
      {
         "id":"33fee691-ae24-4c0b-b876-77d2f319ff60",
         "type":"technologies",
         "attributes":{
            "categories":[
               "analytics"
            ],
            "title":"Intercom",
            "url":"http://www.madkudu.com",
            "found_at":"2017-01-26T01:30:38Z",
            "additional_data":{ }
         }
      },
      {
         "id":"7563a433-8c86-434e-8b84-8cc06e212a89",
         "type":"technologies",
         "attributes":{
            "categories":[
               "marketing_automation"
            ],
            "title":"HubSpot",
            "url":"http://www.madkudu.com",
            "found_at":"2017-01-26T01:30:38Z",
            "additional_data":{ }
         }
      }
   ],
   "meta":{
      "count":13
   }
}

Returns a list of technology providers for a given company.

HTTP Request

GET https://predictleads.com/api/v1/companies/:domain/technologies

Request Parameters

Parameter Description
categories string All technology categories are listed below. Split by a comma (,).

List of technology categories

Discover

Find companies by querying our database by various parameters.

Discover companies

curl -X GET "https://predictleads.com/api/v1/companies/discover?event_categories=is_developing&headquarter_locations=CA"
{
   "data":[
      {
         "id":"1442551",
         "type":"companies",
         "attributes":{
            "domain":"jauntvr.com",
            "company_name":"Jaunt VR"
         },
         "relationships":{
            "events":{
               "data":[
                  {
                     "type":"events",
                     "id":"90542583-657f-46fa-85f4-a1a5c5f24798",
                     "link":"https://predictleads.com/api/v1/events/90542583-657f-46fa-85f4-a1a5c5f24798",
                     "url":"http://gadgets.ndtv.com/tv/news/xiaomi-partners-jaunt-for-virtual-reality-content-1641113"
                  },
                  {
                     "type":"events",
                     "id":"a223e6c7-159a-411f-9486-fa1c194744d5",
                     "link":"https://predictleads.com/api/v1/events/a223e6c7-159a-411f-9486-fa1c194744d5",
                     "url":"http://www.businesswire.com/news/home/20160714005292/en/Dolby-Laboratories-Jaunt-Launch-World%25E2%2580%2599s-Cinematic-VR"
                  }
               ]
            }
         }
      },
      {
         "id":"1445022",
         "type":"companies",
         "attributes":{
            "domain":"kitepharma.com",
            "company_name":"Kite Pharma, Inc."
         },
         "relationships":{
            "events":{
               "data":[
                  {
                     "type":"events",
                     "id":"0d104175-0310-41a5-9c17-8bcae0b0424c",
                     "link":"https://predictleads.com/api/v1/events/0d104175-0310-41a5-9c17-8bcae0b0424c",
                     "url":"http://www.benchmarkmonitor.com/2016/12/17/investors-alert-kite-pharma-inc-nasdaqkite-adtran-inc-nasdaqadtn-mattel-inc-nasdaqmat-cisco-systems-inc-nasdaqcsco/"
                  }
               ]
            }
         }
      },
      {
         "id":"1447882",
         "type":"companies",
         "attributes":{
            "domain":"liquid-robotics.com",
            "company_name":"Liquid Robotics Inc."
         },
         "relationships":{
            "events":{
               "data":[
                  {
                     "type":"events",
                     "id":"a0730a04-d9e5-4d90-8411-15266b55cbca",
                     "link":"https://predictleads.com/api/v1/events/a0730a04-d9e5-4d90-8411-15266b55cbca",
                     "url":"http://www.upi.com/Business_News/Security-Industry/2016/12/07/Boeing-to-acquire-Liquid-Robotics/7141481118466/"
                  },
                  {
                     "type":"events",
                     "id":"f02bd5e6-6776-4114-8136-be9a525207ce",
                     "link":"https://predictleads.com/api/v1/events/f02bd5e6-6776-4114-8136-be9a525207ce",
                     "url":"http://www.marinetechnologynews.com/news/boeing-acquire-liquid-robotics-542269"
                  }
               ]
            }
         }
      },
      {
         "id":"1448113",
         "type":"companies",
         "attributes":{
            "domain":"llnl.gov",
            "company_name":"Lawrence Livermore National Laboratory"
         },
         "relationships":{
            "events":{
               "data":[
                  {
                     "type":"events",
                     "id":"40ea781f-e1c8-4372-8d2e-619bc1a653c2",
                     "link":"https://predictleads.com/api/v1/events/40ea781f-e1c8-4372-8d2e-619bc1a653c2",
                     "url":"http://www.newswise.com/articles/department-of-energy-selects-llnl-to-lead-development-of-manufacturing-training-program-for-energy-entrepreneurs"
                  }
               ]
            }
         }
      },
      {
         "id":"1449284",
         "type":"companies",
         "attributes":{
            "domain":"machinima.com",
            "company_name":"Machinima, Inc."
         },
         "relationships":{
            "events":{
               "data":[
                  {
                     "type":"events",
                     "id":"fc6f1302-29aa-4a62-bf35-559e506cd39f",
                     "link":"https://predictleads.com/api/v1/events/fc6f1302-29aa-4a62-bf35-559e506cd39f",
                     "url":"http://www.denofgeek.com/us/tv/prime-wars-trilogy/260322/machinima-and-hasbro-team-to-continue-transformers-animated-web-series"
                  },
                  {
                     "type":"events",
                     "id":"9b88abd7-5728-4df2-af49-b6521bd6b6b0",
                     "link":"https://predictleads.com/api/v1/events/9b88abd7-5728-4df2-af49-b6521bd6b6b0",
                     "url":"http://www.hollywoodreporter.com/news/warner-bros-confirms-acquisition-digital-network-machinima-948329"
                  }
               ]
            }
         }
      }
   ],
   "meta":{
      "count":134
   }
}

Returns a list of companies that satisfy given query parameters.

HTTP Request

GET https://predictleads.com/api/v1/companies/discover

Request Parameters

Parameter Description
headquarters_locations string List of company headquarters locations split by a comma (,). Ie.: CA, FL, France.
event_locations string List of event locations split by a comma (,). Ie.: CA, FL, France.
job_opening_locations string List of job opening locations split by a comma (,). Ie.: CA, FL, France.
event_categories string List of event categories split by a comma (,). Ie.: hires, launches, invests_into.
event_tags string List of event tags split by a comma (,). Ie.: mobile, future_tech, energy.
job_opening_categories string List of job categories split by a comma (,). Ie.: marketing, education, software_development.
job_opening_tags string List of keywords found on career sites split by a comma (,). Ie.: SalesForce, Customer succes, SAP.
found_at_from date (ISO 8601) Signals found from specified date.
found_at_until date (ISO 8601) Signals found until specified date.

Use abbreviations for US states ie.: CA, FL and countries for other locations: Germany, China, Japan …

Segments

Company segments enable our customers to personalize outreach and messaging. Leverage buying signals to identify new sets companies. Ie.: you can create a segment of companies that use SalesForce and recently posted a job opening for iOS Developers.

You can specify a webhook URL to which we’ll be sending newly found companies that match the segment’s criteria on a regular basis.

Create segment

curl -X POST "https://predictleads.com/api/v1/segments"
    -d '{"name":"New segment", "event_categories":"launches", "event_tags":"mobile,online_technology"}'
    -H "Content-Type: application/json"
{
   "data":{
      "id":"721",
      "type":"segments",
      "attributes":{
         "name":"New segment"
      }
   },
   "meta":{
      "message":"Segment successfully created.",
      "message_type":"segment_created"
   }
}

Creates a segment of companies with a set of query parameters.

HTTP Request

POST https://predictleads.com/api/v1/segments

Request Parameters

Parameter Description
name string Name of the segment.
subscription_url string We’ll send the data to this URL.
active string Set to “false” to deactivate the segment.

All /discover parameters can be used to create a segment.

Update segment

curl -X PUT "https://predictleads.com/api/v1/segments/721"
    -d '{"subscription_url":"https://requestb.in/2983cn"}'
    -H "Content-Type: application/json"
{
   "data":{
      "id":"721",
      "type":"segments",
      "attributes":{
         "name":"New segment"
      }
   },
   "meta":{
      "message":"Segment successfully updated.",
      "message_type":"segment_updated"
   }
}

Updates the segment.

HTTP Request

PUT https://predictleads.com/api/v1/segments/:id

Request Parameters

Parameter Description
id string ID of the segment.
name string Name of the segment.
subscription_url string We’ll send the data to this URL.
active string Set to “false” to deactivate the segment.

All /discover parameters can be used to update a segment.

Send data

curl -X GET "https://predictleads.com/api/v1/segments/:id/send_data?test=true"
{
   "data":{
      "id":"21",
      "type":"segments",
      "attributes":{
         "name":"New segment"
      }
   },
   "meta":{
      "message":"Segment data successfully sent.",
      "message_type":"segment_data_sent"
   }
}

Example of data sent to subscription url

{
   "data":[
      {
         "domain":"acast.com",
         "company_name":"Acast",
         "events":[
            {
               "id":"7175c775-bdac-4a1e-b4d0-c8264a03baa2",
               "type":"events",
               "attributes":{
                  "categories":[
                     "launches"
                  ],
                  "title":"Acast launches app for Windows 10 devices on Jul 14th 16'.",
                  "url":"http://mspoweruser.com/acast-for-windows-10-now-available/",
                  "found_at":"2016-07-14T15:58:07Z",
                  "additional_data":{
                     "product":"app for Windows 10 devices",
                     "product_tags":[
                        "mobile",
                        "online_technology"
                     ],
                     "date":"2016-07-14"
                  }
               },
               "relationships":{
                  "companies":{
                     "data":[
                        {
                           "type":"companies",
                           "domain":"acast.com"
                        }
                     ]
                  }
               }
            }
         ]
      },
      {
         "domain":"breezie.com",
         "company_name":"Breezie Inc.",
         "events":[
            {
               "id":"671d0686-65a3-46d2-8047-c8b9f7dd6186",
               "type":"events",
               "attributes":{
                  "categories":[
                     "is_developing"
                  ],
                  "title":"Breezie Inc. is developing tablet solution for seniors",
                  "url":"http://www.crn.com.au/news/samsung-australia-and-ethan-group-team-up-to-bring-tablets-to-seniors-442801",
                  "found_at":"2016-11-28T12:10:17Z",
                  "additional_data":{
                     "product":"tablet solution for seniors",
                     "product_tags":[
                        "mobile"
                     ]
                  }
               },
               "relationships":{
                  "companies":{
                     "data":[
                        {
                           "type":"companies",
                           "domain":"breezie.com"
                        }
                     ]
                  }
               }
            }
         ]
      }
   ]
}

Sends a list of companies within the segment to the segment’s subscription url instantly. Set test to “true” in sandbox mode.

HTTP Request

GET https://predictleads.com/api/v1/segments/:id/send_data

Request Parameters

Parameter Description
id string ID of the segment.
test string Set to “true” for testing purposes.

Get data

curl -X GET "https://predictleads.com/api/v1/segments/:id/get_data"

Returns the list of companies within the segment

HTTP Request

GET https://predictleads.com/api/v1/segments/:id/get_data

Request Parameters

Parameter Description
id string ID of the segment.

Signal objects

Listed here are all types of returned signal objects.

Event

Examples of event objects

[
  {
           "id":"28ac963d-2f04-4060-b54e-014cc0898417",
           "type":"events",
           "attributes":{
              "categories":[
                 "expands_offices_to"
              ],
              "title":"Array Technologies, Inc. expands offices to Sydney",
              "url":"http://www.solarnovus.com/array-technologies-expands-to-australia_N10767.html",
              "found_at":"2017-03-29T12:12:50Z",
              "additional_data":{
                 "assets":"office",
                 "location":"Sydney",
                 "location_data":{
                    "country":"Australia",
                    "fuzzy_match":false
                 }
              }
           },
           "relationships":{
              "companies":{
                 "data":[
                    {
                       "type":"companies",
                       "domain":"arraytechinc.com",
                       "name":"Array Technologies, Inc.",
                       "friendly_name":"Array Technologies"
                    }
                 ]
              }
           }
        },
  {
         "id":"cab04bfc-2661-4896-b933-051591d70fc1",
         "type":"events",
         "attributes":{
            "categories":[
               "partners_with"
            ],
            "title":"YourMembership partners with Aptify Corporation",
            "url":"http://www.thenonprofittimes.com/news-articles/software-deal-marries-yourmembership-abila-aptify/",
            "found_at":"2017-04-07T14:42:10Z",
            "additional_data":{

            }
         },
         "relationships":{
            "companies":{
               "data":[
                  {
                     "type":"companies",
                     "domain":"yourmembership.com",
                     "name":"YourMembership",
                     "friendly_name":"YourMembership"
                  },
                  {
                     "type":"companies",
                     "domain":"aptify.com",
                     "name":"Aptify Corporation",
                     "friendly_name":"Aptify"
                  }
               ]
            }
         }
      },
  {
     "id":"ff100453-2cbb-45d5-968b-fa07d3076f5b",
     "type":"events",
     "attributes":{
        "categories":[
           "hires"
        ],
        "title":"Decision Resources Group hires Peter Hempshall as Senior Vice President, Global Consulting Services",
        "url":"http://www.prnewswire.co.uk/news-releases/decision-resources-group-appoints-peter-hempshall-as-senior-vice-president-global-consulting-services-612888543.html",
        "found_at":"2017-02-06T13:45:11Z",
        "additional_data":{
           "contact":"Peter Hempshall",
           "job_title":"Senior Vice President, Global Consulting Services"
        }
     },
     "relationships":{
        "companies":{
           "data":[
              {
                 "type":"companies",
                 "domain":"decisionresourcesgroup.com"
              }
           ]
        }
     }
  },
  {
     "id":"fffd28f2-03ae-4f66-bc73-cc9b4b3b163a",
     "type":"events",
     "attributes":{
        "categories":[
           "expands_facilities"
        ],
        "title":"8minutenergy Renewables expands facilities to Texas, United States",
        "url":"http://www.pv-tech.org/news/8minutenergy-targeting-over-2gw-of-pv-projects-in-texas",
        "found_at":"2016-10-05T09:07:54Z",
        "additional_data":{
           "assets":"2GW of utility-scale PV power plant",
           "assets_tags":[
              "energy",
              "production"
           ],
           "location":"Texas, United States",
           "location_data":{
              "country":"United States",
              "fuzzy_match":false,
              "state":"Texas"
           }
        }
     },
     "relationships":{
        "companies":{
           "data":[
              {
                 "type":"companies",
                 "domain":"8minutenergy.com"
              }
           ]
        }
     }
  },
  {
     "id":"fff5147a-8346-4796-a26f-5bcd234a3686",
     "type":"events",
     "attributes":{
        "categories":[
           "expands_offices_to"
        ],
        "title":"Sisense Inc. expands offices to New York, United States",
        "url":"http://rew-online.com/2016/09/28/analytics-firm-sisense-relocating-to-esrts-1359-broadway/",
        "found_at":"2016-09-28T19:09:03Z",
        "additional_data":{
           "location":"New York, United States",
           "location_data":{
              "country":"United States",
              "fuzzy_match":false,
              "state":"New York"
           }
        }
     },
     "relationships":{
        "companies":{
           "data":[
              {
                 "type":"companies",
                 "domain":"sisense.com"
              }
           ]
        }
     }
  },
  {
     "id":"ffdeb82f-39f1-4b39-9b01-5c31ad2c0b96",
     "type":"events",
     "attributes":{
        "categories":[
           "promotes"
        ],
        "title":"Del Monte Foods, Inc. promotes Robert Long as Chief Information Officer on Jul 13th 16'.",
        "url":"http://blogs.wsj.com/cio/2016/07/20/del-monte-picks-insider-as-new-cio/",
        "found_at":"2016-07-20T17:56:56Z",
        "additional_data":{
           "contact":"Robert Long",
           "job_title":"Chief Information Officer",
           "date":"2016-07-13"
        }
     },
     "relationships":{
        "companies":{
           "data":[
              {
                 "type":"companies",
                 "domain":"delmontefoods.com"
              }
           ]
        }
     }
  },
  {
     "id":"ffddcc25-8efc-48c2-ac50-8f3d1a2edd57",
     "type":"events",
     "attributes":{
        "categories":[
           "increases_headcount_by"
        ],
        "title":"McLaren Group Limited increases headcount by 250",
        "url":"http://www.autocar.co.uk/car-news/industry/mclaren-adds-second-shift-production-line-recruits-250-new-staff",
        "found_at":"2016-01-07T11:02:14Z",
        "additional_data":{
           "headcount":250
        }
     },
     "relationships":{
        "companies":{
           "data":[
              {
                 "type":"companies",
                 "domain":"mclaren.com"
              }
           ]
        }
     }
  },

]

Event signals are structured pieces of data found in press releases, news articles, blogs and other public documents.

Attribute Description
id integer
Unique trigger identifier (unique across all trigger types).
categories array
Type of the event - full list below.
title string
Autogenerated title from the data.
url array
List of source URLs.
found_at datetime
Time & date (ISO 8601) of the published document.
additional_data hash
Additional data regarding the signal. See attributes below.

Companies

Associated company objects are listed in order under relationships.

Additional data

Attribute Description
relationships > companies array
Array of company domains in the signal (max 2)
When category involves two companies ie.: acquires. The order of the companies in the array is guaranteed so that the first company in the array is the acquirer and the second is the acquiree. Same goes for other categories like sells_assets_to, integrates_with …
date date
Date (ISO 8601) of when the event happened.
location string
Location of where the event happened or where the organization has expanded/relocated.
location_data hash
Structured location data.
contact string
Full name of the person in the personnel change.
job_title string
Full job title of the person in the personnel change.
product string
Name of the product that was launched.
product_tags array
List of tags regarding the product.
amount integer
Total amount of the deal in $ (investments, acquisitions, new clients).
recognition string
Name of recognition the company received.
assets string
Company’s assets.
asset_tags array
List of tags regarding the assets.
headcount integer
Number of employees hired or let go.
award string
Name of award the company received.
financing_type string
Stage of the funding round (seed, Series A, Series B, …, Angel funding, …).
financing_type_tags array
List of tags regarding the financing.
division string
Whether event concerns a specific division.
conference string
Conference where the company received award or recognition.
vulnerability string
Company issue
planning boolean
Event is not set in stone.

Event categories

Signal Group Description
hires leadership Company hired new executive or senior personnel.
promotes leadership Company promoted existing executive or senior personnel.
leaves leadership Executive or senior personnel left the company.
retires leadership Executive or senior personnel retires from the company.
acquires acquisition Company acquired other company.
merges_with acquisition Company merges with other company.
sells_assets_to acquisition Company sells assets (like properties or warehouses) to other company.
expands_offices_to expansion Company opens new offices in another town, state, country or continent.
expands_offices_in expansion Company expands existing offices.
expands_facilities expansion Company opens new or expands existing facilities like warehouses, data centers, manufacturing plants etc.
opens_new_location expansion Company opens new service location like hotels, restaurants, bars, hospitals etc.
increases_headcount_by expansion Company offers new job vacancies.
launches new_offering Company launches new offering.
integrates_with new_offering Company integrates with other company.
is_developing new_offering Company begins development of a new offering.
receives_financing investment Company receives investment like venture funding, loan, grant etc.
invests_into investment Company invests into other company.
invests_into_assets investment Company invests into assets like property, trucks, facilities etc.
goes_public investment Company issues shares to the public for the first time.
closes_offices cost_cutting Company closes existing offices.
decreases_headcount_by cost_cutting Company lays off employees.
partners_with partnership Company partners with other company.
receives_award recognition Company or person at the company receives an award.
recognized_as recognition Company or person at the company receives recognition.
receives_award recognition Company or person at the company receives an award.
signs_new_client contract Company signs new client.
files_suit_against corporate_challenges Company files suit against other company.
has_issues_with corporate_challenges Company has vulnerability problems.
identified_as_competitor relational New or existing competitor was identified.

Job opening

Examples of job_opening objects

[
  {
     "id":"f9393f49-6c60-4e26-87c3-fc4ed8d52950",
     "type":"job_openings",
     "attributes":{
        "categories":[
           "engineering",
           "software_development"
        ],
        "title":"Software Engineer - McLean, VA",
        "url":"http://doveltech.catsone.com/careers/index.php?m=portal&a=details&jobOrderID=8590658",
        "found_at":"2017-01-24T13:53:36Z",
        "additional_data":{
           "job_title":"Software Engineer - McLean, VA",
           "job_title_seniority":"undefined",
           "tags":[
             "Oracle",
             "Ruby",
             "Python",
             "Java"
           ]
        }
     }
  },
  {
     "id":"5dc16955-4e96-407b-9ee3-392281bef757",
     "type":"job_openings",
     "attributes":{
        "categories":[
           "engineering"
        ],
        "title":"Senior Electrical Engineer",
        "url":"http://careers.mineralresources.com.au/cw/en/job/493697/senior-electrical-engineer",
        "found_at":"2017-04-08T21:32:00Z",
        "additional_data":{
           "job_title":"Senior Electrical Engineer",
           "job_title_seniority":"senior",
           "tags":[
              "Growth"
           ]
        }
     }
  },
  {
     "id":"fecfa918-2a7c-4a1b-8455-967dcaadfe40",
     "type":"job_openings",
     "attributes":{
        "categories":[],
        "title":"Pay-Per-Click (PPC) Specialist",
        "url":"https://chengbao.com.hk/jobs/ppc-specialist.html",
        "found_at":"2017-01-25T01:55:05Z",
        "additional_data":{
           "job_title":"Pay-Per-Click (PPC) Specialist",
           "job_title_seniority":"undefined",
           "tags":[ 
             "AdWords"
           ]
        }
     }
  }
]
Attribute Description
id integer
Unique trigger identifier (unique across all trigger types).
categories array
Array of categories - full list below.
title string
Job title
url string
URL of the web page where the data was found.
found_at datetime
Time & date (ISO 8601) of when the job opening was found.

Job opening categories

["none", "administration", "chairmen", "health_care", "hospitality", "engineering", "education", "maintenance", "finance", "information_technology", "management", "operations", "partnerships", "human_resources", "publishing", "purchasing", "sales", "marketing", "transportation", "directors", "design", "software_development", "general_technology", "business_analysis", "support", "data_analysis"]

Technology

Examples of technology objects

[
  {
     "id":"ffcf3998-a073-428b-87dd-70b97d1641a3",
     "type":"technologies",
     "attributes":{
        "categories":[
           "marketing_automation"
        ],
        "title":"Pardot",
        "url":"http://www.wpowerproducts.com",
        "found_at":"2016-04-29T20:21:46Z"
     }
  },
  {
     "id":"ff0f6039-74c4-4403-bdf0-0beef3b8b1d9",
     "type":"technologies",
     "attributes":{
        "categories":[
           "analytics"
        ],
        "title":"Segment",
        "url":"http://www.tapbookauthor.com",
        "found_at":"2017-02-03T10:43:42Z"
     }
  },
  {
     "id":"ffd24665-04b1-456c-953e-464d5dcbceef",
     "type":"technologies",
     "attributes":{
        "categories":[
           "analytics"
        ],
        "title":"Intercom",
        "url":"http://www.lifehappens.org",
        "found_at":"2016-10-21T13:33:17Z"
     }
  }
]
Attribute Description
id integer
Unique trigger identifier (unique across all trigger types).
categories array
Array of categories - full list below.
title string
Technology name.
url string
URL of the web page where the data was found.
found_at datetime
Time & date (ISO 8601) of when the technology was found.

Technology categories

["cms", "ecommerce", "miscellaneous", "web_servers", "analytics", "advertising_networks", "widgets", "web_frameworks", "editors", "documentation_tools", "blogs", "cdn", "search_engines", "javascript_frameworks", "databases", "wikis", "message_boards", "dev_tools", "programming_languages", "issue_trackers", "database_managers", "video_players", "printers", "rich_text_editors", "operating_systems", "lms", "photo_galleries", "font_scripts", "javascript_graphics", "hosting_panels", "comment_systems", "marketing_automation", "mobile_frameworks", "build_ci_systems", "payment_processors", "maps", "cache_tools", "web_server_extensions", "tag_managers", "webcams", "network_devices", "remote_access", "document_management_systems", "media_servers", "captchas", "web_mail", "paywalls", "feed_readers", "control_systems", "network_storage", "landing_page_builders"]

Flag

If you come across any signal that seems wrong you can simply call the flag endpoint. Our quality assurance analysts will review the signal and correct it.

Optionally you can also append a message with the signal ID. The message can include info about why you flagged the product.

curl -X POST “https://predictleads.com/api/v1/events/:id/flag?message=‘Just … plain … wrong! Get your sh** together boys!!!’”

{
"meta": "Event flagged" 
}

Errors

Our API returns standard HTTP success or error status codes. For errors, we also include extra information about what went wrong encoded in the response as JSON.

Status Code Meaning
200 SUCCESS - Request was successfully processed.
400 BAD REQUEST - Request message framing was invalid. The server cannot or will not process the request.
401 UNAUTHORIZED ACCESS - Authentication failed. Check again your credentials or contact us.
404 NOT FOUND - Specified company is not in our database. Check again in 24h.
500 INTERNAL SERVER ERROR – We had a problem with our server. Try again later.