Documentation | PredictLeads

Category	Description
`partner`	Read as: Company1 is a partner of Company2. A partner relationship signals a collaboration between companies that goes both in two directions. You will find such connections using titles as "We work with", "Our partners", "The company we keep", and other titles similar in meaning. The implications of this category can be quite wide in their meaning, but in general all partnerships are a positive signal. NOTE: Until February 2024 the `partner` category did not always signal a true partnership between two companies, but it also included a tighter knit relationship compared to the `other` category, which are not always as strong as the partner keyword suggests. The meaning is now correctly followed for all new cases or cases that have been last seen since and still have the `partner` category.
`vendor`	Read as: Company1 is a vendor to Company2. The vendor category is much simpler in its meaning. It simply means that company1 is a supplier for company2 in some way. All vendor relationships are positive, although some are more positive than others. On a webpage, such connections can be seen in lists such as "Our customers", "Trusted by", "Enabling businesses to", etc. For example, to be a vendor to Microsoft, the company has to pass certain requirements as to company size, product reliability, safety, etc. This can be seen as a vetting process of some sort and increases the company's trustworthiness. The vendor category can also be used to determine the supply chain of a certain company and evaluate supply chain risks.
`integration`	Read as: Company1 has an integration with Company2. Most of the time an integration happens between a platform and a service. Case examples: Company1 has developed a Machine learning model. To make it more usable, they have developed an Azure Cloud integration. With this, the customers of the model can start using it more quickly, which is good for Company1. It's generally the service's development team that takes on the task of creating this integration. This can also be a positive signal for the platform (Company2). One could calculate the adoption of the Company2 platform and use this as a signal for growth.
`investor`	Read as: Company1 is an investor in Company2. The investor category identifies relationships between companies making investments (Company1) and companies receiving investments (Company2). The more investors the company has, the better. One could also track what companies/sectors competitors are investing in.
`parent`	Read as: Company1 is a parent company of Company2. Parent category defines a parent-subsidiary relationship between websites. In some cases such websites are only localized versions for specific markets. Case examples: "activisionblizzard.com" is a parent to "blizzard.com", and in turn "blizzard.com" is a parent to "blizzard.de". "coca-cola.com" is a parent to a vast array of websites, such as "coca-cola.fr", "coca-cola.de", "coca-cola.es", "coca-cola.tn", "coca-cola.se", etc. NOTE: Often it makes sense to not only check current hierarchy level e.g. "blizzard.de" but also check their parent connections e.g. "blizzard.com" and "activisionblizzard.com". Since sometimes company connections (customers, investors…) are also available at higher company hierarchical levels.
`rebranding`	Read as: Company1 is a rebranding of Company2. Company1 being a rebranding of Company2 suggests that Company2 has undergone a process to change its brand identity. We detect rebranding based on domain change and similarities between the old and the new website. Case examples: Top-level-domain (TLD) change: airmeet.co -> airmeet.com. airmeet.com is a rebranding of airmeet.co. TLD changed to higher value .com. Change to a shorter domain: lamborghini.com is a rebranding of lamborghini-madrid.com. Name change: hausarztpraxis-leinetal.de is a rebranding of praxis-schuenemann.de.
`published_in`	Read as: Company1 is published in Company2. The `published_in` category is usually found on early stage startup websites with fewer accomplishments on the market, but positive press coverage. You can see such connections under titles such as "As seen in", "Featured in", "Talking about us", etc. A `published_in` connection is a positive signal, but after some months or years, we would expect to see them removed and replaced with other content proving the legitimacy of the company.
`other`	Read as: Company1 is connected to Company2. This is the most general category. If we detected a relationship between companies, but we were unsure which category it belonged to, or it didn't belong to any of our categories, then we would categorize it as `other`. Outgoing `other` category connections are a slightly positive signal, while incoming ones are quite more so. Thus a connection Company1 -> other -> Company2 is more positive for Company2, than for Company1. As Company2 was featured on Company1 website. Sometimes the `other` category can have additional information via the source_category attribute depending on where it was found. An example of such a source_category would be `cookie_section`, which is explained further below. Such connections could be evaluated differently.

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

3.1.
Introduction

Our API is RESTful and follows the JSON API specification.

For easier implementation, we provide API description also in OpenAPI schema (version 3.1.0) JSON format and OpenAPI SwaggerUI playground.

In order to use our API, you must first sign up to get an authentication token.

You can see live status of our API services.

If you would like to receive data as Flat Files or via Webhooks, please get in touch with our sales.

Base URL

3.1.1.
Authentication

Authentication is done via the authentication token which you can find on Your Subscription Plans page.

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

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.

3.1.2.
Request Limits

Each account using the API has request limits implemented. The amount of requests one can do each month is limited by the chosen plan. You can track your monthly usage on Your Subscription Plans page.

Once the account reaches the limit, all further requests will produce a 402 HTTP error, notifying the user of the reached limit. If you have any further questions regarding the limits, feel free to contact us via support.

3.1.3.
Pagination

Responses with a list of objects are paginated. Use page parameter to get more results. Total number of all possible results is displayed inside meta property as count.

3.2.
Follow Companies

Follow Companies API Endpoints

Retrieve followed companies

GET
/followings

Follow the company

POST
/companies/{domain}/follow

Unfollow the company

POST
/companies/{domain}/unfollow

3.2.1.
Retrieve followed companies

Returns followed companies.


GET

https://predictleads.com/api/v3/followings

Query Parameters
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Response Schemas

3.2.2.
Follow the company

Follow the company.


POST

https://predictleads.com/api/v3/companies/{domain}/follow

Path Parameters
`domain` `string` Company's domain.
Query Parameters
`custom_company_identifier` [optional] `string` Example: `"435366"` Provide, if you want to use your custom company identifier.

Request Examples

Response Examples

Response Schemas

3.2.3.
Unfollow the company

Unfollow the company.


POST

https://predictleads.com/api/v3/companies/{domain}/unfollow

Path Parameters
`domain` `string` Company's domain.

Request Examples

Response Examples

Response Schemas

3.3.
Companies Dataset

Companies Dataset API Endpoints

Retrieve Company

GET
/companies/{domain}

3.3.1.
Retrieve Company

Returns Company.


GET

https://predictleads.com/api/v3/companies/{domain}

Path Parameters
`domain` `string` Company's domain.

Request Examples

Response Examples

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about companies",
 "description": "Companies dataset includes additional information about the company e.g. normalized company location,\nticker, meta title, meta description...\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name",
 "friendly_company_name",
 "location",
 "location_data",
 "language",
 "meta_title",
 "meta_description"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "friendly_company_name": {
 "description": "Company friendly name.",
 "type": "string"
 },
 "location": {
 "description": "Company location.",
 "type": "string"
 },
 "location_data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "city",
 "state",
 "zip_code",
 "country",
 "region",
 "continent",
 "fuzzy_match"
 ],
 "properties": {
 "city": {
 "type": [
 "string",
 "null"
 ]
 },
 "state": {
 "type": [
 "string",
 "null"
 ]
 },
 "zip_code": {
 "type": [
 "string",
 "null"
 ]
 },
 "country": {
 "type": [
 "string",
 "null"
 ]
 },
 "region": {
 "type": [
 "string",
 "null"
 ]
 },
 "continent": {
 "type": [
 "string",
 "null"
 ]
 },
 "fuzzy_match": {
 "type": [
 "boolean",
 "null"
 ]
 }
 }
 }
 },
 "language": {
 "description": "Company website's language.",
 "type": "string"
 },
 "meta_title": {
 "description": "Company website's meta title.",
 "type": "string"
 },
 "meta_description": {
 "description": "Company website's meta title.",
 "type": "string"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "properties": {
 "parent_company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "redirects_to": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `CompaniesDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "4d621799-d317-58ba-a967-d09e07a5391f",
 "type": "company",
 "attributes": {
 "domain": "hubspot.com",
 "company_name": "HubSpot, Inc.",
 "friendly_company_name": "HubSpot",
 "ticker": "NYSE:HUBS",
 "meta_title": "Trust & Safety Policies",
 "meta_description": "HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.",
 "language": "en",
 "location": "Cambridge, Massachusetts, United States",
 "location_data": [
 {
 "city": "Cambridge",
 "state": "Massachusetts",
 "zip_code": null,
 "country": "United States",
 "region": null,
 "continent": null,
 "fuzzy_match": null
 }
 ]
 },
 "relationships": {
 }
 }
 ],
 "included": [

],
    "meta": {
      "schema_version": "3.0",
      "record_state": "active"
    }
  }
}

3.4.
Job Openings Dataset

Job Openings Dataset API Endpoints

Retrieve company's Job Openings

GET
/companies/{domain}/job_openings

Retrieve a single Job Opening

GET
/job_openings/{id}

3.4.1.
Retrieve company's Job Openings

Returns a list of company's Job Openings.


GET

https://predictleads.com/api/v3/companies/{domain}/job_openings

Path Parameters
`domain` `string` Company's domain.
Query Parameters
`active_only` [optional] `boolean` Set to true if you'd like to receive JobOpenings that are not closed, have last_seen_at more recent than 5 days and were found in the last year.
`not_closed` [optional] `boolean` Similar to `active_only`, but without considering `last_seen_at` timestamp.
`first_seen_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `JobOpenings` first seen after given date (ISO 8601).
`first_seen_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `JobOpenings` first seen before given date (ISO 8601).
`last_seen_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `JobOpenings` last seen after given date (ISO 8601).
`last_seen_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `JobOpenings` last seen before given date (ISO 8601).
`with_description_only` [optional] `boolean` Only return JobOpenings that have description.
`with_location_only` [optional] `boolean` Only return JobOpenings that have location.
`categories` [optional] `array` Comma-separated (,) `JobOpening` categories.
Items `string` One of the values: `"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", "support", "data_analysis"`
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Request was successfully processed.

{
  "data": [
    {
      "id": "4d5ac23c-5824-427d-96c6-4e8d50a4241a",
      "type": "job_opening",
      "attributes": {
        "title": "AI Engineer",
        "description": "**AI Engineer**\n\n\n**$50K - $120K** /  0.10% - 0.50%  **Location** London, England, GB  **Job Type** Full-time  **Experience** Any (new grads ok)   Apply to Terra API and hundreds of other fast-growing YC startups with a single profile.    ****\n\nAPI for developers to connect to health data from wearables and…\n\n\n**About the role**\n\nWe work in super small teams, with extremely high velocity.\n\nWe are building multiple AI products, such as OdinAI, Graph API, and many more\n\nAs an AI engineer, you'll work in a small team, with maximum autonomy.\n\n* Be behind the curtain, creating, testing, and implementing AI models\n* Engage in data analysis, machine learning, and natural language processing.\n* Fine-tuning the AI's performance and many more\n\nPreferred background:\n\nBachelor's or Master's degree in STEM. Strong technical skills (e.g. familiarity with a programming language such as Python, JavaScript, or Ruby) Experience with growth marketing, product development, and user acquisition/retention\n\n\n**Must haves.**\n\n-Must have done this before, or be willing to learn fast.\n\n-Must be fast. We operate at 200mph, and so do you.\n\n-Must be relentless. We never stop, so you are even faster than us.\n\n-Must have customer driven. We think customers first and so should you.\n\n-Must be driven and go above and beyond.\n\n-Must be able to explain and communicate clearly.\n\n-Must be prepared to challenge us and disagree. We are thinking and acting as a team.\n\n-Must be able to work autonomously.\n\n-Must want to work hard.\n\n-Last but not least, you are genuinely a nice person.\n\n**Big plus** You are an athlete, or care about quantifying your data\n\n\n**About Terra API**\n\n**What we do**\n\nTerra is an API that makes it easy for apps to connect to wearables. Currently, apps and developers in the fitness, wellness, sleep, and other health spaces are using us. Terra was launched in early 2021, and since then we’ve been growing like crazy. But this is just the beginning.\n\n\n**The goal and vision**\n\nThink if Spotify and Netflix create music and movies based on your heart rate, and stress levels, in real time. We want to enable apps to achieve that reality, through our super easy to use API.\n\n\n**Funding**\n\nTo achieve our grand goal, we couldn’t have made it without the support from some incredible investors. We are lucky enough to be supported by , ,  and we were part of  batch.\n\n, and learn who we are \n\nLocation: London, United Kingdom",
        "url": "https://www.ycombinator.com/companies/terra-api/jobs/0f5CP0r-ai-engineer",
        "first_seen_at": "2024-11-18T20:06:48Z",
        "last_seen_at": "2024-11-20T20:10:37Z",
        "last_processed_at": "2024-11-20T20:18:00Z",
        "contract_types": [
          "full time"
        ],
        "categories": [
          "engineering"
        ],
        "onet_data": {
          "code": "15-1252.00",
          "family": "Computer and Mathematical",
          "occupation_name": "Software Developers"
        },
        "salary": "$50000 - $120000",
        "salary_data": {
          "salary_low": 50000.0,
          "salary_high": 120000.0,
          "salary_currency": "USD",
          "salary_low_usd": 50000.0,
          "salary_high_usd": 120000.0,
          "salary_time_unit": "year"
        },
        "seniority": "non_manager",
        "status": "closed",
        "language": "en",
        "location": "London, United Kingdom",
        "location_data": [
          {
            "city": "London",
            "state": null,
            "zip_code": null,
            "country": "United Kingdom",
            "region": null,
            "continent": null,
            "fuzzy_match": false
          }
        ],
        "tags": [
          "Growth",
          "Python",
          "Ruby",
          "JavaScript"
        ]
      },
      "relationships": {
        "company": {
          "data": {
            "id": "eb383981-96cf-5d24-8e09-15f71f35879e",
            "type": "company"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "eb383981-96cf-5d24-8e09-15f71f35879e",
      "type": "company",
      "attributes": {
        "domain": "tryterra.co",
        "company_name": "Terra Enabling Developers, Ltd.",
        "ticker": null
      }
    }
  ],
  "meta": {
    "schema_version": "3.0",
    "record_state": "active"
  }
}

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about job openings from companies",
 "description": "Job Openings are found on companies' career sites and job boards. Job Openings and other descriptions can\nbe used to identify company investment areas, current priorities and future developments.\n \nProvided are fields like Job Category (marketing, sales, HR, support...), job description, salary, location\nand many more.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `JobOpening` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `JobOpening` object.",
 "const": "job_opening"
 },
 "attributes": {
 "description": "Attributes of `JobOpening` object.",
 "type": "object",
 "required": [
 "title",
 "description",
 "url",
 "first_seen_at",
 "last_seen_at",
 "last_processed_at",
 "contract_types",
 "categories",
 "onet_data",
 "salary",
 "salary_data",
 "seniority",
 "status",
 "language",
 "location",
 "location_data",
 "tags"
 ],
 "properties": {
 "title": {
 "description": "Job title.",
 "type": "string"
 },
 "description": {
 "description": "Job opening description.",
 "type": [
 "string",
 "null"
 ]
 },
 "url": {
 "description": "URL of the web page where the data was found.",
 "type": "string",
 "format": "uri"
 },
 "first_seen_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpening` was first seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpening` was last seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_processed_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpening` was last sent to processing.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "contract_types": {
 "description": "Zero or more types describing the job opening.",
 "example": [
 "full time",
 "remote"
 ],
 "type": "array",
 "items": [
 {
 "type": "string"
 }
 ]
 },
 "categories": {
 "description": "Zero or more organizational categories of the job opening.",
 "example": [
 "finance",
 "data_analysis"
 ],
 "type": "array",
 "items": [
 {
 "type": "string"
 }
 ]
 },
 "onet_data": {
 "description": "Inferred O\\*NET data for this job opening. O\\*NET is a source and standardization of occupational information. More info on the O\\*NET data: onetonline.org.",
 "type": "object",
 "required": [
 "code",
 "family",
 "occupation_name"
 ],
 "properties": {
 "code": {
 "description": "O\\*NET category code representing this job opening.",
 "example": "29-1021.00",
 "type": [
 "string",
 "null"
 ]
 },
 "family": {
 "description": "O\\*NET family name matching the code for this job opening.",
 "example": "Healthcare Practitioners and Technical",
 "type": [
 "string",
 "null"
 ]
 },
 "occupation_name": {
 "description": "O\\*NET occupation name matching the code for this job opening.",
 "example": "Dentists, General",
 "type": [
 "string",
 "null"
 ]
 }
 }
 },
 "salary": {
 "description": "Raw salary string.",
 "example": "£40000 - £50000 GBP",
 "type": [
 "string",
 "null"
 ]
 },
 "salary_data": {
 "description": "Parsed raw salary data.",
 "type": "object",
 "required": [
 "salary_low",
 "salary_high",
 "salary_currency",
 "salary_low_usd",
 "salary_high_usd",
 "salary_time_unit"
 ],
 "properties": {
 "salary_low": {
 "description": "Salary range lower bound. If salary is not a range both low and high values will be the same.",
 "type": [
 "number",
 "null"
 ]
 },
 "salary_high": {
 "description": "Salary range upper bound.",
 "type": [
 "number",
 "null"
 ]
 },
 "salary_currency": {
 "description": "Salary currency.",
 "type": [
 "string",
 "null"
 ]
 },
 "salary_low_usd": {
 "description": "Salary range lower bound, converted to USD.",
 "type": [
 "number",
 "null"
 ]
 },
 "salary_high_usd": {
 "description": "Salary range upper bound, converted to USD.",
 "type": [
 "number",
 "null"
 ]
 },
 "salary_time_unit": {
 "description": "Salary time unit.",
 "enum": [
 "hour",
 "day",
 "week",
 "month",
 "year",
 null
 ]
 }
 }
 },
 "seniority": {
 "description": "Seniority inferred from the job opening title.",
 "type": [
 "string",
 "null"
 ]
 },
 "status": {
 "description": "null or \"closed\" if keyword \"job no longer available\", \"vacancy listing expired\", \"position filled\", etc. is found on job opening site.",
 "enum": [
 "closed",
 null
 ]
 },
 "language": {
 "description": "Language in which a job opening description is written.",
 "type": [
 "string",
 "null"
 ]
 },
 "location": {
 "description": "Raw location string.",
 "type": [
 "string",
 "null"
 ]
 },
 "location_data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "city",
 "state",
 "zip_code",
 "country",
 "region",
 "continent",
 "fuzzy_match"
 ],
 "properties": {
 "city": {
 "type": [
 "string",
 "null"
 ]
 },
 "state": {
 "type": [
 "string",
 "null"
 ]
 },
 "zip_code": {
 "type": [
 "string",
 "null"
 ]
 },
 "country": {
 "type": [
 "string",
 "null"
 ]
 },
 "region": {
 "type": [
 "string",
 "null"
 ]
 },
 "continent": {
 "type": [
 "string",
 "null"
 ]
 },
 "fuzzy_match": {
 "type": [
 "boolean",
 "null"
 ]
 }
 }
 }
 },
 "tags": {
 "description": "Includes keywords found under job opening description.",
 "type": "array",
 "items": [
 {
 "type": "string"
 }
 ]
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `JobOpeningsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "4d5ac23c-5824-427d-96c6-4e8d50a4241a",
 "type": "job_opening",
 "attributes": {
 "title": "AI Engineer",
 "description": "**AI Engineer**\n\n\n**$50K - $120K** / 0.10% - 0.50% **Location** London, England, GB **Job Type** Full-time **Experience** Any (new grads ok) Apply to Terra API and hundreds of other fast-growing YC startups with a single profile. ****\n\nAPI for developers to connect to health data from wearables and…\n\n\n**About the role**\n\nWe work in super small teams, with extremely high velocity.\n\nWe are building multiple AI products, such as OdinAI, Graph API, and many more\n\nAs an AI engineer, you'll work in a small team, with maximum autonomy.\n\n* Be behind the curtain, creating, testing, and implementing AI models\n* Engage in data analysis, machine learning, and natural language processing.\n* Fine-tuning the AI's performance and many more\n\nPreferred background:\n\nBachelor's or Master's degree in STEM. Strong technical skills (e.g. familiarity with a programming language such as Python, JavaScript, or Ruby) Experience with growth marketing, product development, and user acquisition/retention\n\n\n**Must haves.**\n\n-Must have done this before, or be willing to learn fast.\n\n-Must be fast. We operate at 200mph, and so do you.\n\n-Must be relentless. We never stop, so you are even faster than us.\n\n-Must have customer driven. We think customers first and so should you.\n\n-Must be driven and go above and beyond.\n\n-Must be able to explain and communicate clearly.\n\n-Must be prepared to challenge us and disagree. We are thinking and acting as a team.\n\n-Must be able to work autonomously.\n\n-Must want to work hard.\n\n-Last but not least, you are genuinely a nice person.\n\n**Big plus** You are an athlete, or care about quantifying your data\n\n\n**About Terra API**\n\n**What we do**\n\nTerra is an API that makes it easy for apps to connect to wearables. Currently, apps and developers in the fitness, wellness, sleep, and other health spaces are using us. Terra was launched in early 2021, and since then we’ve been growing like crazy. But this is just the beginning.\n\n\n**The goal and vision**\n\nThink if Spotify and Netflix create music and movies based on your heart rate, and stress levels, in real time. We want to enable apps to achieve that reality, through our super easy to use API.\n\n\n**Funding**\n\nTo achieve our grand goal, we couldn’t have made it without the support from some incredible investors. We are lucky enough to be supported by , , and we were part of batch.\n\n, and learn who we are \n\nLocation: London, United Kingdom",
 "url": "https://www.ycombinator.com/companies/terra-api/jobs/0f5CP0r-ai-engineer",
 "first_seen_at": "2024-11-18T20:06:48Z",
 "last_seen_at": "2024-11-20T20:10:37Z",
 "last_processed_at": "2024-11-20T20:18:00Z",
 "contract_types": [
 "full time"
 ],
 "categories": [
 "engineering"
 ],
 "onet_data": {
 "code": "15-1252.00",
 "family": "Computer and Mathematical",
 "occupation_name": "Software Developers"
 },
 "salary": "$50000 - $120000",
 "salary_data": {
 "salary_low": 50000.0,
 "salary_high": 120000.0,
 "salary_currency": "USD",
 "salary_low_usd": 50000.0,
 "salary_high_usd": 120000.0,
 "salary_time_unit": "year"
 },
 "seniority": "non_manager",
 "status": "closed",
 "language": "en",
 "location": "London, United Kingdom",
 "location_data": [
 {
 "city": "London",
 "state": null,
 "zip_code": null,
 "country": "United Kingdom",
 "region": null,
 "continent": null,
 "fuzzy_match": false
 }
 ],
 "tags": [
 "Growth",
 "Python",
 "Ruby",
 "JavaScript"
 ]
 },
 "relationships": {
 "company": {
 "data": {
 "id": "eb383981-96cf-5d24-8e09-15f71f35879e",
 "type": "company"
 }
 }
 }
 }
 ],
 "included": [
 {
 "id": "eb383981-96cf-5d24-8e09-15f71f35879e",
 "type": "company",
 "attributes": {
 "domain": "tryterra.co",
 "company_name": "Terra Enabling Developers, Ltd.",
 "ticker": null
 }
 }
 ],
 "meta": {
 "schema_version": "3.0",
 "record_state": "active"
 }
 }
}

3.4.2.
Retrieve a single Job Opening

Returns a single Job Opening.


GET

https://predictleads.com/api/v3/job_openings/{id}

Path Parameters
`id` `string` Format: `uuid` JobOpening's ID.

Request Examples

Response Examples

Request was successfully processed.

{
  "data": [
    {
      "id": "4d5ac23c-5824-427d-96c6-4e8d50a4241a",
      "type": "job_opening",
      "attributes": {
        "title": "AI Engineer",
        "description": "**AI Engineer**\n\n\n**$50K - $120K** /  0.10% - 0.50%  **Location** London, England, GB  **Job Type** Full-time  **Experience** Any (new grads ok)   Apply to Terra API and hundreds of other fast-growing YC startups with a single profile.    ****\n\nAPI for developers to connect to health data from wearables and…\n\n\n**About the role**\n\nWe work in super small teams, with extremely high velocity.\n\nWe are building multiple AI products, such as OdinAI, Graph API, and many more\n\nAs an AI engineer, you'll work in a small team, with maximum autonomy.\n\n* Be behind the curtain, creating, testing, and implementing AI models\n* Engage in data analysis, machine learning, and natural language processing.\n* Fine-tuning the AI's performance and many more\n\nPreferred background:\n\nBachelor's or Master's degree in STEM. Strong technical skills (e.g. familiarity with a programming language such as Python, JavaScript, or Ruby) Experience with growth marketing, product development, and user acquisition/retention\n\n\n**Must haves.**\n\n-Must have done this before, or be willing to learn fast.\n\n-Must be fast. We operate at 200mph, and so do you.\n\n-Must be relentless. We never stop, so you are even faster than us.\n\n-Must have customer driven. We think customers first and so should you.\n\n-Must be driven and go above and beyond.\n\n-Must be able to explain and communicate clearly.\n\n-Must be prepared to challenge us and disagree. We are thinking and acting as a team.\n\n-Must be able to work autonomously.\n\n-Must want to work hard.\n\n-Last but not least, you are genuinely a nice person.\n\n**Big plus** You are an athlete, or care about quantifying your data\n\n\n**About Terra API**\n\n**What we do**\n\nTerra is an API that makes it easy for apps to connect to wearables. Currently, apps and developers in the fitness, wellness, sleep, and other health spaces are using us. Terra was launched in early 2021, and since then we’ve been growing like crazy. But this is just the beginning.\n\n\n**The goal and vision**\n\nThink if Spotify and Netflix create music and movies based on your heart rate, and stress levels, in real time. We want to enable apps to achieve that reality, through our super easy to use API.\n\n\n**Funding**\n\nTo achieve our grand goal, we couldn’t have made it without the support from some incredible investors. We are lucky enough to be supported by , ,  and we were part of  batch.\n\n, and learn who we are \n\nLocation: London, United Kingdom",
        "url": "https://www.ycombinator.com/companies/terra-api/jobs/0f5CP0r-ai-engineer",
        "first_seen_at": "2024-11-18T20:06:48Z",
        "last_seen_at": "2024-11-20T20:10:37Z",
        "last_processed_at": "2024-11-20T20:18:00Z",
        "contract_types": [
          "full time"
        ],
        "categories": [
          "engineering"
        ],
        "onet_data": {
          "code": "15-1252.00",
          "family": "Computer and Mathematical",
          "occupation_name": "Software Developers"
        },
        "salary": "$50000 - $120000",
        "salary_data": {
          "salary_low": 50000.0,
          "salary_high": 120000.0,
          "salary_currency": "USD",
          "salary_low_usd": 50000.0,
          "salary_high_usd": 120000.0,
          "salary_time_unit": "year"
        },
        "seniority": "non_manager",
        "status": "closed",
        "language": "en",
        "location": "London, United Kingdom",
        "location_data": [
          {
            "city": "London",
            "state": null,
            "zip_code": null,
            "country": "United Kingdom",
            "region": null,
            "continent": null,
            "fuzzy_match": false
          }
        ],
        "tags": [
          "Growth",
          "Python",
          "Ruby",
          "JavaScript"
        ]
      },
      "relationships": {
        "company": {
          "data": {
            "id": "eb383981-96cf-5d24-8e09-15f71f35879e",
            "type": "company"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "eb383981-96cf-5d24-8e09-15f71f35879e",
      "type": "company",
      "attributes": {
        "domain": "tryterra.co",
        "company_name": "Terra Enabling Developers, Ltd.",
        "ticker": null
      }
    }
  ],
  "meta": {
    "schema_version": "3.0",
    "record_state": "active"
  }
}

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about job openings from companies",
 "description": "Job Openings are found on companies' career sites and job boards. Job Openings and other descriptions can\nbe used to identify company investment areas, current priorities and future developments.\n \nProvided are fields like Job Category (marketing, sales, HR, support...), job description, salary, location\nand many more.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `JobOpening` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `JobOpening` object.",
 "const": "job_opening"
 },
 "attributes": {
 "description": "Attributes of `JobOpening` object.",
 "type": "object",
 "required": [
 "title",
 "description",
 "url",
 "first_seen_at",
 "last_seen_at",
 "last_processed_at",
 "contract_types",
 "categories",
 "onet_data",
 "salary",
 "salary_data",
 "seniority",
 "status",
 "language",
 "location",
 "location_data",
 "tags"
 ],
 "properties": {
 "title": {
 "description": "Job title.",
 "type": "string"
 },
 "description": {
 "description": "Job opening description.",
 "type": [
 "string",
 "null"
 ]
 },
 "url": {
 "description": "URL of the web page where the data was found.",
 "type": "string",
 "format": "uri"
 },
 "first_seen_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpening` was first seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpening` was last seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_processed_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpening` was last sent to processing.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "contract_types": {
 "description": "Zero or more types describing the job opening.",
 "example": [
 "full time",
 "remote"
 ],
 "type": "array",
 "items": [
 {
 "type": "string"
 }
 ]
 },
 "categories": {
 "description": "Zero or more organizational categories of the job opening.",
 "example": [
 "finance",
 "data_analysis"
 ],
 "type": "array",
 "items": [
 {
 "type": "string"
 }
 ]
 },
 "onet_data": {
 "description": "Inferred O\\*NET data for this job opening. O\\*NET is a source and standardization of occupational information. More info on the O\\*NET data: onetonline.org.",
 "type": "object",
 "required": [
 "code",
 "family",
 "occupation_name"
 ],
 "properties": {
 "code": {
 "description": "O\\*NET category code representing this job opening.",
 "example": "29-1021.00",
 "type": [
 "string",
 "null"
 ]
 },
 "family": {
 "description": "O\\*NET family name matching the code for this job opening.",
 "example": "Healthcare Practitioners and Technical",
 "type": [
 "string",
 "null"
 ]
 },
 "occupation_name": {
 "description": "O\\*NET occupation name matching the code for this job opening.",
 "example": "Dentists, General",
 "type": [
 "string",
 "null"
 ]
 }
 }
 },
 "salary": {
 "description": "Raw salary string.",
 "example": "£40000 - £50000 GBP",
 "type": [
 "string",
 "null"
 ]
 },
 "salary_data": {
 "description": "Parsed raw salary data.",
 "type": "object",
 "required": [
 "salary_low",
 "salary_high",
 "salary_currency",
 "salary_low_usd",
 "salary_high_usd",
 "salary_time_unit"
 ],
 "properties": {
 "salary_low": {
 "description": "Salary range lower bound. If salary is not a range both low and high values will be the same.",
 "type": [
 "number",
 "null"
 ]
 },
 "salary_high": {
 "description": "Salary range upper bound.",
 "type": [
 "number",
 "null"
 ]
 },
 "salary_currency": {
 "description": "Salary currency.",
 "type": [
 "string",
 "null"
 ]
 },
 "salary_low_usd": {
 "description": "Salary range lower bound, converted to USD.",
 "type": [
 "number",
 "null"
 ]
 },
 "salary_high_usd": {
 "description": "Salary range upper bound, converted to USD.",
 "type": [
 "number",
 "null"
 ]
 },
 "salary_time_unit": {
 "description": "Salary time unit.",
 "enum": [
 "hour",
 "day",
 "week",
 "month",
 "year",
 null
 ]
 }
 }
 },
 "seniority": {
 "description": "Seniority inferred from the job opening title.",
 "type": [
 "string",
 "null"
 ]
 },
 "status": {
 "description": "null or \"closed\" if keyword \"job no longer available\", \"vacancy listing expired\", \"position filled\", etc. is found on job opening site.",
 "enum": [
 "closed",
 null
 ]
 },
 "language": {
 "description": "Language in which a job opening description is written.",
 "type": [
 "string",
 "null"
 ]
 },
 "location": {
 "description": "Raw location string.",
 "type": [
 "string",
 "null"
 ]
 },
 "location_data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "city",
 "state",
 "zip_code",
 "country",
 "region",
 "continent",
 "fuzzy_match"
 ],
 "properties": {
 "city": {
 "type": [
 "string",
 "null"
 ]
 },
 "state": {
 "type": [
 "string",
 "null"
 ]
 },
 "zip_code": {
 "type": [
 "string",
 "null"
 ]
 },
 "country": {
 "type": [
 "string",
 "null"
 ]
 },
 "region": {
 "type": [
 "string",
 "null"
 ]
 },
 "continent": {
 "type": [
 "string",
 "null"
 ]
 },
 "fuzzy_match": {
 "type": [
 "boolean",
 "null"
 ]
 }
 }
 }
 },
 "tags": {
 "description": "Includes keywords found under job opening description.",
 "type": "array",
 "items": [
 {
 "type": "string"
 }
 ]
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `JobOpeningsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "4d5ac23c-5824-427d-96c6-4e8d50a4241a",
 "type": "job_opening",
 "attributes": {
 "title": "AI Engineer",
 "description": "**AI Engineer**\n\n\n**$50K - $120K** / 0.10% - 0.50% **Location** London, England, GB **Job Type** Full-time **Experience** Any (new grads ok) Apply to Terra API and hundreds of other fast-growing YC startups with a single profile. ****\n\nAPI for developers to connect to health data from wearables and…\n\n\n**About the role**\n\nWe work in super small teams, with extremely high velocity.\n\nWe are building multiple AI products, such as OdinAI, Graph API, and many more\n\nAs an AI engineer, you'll work in a small team, with maximum autonomy.\n\n* Be behind the curtain, creating, testing, and implementing AI models\n* Engage in data analysis, machine learning, and natural language processing.\n* Fine-tuning the AI's performance and many more\n\nPreferred background:\n\nBachelor's or Master's degree in STEM. Strong technical skills (e.g. familiarity with a programming language such as Python, JavaScript, or Ruby) Experience with growth marketing, product development, and user acquisition/retention\n\n\n**Must haves.**\n\n-Must have done this before, or be willing to learn fast.\n\n-Must be fast. We operate at 200mph, and so do you.\n\n-Must be relentless. We never stop, so you are even faster than us.\n\n-Must have customer driven. We think customers first and so should you.\n\n-Must be driven and go above and beyond.\n\n-Must be able to explain and communicate clearly.\n\n-Must be prepared to challenge us and disagree. We are thinking and acting as a team.\n\n-Must be able to work autonomously.\n\n-Must want to work hard.\n\n-Last but not least, you are genuinely a nice person.\n\n**Big plus** You are an athlete, or care about quantifying your data\n\n\n**About Terra API**\n\n**What we do**\n\nTerra is an API that makes it easy for apps to connect to wearables. Currently, apps and developers in the fitness, wellness, sleep, and other health spaces are using us. Terra was launched in early 2021, and since then we’ve been growing like crazy. But this is just the beginning.\n\n\n**The goal and vision**\n\nThink if Spotify and Netflix create music and movies based on your heart rate, and stress levels, in real time. We want to enable apps to achieve that reality, through our super easy to use API.\n\n\n**Funding**\n\nTo achieve our grand goal, we couldn’t have made it without the support from some incredible investors. We are lucky enough to be supported by , , and we were part of batch.\n\n, and learn who we are \n\nLocation: London, United Kingdom",
 "url": "https://www.ycombinator.com/companies/terra-api/jobs/0f5CP0r-ai-engineer",
 "first_seen_at": "2024-11-18T20:06:48Z",
 "last_seen_at": "2024-11-20T20:10:37Z",
 "last_processed_at": "2024-11-20T20:18:00Z",
 "contract_types": [
 "full time"
 ],
 "categories": [
 "engineering"
 ],
 "onet_data": {
 "code": "15-1252.00",
 "family": "Computer and Mathematical",
 "occupation_name": "Software Developers"
 },
 "salary": "$50000 - $120000",
 "salary_data": {
 "salary_low": 50000.0,
 "salary_high": 120000.0,
 "salary_currency": "USD",
 "salary_low_usd": 50000.0,
 "salary_high_usd": 120000.0,
 "salary_time_unit": "year"
 },
 "seniority": "non_manager",
 "status": "closed",
 "language": "en",
 "location": "London, United Kingdom",
 "location_data": [
 {
 "city": "London",
 "state": null,
 "zip_code": null,
 "country": "United Kingdom",
 "region": null,
 "continent": null,
 "fuzzy_match": false
 }
 ],
 "tags": [
 "Growth",
 "Python",
 "Ruby",
 "JavaScript"
 ]
 },
 "relationships": {
 "company": {
 "data": {
 "id": "eb383981-96cf-5d24-8e09-15f71f35879e",
 "type": "company"
 }
 }
 }
 }
 ],
 "included": [
 {
 "id": "eb383981-96cf-5d24-8e09-15f71f35879e",
 "type": "company",
 "attributes": {
 "domain": "tryterra.co",
 "company_name": "Terra Enabling Developers, Ltd.",
 "ticker": null
 }
 }
 ],
 "meta": {
 "schema_version": "3.0",
 "record_state": "active"
 }
 }
}

3.5.
News Events Dataset

News Events Dataset API Endpoints

Retrieve company's News Events

GET
/companies/{domain}/news_events

Retrieve a single News Event

GET
/news_events/{id}

3.5.1.
Retrieve company's News Events

Returns a list of company's News Events.


GET

https://predictleads.com/api/v3/companies/{domain}/news_events

Path Parameters
`domain` `string` Company's domain.
Query Parameters
`found_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `NewsEvents` found after given date (ISO 8601).
`found_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `NewsEvents` found before given date (ISO 8601).
`categories` [optional] `array` Comma-separated (,) `NewsEvent` categories.
Items
One of
`string` Constant: `"acquires"` Group name: acquisition Company acquired another company.
`string` Constant: `"merges_with"` Group name: acquisition Company merges with another company.
`string` Constant: `"sells_assets_to"` Group name: acquisition Company sells assets (like properties or warehouses) to other company.
`string` Constant: `"signs_new_client"` Group name: contract Company signs new client.
`string` Constant: `"files_suit_against"` Group name: corporate_challenges Company files suit against other company.
`string` Constant: `"has_issues_with"` Group name: corporate_challenges Company has vulnerability problems.
`string` Constant: `"closes_offices_in"` Group name: cost_cutting Company closes existing offices.
`string` Constant: `"decreases_headcount_by"` Group name: cost_cutting Company lays off employees.
`string` Constant: `"expands_facilities"` Group name: expansion Company opens new or expands existing facilities like warehouses, data centers, manufacturing plants etc.
`string` Constant: `"expands_offices_in"` Group name: expansion Company expands existing offices.
`string` Constant: `"expands_offices_to"` Group name: expansion Company opens new offices in another town, state, country or continent.
`string` Constant: `"increases_headcount_by"` Group name: expansion Company offers new job vacancies.
`string` Constant: `"opens_new_location"` Group name: expansion Company opens new service location like hotels, restaurants, bars, hospitals etc.
`string` Constant: `"goes_public"` Group name: investment Company issues shares to the public for the first time.
`string` Constant: `"invests_into"` Group name: investment Company invests into other company.
`string` Constant: `"invests_into_assets"` Group name: investment Company buys assets (like properties or warehouses) from other company.
`string` Constant: `"receives_financing"` Group name: investment Company receives financing like venture funding, loan, grant etc.
`string` Constant: `"hires"` Group name: leadership Company hired new executive or senior personnel.
`string` Constant: `"leaves"` Group name: leadership Executive or senior personnel left the company.
`string` Constant: `"promotes"` Group name: leadership Company promoted existing executive or senior personnel.
`string` Constant: `"retires_from"` Group name: leadership Executive or senior personnel retire from the company.
`string` Constant: `"integrates_with"` Group name: new_offering Company integrates with other company.
`string` Constant: `"is_developing"` Group name: new_offering Company is developing a new offering.
`string` Constant: `"launches"` Group name: new_offering Company launches new offering.
`string` Constant: `"partners_with"` Group name: partnership Company partners with other company.
`string` Constant: `"receives_award"` Group name: recognition Company or person at the company receives an award.
`string` Constant: `"recognized_as"` Group name: recognition Company or person at the company receives recognition.
`string` Constant: `"identified_as_competitor_of"` Group name: relational New or existing competitor was identified.
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Request was successfully processed.

{
  "data": [
    {
      "id": "f096ea55-f81b-4f6a-83bd-d5c1cdc10143",
      "type": "news_event",
      "attributes": {
        "summary": "Klasha Inc. expands offices in Ghana.",
        "category": "expands_offices_in",
        "found_at": "2021-10-19T22:00:00Z",
        "confidence": 0.6872,
        "article_sentence": "San Francisco and Lagos-based cross-border technology company Klasha is further expanding its presence in Africa with the launch of its services in Ghana.",
        "human_approved": false,
        "planning": false,
        "amount": null,
        "amount_normalized": null,
        "assets": null,
        "assets_tags": [

],
        "award": null,
        "contact": null,
        "conference": null,
        "division": null,
        "effective_date": null,
        "financing_type": null,
        "financing_type_normalized": null,
        "financing_type_tags": [

],
        "headcount": null,
        "job_title": null,
        "job_title_tags": [

],
        "location": "Ghana",
        "location_data": [
          {
            "city": null,
            "state": null,
            "zip_code": null,
            "country": "Ghana",
            "region": null,
            "continent": null,
            "fuzzy_match": false
          }
        ],
        "product": null,
        "product_data": {
          "full_text": null,
          "name": null,
          "release_type": null,
          "release_version": null,
          "fuzzy_match": null
        },
        "product_tags": [

],
        "recognition": null,
        "vulnerability": null
      },
      "relationships": {
        "company1": {
          "data": {
            "id": "0db9ccc3-0c5f-5481-89da-b08e2a4195b8",
            "type": "company"
          }
        },
        "most_relevant_source": {
          "data": {
            "id": "797aa0af-c7f3-4b77-8a04-3f8bb39b315a",
            "type": "news_article"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "0db9ccc3-0c5f-5481-89da-b08e2a4195b8",
      "type": "company",
      "attributes": {
        "domain": "klasha.com",
        "company_name": "Klasha Inc.",
        "ticker": null
      }
    },
    {
      "id": "797aa0af-c7f3-4b77-8a04-3f8bb39b315a",
      "type": "news_article",
      "attributes": {
        "author": null,
        "body": "Payfare, which offers banking solutions for gig workforce, has announced that it is integrating with Plaid, a data transfer network that powers fintech and digital finance products. The integration will… Technology company TraQiQ has introduced its online payment solution 'TraQPayments' in Latin America. TraQPayments is… American Express has partnered with Goldman Sachs Transaction Banking (TxB) to offer an integrated payments solution to large corporate clients. Barclaycard Payments and SAP is expanding their cooperation in a bid to boost payment acceptance capabilities and enhance procure-to-pay processes. UK-based fintech firm Previse has tapped Mastercard to provide instant payments to suppliers in more than 100 markets globally. Latin America-based payment processor PayRetailers has entered into an alliance with European payment giant Worldline. Buy now pay later (BNPL) firm Klarna has introduced ‘pay now’ option in the UK. Western Union International Bank (WUIB) has expanded its real-time payment capabilities in Europe by joining the Single Euro Payments Area (SEPA) Instant Credit Transfer scheme (SCT Inst). San Francisco and Lagos-based cross-border technology company Klasha is further expanding its presence in Africa with the launch of its services in Ghana.",
        "image_url": null,
        "url": "https://www.electronicpaymentsinternational.com/news/company-news/",
        "published_at": "2021-10-19T04:00:00Z",
        "title": "Company news Archives"
      }
    }
  ],
  "meta": {
    "schema_version": "3.0",
    "record_state": "active"
  }
}

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about news related to companies",
 "description": "News Events are categorized events found in News Articles from various sources such as press releases, industry news, blogs and PR sites.\n \nAll events are provided in a structured format for all categories and always include company domain name to which the News Event belongs.\n \nBecause of the structured nature the News Events are better deduplicated and there is high signal to noise ratio.\n \nNews Event signals also include News Article title, body, author and more.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `NewsEvent` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `NewsEvent` object.",
 "const": "news_event"
 },
 "attributes": {
 "description": "Attributes of `NewsEvent` object.",
 "type": "object",
 "required": [
 "summary",
 "category",
 "found_at",
 "confidence",
 "article_sentence",
 "human_approved",
 "planning",
 "amount",
 "amount_normalized",
 "assets",
 "assets_tags",
 "award",
 "contact",
 "conference",
 "effective_date",
 "division",
 "financing_type",
 "financing_type_normalized",
 "financing_type_tags",
 "headcount",
 "job_title",
 "job_title_tags",
 "location",
 "location_data",
 "product",
 "product_data",
 "product_tags",
 "recognition",
 "vulnerability"
 ],
 "properties": {
 "summary": {
 "description": "A short, human readable excerpt of this `NewsEvent` data.",
 "type": "string"
 },
 "category": {
 "description": "Name of the category this `NewsEvent` represents.",
 "type": "string",
 "example": "invests_into",
 "oneOf": [
 {
 "const": "acquires",
 "description": "**Group name**: acquisition Company acquired another company."
 },
 {
 "const": "merges_with",
 "description": "**Group name**: acquisition Company merges with another company."
 },
 {
 "const": "sells_assets_to",
 "description": "**Group name**: acquisition Company sells assets (like properties or warehouses) to other company."
 },
 {
 "const": "signs_new_client",
 "description": "**Group name**: contract Company signs new client."
 },
 {
 "const": "files_suit_against",
 "description": "**Group name**: corporate_challenges Company files suit against other company."
 },
 {
 "const": "has_issues_with",
 "description": "**Group name**: corporate_challenges Company has vulnerability problems."
 },
 {
 "const": "closes_offices_in",
 "description": "**Group name**: cost_cutting Company closes existing offices."
 },
 {
 "const": "decreases_headcount_by",
 "description": "**Group name**: cost_cutting Company lays off employees."
 },
 {
 "const": "expands_facilities",
 "description": "**Group name**: expansion Company opens new or expands existing facilities like warehouses, data centers, manufacturing plants etc."
 },
 {
 "const": "expands_offices_in",
 "description": "**Group name**: expansion Company expands existing offices."
 },
 {
 "const": "expands_offices_to",
 "description": "**Group name**: expansion Company opens new offices in another town, state, country or continent."
 },
 {
 "const": "increases_headcount_by",
 "description": "**Group name**: expansion Company offers new job vacancies."
 },
 {
 "const": "opens_new_location",
 "description": "**Group name**: expansion Company opens new service location like hotels, restaurants, bars, hospitals etc."
 },
 {
 "const": "goes_public",
 "description": "**Group name**: investment Company issues shares to the public for the first time."
 },
 {
 "const": "invests_into",
 "description": "**Group name**: investment Company invests into other company."
 },
 {
 "const": "invests_into_assets",
 "description": "**Group name**: investment Company buys assets (like properties or warehouses) from other company."
 },
 {
 "const": "receives_financing",
 "description": "**Group name**: investment Company receives financing like venture funding, loan, grant etc."
 },
 {
 "const": "hires",
 "description": "**Group name**: leadership Company hired new executive or senior personnel."
 },
 {
 "const": "leaves",
 "description": "**Group name**: leadership Executive or senior personnel left the company."
 },
 {
 "const": "promotes",
 "description": "**Group name**: leadership Company promoted existing executive or senior personnel."
 },
 {
 "const": "retires_from",
 "description": "**Group name**: leadership Executive or senior personnel retire from the company."
 },
 {
 "const": "integrates_with",
 "description": "**Group name**: new_offering Company integrates with other company."
 },
 {
 "const": "is_developing",
 "description": "**Group name**: new_offering Company is developing a new offering."
 },
 {
 "const": "launches",
 "description": "**Group name**: new_offering Company launches new offering."
 },
 {
 "const": "partners_with",
 "description": "**Group name**: partnership Company partners with other company."
 },
 {
 "const": "receives_award",
 "description": "**Group name**: recognition Company or person at the company receives an award."
 },
 {
 "const": "recognized_as",
 "description": "**Group name**: recognition Company or person at the company receives recognition."
 },
 {
 "const": "identified_as_competitor_of",
 "description": "**Group name**: relational New or existing competitor was identified."
 }
 ]
 },
 "found_at": {
 "description": "Date & time (ISO 8601) when the `NewsEvent` was discovered and created.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "confidence": {
 "description": "Floating point number of confidence. Currently PredictLeads takes care of limiting the\nNewsEvents so as to have a good balance between match rate and accuracy.\nThus we do not recommend filtering NewsEvents further based on this confidence.\n",
 "type": [
 "number"
 ],
 "minimum": 0,
 "maximum": 1
 },
 "article_sentence": {
 "description": "Sentence in the article where `NewsEvent` information was found.",
 "type": "string"
 },
 "human_approved": {
 "description": "If true, this `NewsEvent` has been manually verified by a human.",
 "type": "boolean"
 },
 "planning": {
 "description": "When true, the `NewsEvent` is planned to happen.",
 "type": [
 "boolean"
 ],
 "example": "The company might plan to launch a product in December."
 },
 "amount": {
 "description": "This is a string of a value as extracted from text.",
 "example": "$1.8 million",
 "type": [
 "string",
 "null"
 ]
 },
 "amount_normalized": {
 "description": "Integer value of \"amount\" property.",
 "example": 18000000,
 "type": [
 "integer",
 "null"
 ]
 },
 "assets": {
 "description": "Assets found in the NewsEvent.",
 "example": "hydrogen production facility",
 "type": [
 "string",
 "null"
 ]
 },
 "assets_tags": {
 "description": "An array of assets tags extracted from \"assets\" property.",
 "example": [
 "production"
 ],
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "award": {
 "description": "Award type this `NewsEvent` is announcing.",
 "example": "Pierre Potier Award",
 "type": [
 "string",
 "null"
 ]
 },
 "contact": {
 "description": "Person name that the `NewsEvent` mentions.",
 "example": "Elon Musk",
 "type": [
 "string",
 "null"
 ]
 },
 "conference": {
 "description": "Conference name where the `NewsEvent` was mentioned at.",
 "example": "World Business Outlook Awards",
 "type": [
 "string",
 "null"
 ]
 },
 "effective_date": {
 "description": "Date (ISO 8601) the `NewsEvent` is mentioning.",
 "type": [
 "string",
 "null"
 ],
 "format": "date",
 "example": "2024-09-25"
 },
 "division": {
 "description": "Whether `NewsEvent` concerns a specific division.",
 "type": [
 "string",
 "null"
 ]
 },
 "financing_type": {
 "description": "A financing type this `NewsEvent` is mentioning.",
 "example": "Series B funding",
 "type": [
 "string",
 "null"
 ]
 },
 "financing_type_normalized": {
 "description": "A normalized value of `financing_type` property, where possible.",
 "enum": [
 "pre_angel",
 "angel",
 "angel1",
 "angel2",
 "angel3",
 "pre_seed",
 "seed",
 "seed1",
 "seed2",
 "seed3",
 "pre_series_a",
 "series_a",
 "series_a1",
 "series_a2",
 "series_a3",
 "pre_series_b",
 "series_b",
 "series_b1",
 "series_b2",
 "series_b3",
 "pre_series_c",
 "series_c",
 "series_c1",
 "series_c2",
 "series_c3",
 "pre_series_d",
 "series_d",
 "series_d1",
 "series_d2",
 "series_d3",
 "pre_series_e",
 "series_e",
 "series_e1",
 "series_e2",
 "series_e3",
 "pre_series_f",
 "series_f",
 "series_f1",
 "series_f2",
 "series_f3",
 "pre_series_g",
 "series_g",
 "series_g1",
 "series_g2",
 "series_g3",
 "pre_series_h",
 "series_h",
 "series_h1",
 "series_h2",
 "series_h3",
 "pre_series_i",
 "series_i",
 "series_i1",
 "series_i2",
 "series_i3",
 "pre_series_j",
 "series_j",
 "series_j1",
 "series_j2",
 "series_j3",
 null
 ],
 "example": "series_b"
 },
 "financing_type_tags": {
 "description": "An array of financing type categories.",
 "example": [
 "equity"
 ],
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "headcount": {
 "description": "A number of people mentioned organization is involved with.",
 "example": 213,
 "type": [
 "integer",
 "null"
 ]
 },
 "job_title": {
 "description": "Job title this `NewsEvent` is mentioning.",
 "example": "Director of Media and Analytics",
 "type": [
 "string",
 "null"
 ]
 },
 "job_title_tags": {
 "description": "An array of job title tags.",
 "example": [
 "marketing",
 "directors"
 ],
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "location": {
 "description": "Location of where the `NewsEvent` happened or where the organization has expanded/relocated.",
 "example": "Menlo Park, California, United States",
 "type": [
 "string",
 "null"
 ]
 },
 "location_data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "city",
 "state",
 "zip_code",
 "country",
 "region",
 "continent",
 "fuzzy_match"
 ],
 "properties": {
 "city": {
 "type": [
 "string",
 "null"
 ]
 },
 "state": {
 "type": [
 "string",
 "null"
 ]
 },
 "zip_code": {
 "type": [
 "string",
 "null"
 ]
 },
 "country": {
 "type": [
 "string",
 "null"
 ]
 },
 "region": {
 "type": [
 "string",
 "null"
 ]
 },
 "continent": {
 "type": [
 "string",
 "null"
 ]
 },
 "fuzzy_match": {
 "type": [
 "boolean",
 "null"
 ]
 }
 }
 }
 },
 "product": {
 "description": "Name of the product as mentioned by this NewsEvent.",
 "example": "Credit Pass",
 "type": [
 "string",
 "null"
 ]
 },
 "product_data": {
 "type": "object",
 "required": [
 "full_text",
 "name",
 "release_type",
 "release_version",
 "fuzzy_match"
 ],
 "properties": {
 "full_text": {
 "description": "Full product name as recognized by Named Entity Recognition, without further cleaning of the product name.",
 "example": "3D printing service for spare parts",
 "type": [
 "string",
 "null"
 ]
 },
 "name": {
 "description": "Cleaned name of the product referenced in the NewsEvent.",
 "example": "VideoPoet",
 "type": [
 "string",
 "null"
 ]
 },
 "release_type": {
 "description": "Product release type.",
 "example": "major",
 "type": [
 "string",
 "null"
 ]
 },
 "release_version": {
 "description": "Product release version.",
 "example": "v3.0",
 "type": [
 "string",
 "null"
 ]
 },
 "fuzzy_match": {
 "description": "When true we might not have extracted the product name cleanly. When false exact product name should be extracted well.",
 "type": [
 "boolean",
 "null"
 ]
 }
 }
 },
 "product_tags": {
 "description": "List of tags regarding the product.",
 "example": [
 "mobile",
 "online_technology"
 ],
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "recognition": {
 "description": "Name of the recognition the company received.",
 "example": "50 Smartest Companies",
 "type": [
 "string",
 "null"
 ]
 },
 "vulnerability": {
 "description": "Company issue.",
 "example": "account suspension errors",
 "type": [
 "string",
 "null"
 ]
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "most_relevant_source"
 ],
 "properties": {
 "company1": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "company2": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "most_relevant_source": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `NewsArticleLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `NewsArticleLite` object.",
 "const": "news_article"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "oneOf": [
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 },
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `NewsArticleLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `NewsArticleLite` object.",
 "const": "news_article"
 },
 "attributes": {
 "description": "Attributes of `NewsArticleLite` object.",
 "type": "object",
 "required": [
 "url",
 "title",
 "author",
 "image_url",
 "published_at",
 "body"
 ],
 "properties": {
 "url": {
 "description": "News Article source URL.",
 "type": "string",
 "format": "uri"
 },
 "title": {
 "description": "Prettified News Article title or heading.",
 "type": "string"
 },
 "author": {
 "description": "News Article author name.",
 "type": [
 "string",
 "null"
 ]
 },
 "image_url": {
 "description": "News Article most relevant image URL.",
 "type": [
 "string",
 "null"
 ]
 },
 "published_at": {
 "description": "Date & time (ISO 8601) when NewsArticle was published.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "body": {
 "description": "News Article text (article content).",
 "type": "string"
 }
 }
 }
 }
 }
 ],
 "discriminator": {
 "propertyName": "type"
 }
 }
 },
 "meta": {
 "description": "Meta information about `NewsEventsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "f096ea55-f81b-4f6a-83bd-d5c1cdc10143",
 "type": "news_event",
 "attributes": {
 "summary": "Klasha Inc. expands offices in Ghana.",
 "category": "expands_offices_in",
 "found_at": "2021-10-19T22:00:00Z",
 "confidence": 0.6872,
 "article_sentence": "San Francisco and Lagos-based cross-border technology company Klasha is further expanding its presence in Africa with the launch of its services in Ghana.",
 "human_approved": false,
 "planning": false,
 "amount": null,
 "amount_normalized": null,
 "assets": null,
 "assets_tags": [

],
          "award": null,
          "contact": null,
          "conference": null,
          "division": null,
          "effective_date": null,
          "financing_type": null,
          "financing_type_normalized": null,
          "financing_type_tags": [

],
          "headcount": null,
          "job_title": null,
          "job_title_tags": [

],
          "location": "Ghana",
          "location_data": [
            {
              "city": null,
              "state": null,
              "zip_code": null,
              "country": "Ghana",
              "region": null,
              "continent": null,
              "fuzzy_match": false
            }
          ],
          "product": null,
          "product_data": {
            "full_text": null,
            "name": null,
            "release_type": null,
            "release_version": null,
            "fuzzy_match": null
          },
          "product_tags": [

],
          "recognition": null,
          "vulnerability": null
        },
        "relationships": {
          "company1": {
            "data": {
              "id": "0db9ccc3-0c5f-5481-89da-b08e2a4195b8",
              "type": "company"
            }
          },
          "most_relevant_source": {
            "data": {
              "id": "797aa0af-c7f3-4b77-8a04-3f8bb39b315a",
              "type": "news_article"
            }
          }
        }
      }
    ],
    "included": [
      {
        "id": "0db9ccc3-0c5f-5481-89da-b08e2a4195b8",
        "type": "company",
        "attributes": {
          "domain": "klasha.com",
          "company_name": "Klasha Inc.",
          "ticker": null
        }
      },
      {
        "id": "797aa0af-c7f3-4b77-8a04-3f8bb39b315a",
        "type": "news_article",
        "attributes": {
          "author": null,
          "body": "Payfare, which offers banking solutions for gig workforce, has announced that it is integrating with Plaid, a data transfer network that powers fintech and digital finance products. The integration will… Technology company TraQiQ has introduced its online payment solution 'TraQPayments' in Latin America. TraQPayments is… American Express has partnered with Goldman Sachs Transaction Banking (TxB) to offer an integrated payments solution to large corporate clients. Barclaycard Payments and SAP is expanding their cooperation in a bid to boost payment acceptance capabilities and enhance procure-to-pay processes. UK-based fintech firm Previse has tapped Mastercard to provide instant payments to suppliers in more than 100 markets globally. Latin America-based payment processor PayRetailers has entered into an alliance with European payment giant Worldline. Buy now pay later (BNPL) firm Klarna has introduced ‘pay now’ option in the UK. Western Union International Bank (WUIB) has expanded its real-time payment capabilities in Europe by joining the Single Euro Payments Area (SEPA) Instant Credit Transfer scheme (SCT Inst). San Francisco and Lagos-based cross-border technology company Klasha is further expanding its presence in Africa with the launch of its services in Ghana.",
          "image_url": null,
          "url": "https://www.electronicpaymentsinternational.com/news/company-news/",
          "published_at": "2021-10-19T04:00:00Z",
          "title": "Company news Archives"
        }
      }
    ],
    "meta": {
      "schema_version": "3.0",
      "record_state": "active"
    }
  }
}

3.5.2.
Retrieve a single News Event

Returns specific News Event.


GET

https://predictleads.com/api/v3/news_events/{id}

Path Parameters
`id` `string` Format: `uuid` NewsEvent's ID.

Request Examples

Response Examples

Request was successfully processed.

{
  "data": [
    {
      "id": "f096ea55-f81b-4f6a-83bd-d5c1cdc10143",
      "type": "news_event",
      "attributes": {
        "summary": "Klasha Inc. expands offices in Ghana.",
        "category": "expands_offices_in",
        "found_at": "2021-10-19T22:00:00Z",
        "confidence": 0.6872,
        "article_sentence": "San Francisco and Lagos-based cross-border technology company Klasha is further expanding its presence in Africa with the launch of its services in Ghana.",
        "human_approved": false,
        "planning": false,
        "amount": null,
        "amount_normalized": null,
        "assets": null,
        "assets_tags": [

],
        "award": null,
        "contact": null,
        "conference": null,
        "division": null,
        "effective_date": null,
        "financing_type": null,
        "financing_type_normalized": null,
        "financing_type_tags": [

],
        "headcount": null,
        "job_title": null,
        "job_title_tags": [

],
        "location": "Ghana",
        "location_data": [
          {
            "city": null,
            "state": null,
            "zip_code": null,
            "country": "Ghana",
            "region": null,
            "continent": null,
            "fuzzy_match": false
          }
        ],
        "product": null,
        "product_data": {
          "full_text": null,
          "name": null,
          "release_type": null,
          "release_version": null,
          "fuzzy_match": null
        },
        "product_tags": [

],
        "recognition": null,
        "vulnerability": null
      },
      "relationships": {
        "company1": {
          "data": {
            "id": "0db9ccc3-0c5f-5481-89da-b08e2a4195b8",
            "type": "company"
          }
        },
        "most_relevant_source": {
          "data": {
            "id": "797aa0af-c7f3-4b77-8a04-3f8bb39b315a",
            "type": "news_article"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "0db9ccc3-0c5f-5481-89da-b08e2a4195b8",
      "type": "company",
      "attributes": {
        "domain": "klasha.com",
        "company_name": "Klasha Inc.",
        "ticker": null
      }
    },
    {
      "id": "797aa0af-c7f3-4b77-8a04-3f8bb39b315a",
      "type": "news_article",
      "attributes": {
        "author": null,
        "body": "Payfare, which offers banking solutions for gig workforce, has announced that it is integrating with Plaid, a data transfer network that powers fintech and digital finance products. The integration will… Technology company TraQiQ has introduced its online payment solution 'TraQPayments' in Latin America. TraQPayments is… American Express has partnered with Goldman Sachs Transaction Banking (TxB) to offer an integrated payments solution to large corporate clients. Barclaycard Payments and SAP is expanding their cooperation in a bid to boost payment acceptance capabilities and enhance procure-to-pay processes. UK-based fintech firm Previse has tapped Mastercard to provide instant payments to suppliers in more than 100 markets globally. Latin America-based payment processor PayRetailers has entered into an alliance with European payment giant Worldline. Buy now pay later (BNPL) firm Klarna has introduced ‘pay now’ option in the UK. Western Union International Bank (WUIB) has expanded its real-time payment capabilities in Europe by joining the Single Euro Payments Area (SEPA) Instant Credit Transfer scheme (SCT Inst). San Francisco and Lagos-based cross-border technology company Klasha is further expanding its presence in Africa with the launch of its services in Ghana.",
        "image_url": null,
        "url": "https://www.electronicpaymentsinternational.com/news/company-news/",
        "published_at": "2021-10-19T04:00:00Z",
        "title": "Company news Archives"
      }
    }
  ],
  "meta": {
    "schema_version": "3.0",
    "record_state": "active"
  }
}

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about news related to companies",
 "description": "News Events are categorized events found in News Articles from various sources such as press releases, industry news, blogs and PR sites.\n \nAll events are provided in a structured format for all categories and always include company domain name to which the News Event belongs.\n \nBecause of the structured nature the News Events are better deduplicated and there is high signal to noise ratio.\n \nNews Event signals also include News Article title, body, author and more.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `NewsEvent` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `NewsEvent` object.",
 "const": "news_event"
 },
 "attributes": {
 "description": "Attributes of `NewsEvent` object.",
 "type": "object",
 "required": [
 "summary",
 "category",
 "found_at",
 "confidence",
 "article_sentence",
 "human_approved",
 "planning",
 "amount",
 "amount_normalized",
 "assets",
 "assets_tags",
 "award",
 "contact",
 "conference",
 "effective_date",
 "division",
 "financing_type",
 "financing_type_normalized",
 "financing_type_tags",
 "headcount",
 "job_title",
 "job_title_tags",
 "location",
 "location_data",
 "product",
 "product_data",
 "product_tags",
 "recognition",
 "vulnerability"
 ],
 "properties": {
 "summary": {
 "description": "A short, human readable excerpt of this `NewsEvent` data.",
 "type": "string"
 },
 "category": {
 "description": "Name of the category this `NewsEvent` represents.",
 "type": "string",
 "example": "invests_into",
 "oneOf": [
 {
 "const": "acquires",
 "description": "**Group name**: acquisition Company acquired another company."
 },
 {
 "const": "merges_with",
 "description": "**Group name**: acquisition Company merges with another company."
 },
 {
 "const": "sells_assets_to",
 "description": "**Group name**: acquisition Company sells assets (like properties or warehouses) to other company."
 },
 {
 "const": "signs_new_client",
 "description": "**Group name**: contract Company signs new client."
 },
 {
 "const": "files_suit_against",
 "description": "**Group name**: corporate_challenges Company files suit against other company."
 },
 {
 "const": "has_issues_with",
 "description": "**Group name**: corporate_challenges Company has vulnerability problems."
 },
 {
 "const": "closes_offices_in",
 "description": "**Group name**: cost_cutting Company closes existing offices."
 },
 {
 "const": "decreases_headcount_by",
 "description": "**Group name**: cost_cutting Company lays off employees."
 },
 {
 "const": "expands_facilities",
 "description": "**Group name**: expansion Company opens new or expands existing facilities like warehouses, data centers, manufacturing plants etc."
 },
 {
 "const": "expands_offices_in",
 "description": "**Group name**: expansion Company expands existing offices."
 },
 {
 "const": "expands_offices_to",
 "description": "**Group name**: expansion Company opens new offices in another town, state, country or continent."
 },
 {
 "const": "increases_headcount_by",
 "description": "**Group name**: expansion Company offers new job vacancies."
 },
 {
 "const": "opens_new_location",
 "description": "**Group name**: expansion Company opens new service location like hotels, restaurants, bars, hospitals etc."
 },
 {
 "const": "goes_public",
 "description": "**Group name**: investment Company issues shares to the public for the first time."
 },
 {
 "const": "invests_into",
 "description": "**Group name**: investment Company invests into other company."
 },
 {
 "const": "invests_into_assets",
 "description": "**Group name**: investment Company buys assets (like properties or warehouses) from other company."
 },
 {
 "const": "receives_financing",
 "description": "**Group name**: investment Company receives financing like venture funding, loan, grant etc."
 },
 {
 "const": "hires",
 "description": "**Group name**: leadership Company hired new executive or senior personnel."
 },
 {
 "const": "leaves",
 "description": "**Group name**: leadership Executive or senior personnel left the company."
 },
 {
 "const": "promotes",
 "description": "**Group name**: leadership Company promoted existing executive or senior personnel."
 },
 {
 "const": "retires_from",
 "description": "**Group name**: leadership Executive or senior personnel retire from the company."
 },
 {
 "const": "integrates_with",
 "description": "**Group name**: new_offering Company integrates with other company."
 },
 {
 "const": "is_developing",
 "description": "**Group name**: new_offering Company is developing a new offering."
 },
 {
 "const": "launches",
 "description": "**Group name**: new_offering Company launches new offering."
 },
 {
 "const": "partners_with",
 "description": "**Group name**: partnership Company partners with other company."
 },
 {
 "const": "receives_award",
 "description": "**Group name**: recognition Company or person at the company receives an award."
 },
 {
 "const": "recognized_as",
 "description": "**Group name**: recognition Company or person at the company receives recognition."
 },
 {
 "const": "identified_as_competitor_of",
 "description": "**Group name**: relational New or existing competitor was identified."
 }
 ]
 },
 "found_at": {
 "description": "Date & time (ISO 8601) when the `NewsEvent` was discovered and created.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "confidence": {
 "description": "Floating point number of confidence. Currently PredictLeads takes care of limiting the\nNewsEvents so as to have a good balance between match rate and accuracy.\nThus we do not recommend filtering NewsEvents further based on this confidence.\n",
 "type": [
 "number"
 ],
 "minimum": 0,
 "maximum": 1
 },
 "article_sentence": {
 "description": "Sentence in the article where `NewsEvent` information was found.",
 "type": "string"
 },
 "human_approved": {
 "description": "If true, this `NewsEvent` has been manually verified by a human.",
 "type": "boolean"
 },
 "planning": {
 "description": "When true, the `NewsEvent` is planned to happen.",
 "type": [
 "boolean"
 ],
 "example": "The company might plan to launch a product in December."
 },
 "amount": {
 "description": "This is a string of a value as extracted from text.",
 "example": "$1.8 million",
 "type": [
 "string",
 "null"
 ]
 },
 "amount_normalized": {
 "description": "Integer value of \"amount\" property.",
 "example": 18000000,
 "type": [
 "integer",
 "null"
 ]
 },
 "assets": {
 "description": "Assets found in the NewsEvent.",
 "example": "hydrogen production facility",
 "type": [
 "string",
 "null"
 ]
 },
 "assets_tags": {
 "description": "An array of assets tags extracted from \"assets\" property.",
 "example": [
 "production"
 ],
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "award": {
 "description": "Award type this `NewsEvent` is announcing.",
 "example": "Pierre Potier Award",
 "type": [
 "string",
 "null"
 ]
 },
 "contact": {
 "description": "Person name that the `NewsEvent` mentions.",
 "example": "Elon Musk",
 "type": [
 "string",
 "null"
 ]
 },
 "conference": {
 "description": "Conference name where the `NewsEvent` was mentioned at.",
 "example": "World Business Outlook Awards",
 "type": [
 "string",
 "null"
 ]
 },
 "effective_date": {
 "description": "Date (ISO 8601) the `NewsEvent` is mentioning.",
 "type": [
 "string",
 "null"
 ],
 "format": "date",
 "example": "2024-09-25"
 },
 "division": {
 "description": "Whether `NewsEvent` concerns a specific division.",
 "type": [
 "string",
 "null"
 ]
 },
 "financing_type": {
 "description": "A financing type this `NewsEvent` is mentioning.",
 "example": "Series B funding",
 "type": [
 "string",
 "null"
 ]
 },
 "financing_type_normalized": {
 "description": "A normalized value of `financing_type` property, where possible.",
 "enum": [
 "pre_angel",
 "angel",
 "angel1",
 "angel2",
 "angel3",
 "pre_seed",
 "seed",
 "seed1",
 "seed2",
 "seed3",
 "pre_series_a",
 "series_a",
 "series_a1",
 "series_a2",
 "series_a3",
 "pre_series_b",
 "series_b",
 "series_b1",
 "series_b2",
 "series_b3",
 "pre_series_c",
 "series_c",
 "series_c1",
 "series_c2",
 "series_c3",
 "pre_series_d",
 "series_d",
 "series_d1",
 "series_d2",
 "series_d3",
 "pre_series_e",
 "series_e",
 "series_e1",
 "series_e2",
 "series_e3",
 "pre_series_f",
 "series_f",
 "series_f1",
 "series_f2",
 "series_f3",
 "pre_series_g",
 "series_g",
 "series_g1",
 "series_g2",
 "series_g3",
 "pre_series_h",
 "series_h",
 "series_h1",
 "series_h2",
 "series_h3",
 "pre_series_i",
 "series_i",
 "series_i1",
 "series_i2",
 "series_i3",
 "pre_series_j",
 "series_j",
 "series_j1",
 "series_j2",
 "series_j3",
 null
 ],
 "example": "series_b"
 },
 "financing_type_tags": {
 "description": "An array of financing type categories.",
 "example": [
 "equity"
 ],
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "headcount": {
 "description": "A number of people mentioned organization is involved with.",
 "example": 213,
 "type": [
 "integer",
 "null"
 ]
 },
 "job_title": {
 "description": "Job title this `NewsEvent` is mentioning.",
 "example": "Director of Media and Analytics",
 "type": [
 "string",
 "null"
 ]
 },
 "job_title_tags": {
 "description": "An array of job title tags.",
 "example": [
 "marketing",
 "directors"
 ],
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "location": {
 "description": "Location of where the `NewsEvent` happened or where the organization has expanded/relocated.",
 "example": "Menlo Park, California, United States",
 "type": [
 "string",
 "null"
 ]
 },
 "location_data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "city",
 "state",
 "zip_code",
 "country",
 "region",
 "continent",
 "fuzzy_match"
 ],
 "properties": {
 "city": {
 "type": [
 "string",
 "null"
 ]
 },
 "state": {
 "type": [
 "string",
 "null"
 ]
 },
 "zip_code": {
 "type": [
 "string",
 "null"
 ]
 },
 "country": {
 "type": [
 "string",
 "null"
 ]
 },
 "region": {
 "type": [
 "string",
 "null"
 ]
 },
 "continent": {
 "type": [
 "string",
 "null"
 ]
 },
 "fuzzy_match": {
 "type": [
 "boolean",
 "null"
 ]
 }
 }
 }
 },
 "product": {
 "description": "Name of the product as mentioned by this NewsEvent.",
 "example": "Credit Pass",
 "type": [
 "string",
 "null"
 ]
 },
 "product_data": {
 "type": "object",
 "required": [
 "full_text",
 "name",
 "release_type",
 "release_version",
 "fuzzy_match"
 ],
 "properties": {
 "full_text": {
 "description": "Full product name as recognized by Named Entity Recognition, without further cleaning of the product name.",
 "example": "3D printing service for spare parts",
 "type": [
 "string",
 "null"
 ]
 },
 "name": {
 "description": "Cleaned name of the product referenced in the NewsEvent.",
 "example": "VideoPoet",
 "type": [
 "string",
 "null"
 ]
 },
 "release_type": {
 "description": "Product release type.",
 "example": "major",
 "type": [
 "string",
 "null"
 ]
 },
 "release_version": {
 "description": "Product release version.",
 "example": "v3.0",
 "type": [
 "string",
 "null"
 ]
 },
 "fuzzy_match": {
 "description": "When true we might not have extracted the product name cleanly. When false exact product name should be extracted well.",
 "type": [
 "boolean",
 "null"
 ]
 }
 }
 },
 "product_tags": {
 "description": "List of tags regarding the product.",
 "example": [
 "mobile",
 "online_technology"
 ],
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "recognition": {
 "description": "Name of the recognition the company received.",
 "example": "50 Smartest Companies",
 "type": [
 "string",
 "null"
 ]
 },
 "vulnerability": {
 "description": "Company issue.",
 "example": "account suspension errors",
 "type": [
 "string",
 "null"
 ]
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "most_relevant_source"
 ],
 "properties": {
 "company1": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "company2": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "most_relevant_source": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `NewsArticleLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `NewsArticleLite` object.",
 "const": "news_article"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "oneOf": [
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 },
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `NewsArticleLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `NewsArticleLite` object.",
 "const": "news_article"
 },
 "attributes": {
 "description": "Attributes of `NewsArticleLite` object.",
 "type": "object",
 "required": [
 "url",
 "title",
 "author",
 "image_url",
 "published_at",
 "body"
 ],
 "properties": {
 "url": {
 "description": "News Article source URL.",
 "type": "string",
 "format": "uri"
 },
 "title": {
 "description": "Prettified News Article title or heading.",
 "type": "string"
 },
 "author": {
 "description": "News Article author name.",
 "type": [
 "string",
 "null"
 ]
 },
 "image_url": {
 "description": "News Article most relevant image URL.",
 "type": [
 "string",
 "null"
 ]
 },
 "published_at": {
 "description": "Date & time (ISO 8601) when NewsArticle was published.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "body": {
 "description": "News Article text (article content).",
 "type": "string"
 }
 }
 }
 }
 }
 ],
 "discriminator": {
 "propertyName": "type"
 }
 }
 },
 "meta": {
 "description": "Meta information about `NewsEventsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "f096ea55-f81b-4f6a-83bd-d5c1cdc10143",
 "type": "news_event",
 "attributes": {
 "summary": "Klasha Inc. expands offices in Ghana.",
 "category": "expands_offices_in",
 "found_at": "2021-10-19T22:00:00Z",
 "confidence": 0.6872,
 "article_sentence": "San Francisco and Lagos-based cross-border technology company Klasha is further expanding its presence in Africa with the launch of its services in Ghana.",
 "human_approved": false,
 "planning": false,
 "amount": null,
 "amount_normalized": null,
 "assets": null,
 "assets_tags": [

],
          "award": null,
          "contact": null,
          "conference": null,
          "division": null,
          "effective_date": null,
          "financing_type": null,
          "financing_type_normalized": null,
          "financing_type_tags": [

],
          "headcount": null,
          "job_title": null,
          "job_title_tags": [

],
          "location": "Ghana",
          "location_data": [
            {
              "city": null,
              "state": null,
              "zip_code": null,
              "country": "Ghana",
              "region": null,
              "continent": null,
              "fuzzy_match": false
            }
          ],
          "product": null,
          "product_data": {
            "full_text": null,
            "name": null,
            "release_type": null,
            "release_version": null,
            "fuzzy_match": null
          },
          "product_tags": [

],
          "recognition": null,
          "vulnerability": null
        },
        "relationships": {
          "company1": {
            "data": {
              "id": "0db9ccc3-0c5f-5481-89da-b08e2a4195b8",
              "type": "company"
            }
          },
          "most_relevant_source": {
            "data": {
              "id": "797aa0af-c7f3-4b77-8a04-3f8bb39b315a",
              "type": "news_article"
            }
          }
        }
      }
    ],
    "included": [
      {
        "id": "0db9ccc3-0c5f-5481-89da-b08e2a4195b8",
        "type": "company",
        "attributes": {
          "domain": "klasha.com",
          "company_name": "Klasha Inc.",
          "ticker": null
        }
      },
      {
        "id": "797aa0af-c7f3-4b77-8a04-3f8bb39b315a",
        "type": "news_article",
        "attributes": {
          "author": null,
          "body": "Payfare, which offers banking solutions for gig workforce, has announced that it is integrating with Plaid, a data transfer network that powers fintech and digital finance products. The integration will… Technology company TraQiQ has introduced its online payment solution 'TraQPayments' in Latin America. TraQPayments is… American Express has partnered with Goldman Sachs Transaction Banking (TxB) to offer an integrated payments solution to large corporate clients. Barclaycard Payments and SAP is expanding their cooperation in a bid to boost payment acceptance capabilities and enhance procure-to-pay processes. UK-based fintech firm Previse has tapped Mastercard to provide instant payments to suppliers in more than 100 markets globally. Latin America-based payment processor PayRetailers has entered into an alliance with European payment giant Worldline. Buy now pay later (BNPL) firm Klarna has introduced ‘pay now’ option in the UK. Western Union International Bank (WUIB) has expanded its real-time payment capabilities in Europe by joining the Single Euro Payments Area (SEPA) Instant Credit Transfer scheme (SCT Inst). San Francisco and Lagos-based cross-border technology company Klasha is further expanding its presence in Africa with the launch of its services in Ghana.",
          "image_url": null,
          "url": "https://www.electronicpaymentsinternational.com/news/company-news/",
          "published_at": "2021-10-19T04:00:00Z",
          "title": "Company news Archives"
        }
      }
    ],
    "meta": {
      "schema_version": "3.0",
      "record_state": "active"
    }
  }
}

3.6.
Financing Events Dataset

Financing Events Dataset API Endpoints

Retrieve company's Financing Events

GET
/companies/{domain}/financing_events

3.6.1.
Retrieve company's Financing Events

Returns a list of company's Financing Events.


GET

https://predictleads.com/api/v3/companies/{domain}/financing_events

Path Parameters
`domain` `string` Company's domain.
Query Parameters
`first_seen_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `FinancingEvents` first seen after given date (ISO 8601).
`first_seen_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `FinancingEvents` first seen before given date (ISO 8601).
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about investments in companies",
 "description": "Financing Events are events extracted from News Events data.\n \nThese include e.g. Venture capital rounds, Private Equity investments etc.\n \nFinancing events are grouped by date of investment and include investment amount, names of investors and\nmore.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `FinancingEvent` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `FinancingEvent` object.",
 "const": "financing_event"
 },
 "attributes": {
 "description": "Attributes of `FinancingEvent` object.",
 "type": "object",
 "required": [
 "effective_date",
 "found_at",
 "categories",
 "financing_type",
 "financing_type_normalized",
 "amount",
 "amount_normalized",
 "source_urls"
 ],
 "properties": {
 "effective_date": {
 "description": "Date & time (ISO 8601) when the `FinancingEvent` has happened.",
 "type": [
 "string",
 "null"
 ],
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "found_at": {
 "description": "Date & time (ISO 8601) when the `FinancingEvent` was discovered and created.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "categories": {
 "description": "A `FinancingEvent` category.",
 "example": [
 "private_equity",
 "series_e",
 "venture"
 ],
 "type": "array",
 "items": {
 "enum": [
 "private_equity",
 "equity_crowdfunding",
 "product_crowdfunding",
 "convertible_note",
 "debt_financing",
 "donation",
 "grant",
 "post_ipo_debt",
 "post_ipo_equity",
 "post_ipo_secondary",
 "post_ipo",
 "initial_public_offering",
 "initial_coin_offering",
 "initial_dex_offering",
 "venture",
 "pre_angel",
 "angel",
 "angel1",
 "angel2",
 "angel3",
 "pre_seed",
 "seed",
 "seed1",
 "seed2",
 "seed3",
 "pre_series_a",
 "series_a",
 "series_a1",
 "series_a2",
 "series_a3",
 "pre_series_b",
 "series_b",
 "series_b1",
 "series_b2",
 "series_b3",
 "pre_series_c",
 "series_c",
 "series_c1",
 "series_c2",
 "series_c3",
 "pre_series_d",
 "series_d",
 "series_d1",
 "series_d2",
 "series_d3",
 "pre_series_e",
 "series_e",
 "series_e1",
 "series_e2",
 "series_e3",
 "pre_series_f",
 "series_f",
 "series_f1",
 "series_f2",
 "series_f3",
 "pre_series_g",
 "series_g",
 "series_g1",
 "series_g2",
 "series_g3",
 "pre_series_h",
 "series_h",
 "series_h1",
 "series_h2",
 "series_h3",
 "pre_series_i",
 "series_i",
 "series_i1",
 "series_i2",
 "series_i3",
 "pre_series_j",
 "series_j",
 "series_j1",
 "series_j2",
 "series_j3"
 ]
 }
 },
 "financing_type": {
 "description": "A financing type this `FinancingEvent` is mentioning.",
 "example": "Series E funding",
 "type": [
 "string",
 "null"
 ]
 },
 "financing_type_normalized": {
 "description": "A normalized value of `financing_type` property, where possible.",
 "enum": [
 "pre_angel",
 "angel",
 "angel1",
 "angel2",
 "angel3",
 "pre_seed",
 "seed",
 "seed1",
 "seed2",
 "seed3",
 "pre_series_a",
 "series_a",
 "series_a1",
 "series_a2",
 "series_a3",
 "pre_series_b",
 "series_b",
 "series_b1",
 "series_b2",
 "series_b3",
 "pre_series_c",
 "series_c",
 "series_c1",
 "series_c2",
 "series_c3",
 "pre_series_d",
 "series_d",
 "series_d1",
 "series_d2",
 "series_d3",
 "pre_series_e",
 "series_e",
 "series_e1",
 "series_e2",
 "series_e3",
 "pre_series_f",
 "series_f",
 "series_f1",
 "series_f2",
 "series_f3",
 "pre_series_g",
 "series_g",
 "series_g1",
 "series_g2",
 "series_g3",
 "pre_series_h",
 "series_h",
 "series_h1",
 "series_h2",
 "series_h3",
 "pre_series_i",
 "series_i",
 "series_i1",
 "series_i2",
 "series_i3",
 "pre_series_j",
 "series_j",
 "series_j1",
 "series_j2",
 "series_j3",
 null
 ],
 "example": "series_e"
 },
 "amount": {
 "description": "This is a string of a value as extracted from text.",
 "example": "$555.5 million",
 "type": [
 "string",
 "null"
 ]
 },
 "amount_normalized": {
 "description": "Integer value of \"amount\" property.",
 "example": 555500000,
 "type": [
 "integer",
 "null"
 ]
 },
 "source_urls": {
 "description": "Urls to news articles.",
 "type": "array",
 "items": {
 "example": "https://www.chinamoneynetwork.com/2018/10/10/yunfeng-advantech-lead-300m-round-in-chinas-airbnb-copycat-xiaozhu-com",
 "type": "string",
 "format": "uri"
 }
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company",
 "investors"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "investors": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `FinancingEventsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "e9a08a0c-bcb3-4536-a766-cac013869aac",
 "type": "financing_event",
 "attributes": {
 "effective_date": "2024-07-30T02:00:00+02:00",
 "found_at": "2024-07-30T02:00:00+02:00",
 "categories": [
 "series_c",
 "venture"
 ],
 "financing_type": "Series C",
 "financing_type_normalized": "series_c",
 "amount": "$200M",
 "amount_normalized": 200000000,
 "source_urls": [
 "https://www.prnewswire.com/news-releases/flo-health-secures-more-than-200m-investment-from-general-atlantic-to-revolutionize-womens-health-first-purely-digital-consumer-womens-health-app-to-achieve-unicorn-status-302208728.html",
 "https://techcrunch.com/2024/07/30/fertility-tracking-app-flo-health-raises-200m-at-a-1b-valuation"
 ]
 },
 "relationships": {
 "company": {
 "data": {
 "id": "a6ea5ea7-7301-50f8-ba9f-36d34cbd2d76",
 "type": "company"
 }
 },
 "investors": {
 "data": [
 {
 "id": "b0147ffb-df06-5349-b236-e195b61ac340",
 "type": "company"
 }
 ]
 }
 }
 }
 ],
 "included": [
 {
 "id": "b0147ffb-df06-5349-b236-e195b61ac340",
 "type": "company",
 "attributes": {
 "domain": "generalatlantic.com",
 "company_name": "General Atlantic",
 "ticker": null
 }
 },
 {
 "id": "a6ea5ea7-7301-50f8-ba9f-36d34cbd2d76",
 "type": "company",
 "attributes": {
 "domain": "flo.health",
 "company_name": "Flo",
 "ticker": null
 }
 }
 ],
 "meta": {
 "schema_version": "3.0",
 "record_state": "active"
 }
 }
}

3.7.
Connections Dataset

Connections Dataset API Endpoints

Retrieve company's Connections

GET
/companies/{domain}/connections

3.7.1.
Retrieve company's Connections

Returns a list of company's Connections.


GET

https://predictleads.com/api/v3/companies/{domain}/connections

Path Parameters
`domain` `string` Company's domain.
Query Parameters
`first_seen_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `Connections` first seen after given date (ISO 8601).
`first_seen_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `Connections` first seen before given date (ISO 8601).
`categories` [optional] `array` Comma-separated (,) `Connection` categories.
Items
One of
`string` Constant: `"partner"` Read as: Company1 is a partner of Company2. A partner relationship signals a collaboration between companies that goes both in two directions. You will find such connections using titles as "We work with", "Our partners", "The company we keep", and other titles similar in meaning. The implications of this category can be quite wide in their meaning, but in general all partnerships are a positive signal. NOTE: Until February 2024 the `partner` category did not always signal a true partnership between two companies, but it also included a tighter knit relationship compared to the `other` category, which are not always as strong as the partner keyword suggests. The meaning is now correctly followed for all new cases or cases that have been last seen since and still have the `partner` category.
`string` Constant: `"vendor"` Read as: Company1 is a vendor to Company2. The vendor category is much simpler in its meaning. It simply means that company1 is a supplier for company2 in some way. All vendor relationships are positive, although some are more positive than others. On a webpage, such connections can be seen in lists such as "Our customers", "Trusted by", "Enabling businesses to", etc. For example, to be a vendor to Microsoft, the company has to pass certain requirements as to company size, product reliability, safety, etc. This can be seen as a vetting process of some sort and increases the company's trustworthiness. The vendor category can also be used to determine the supply chain of a certain company and evaluate supply chain risks.
`string` Constant: `"integration"` Read as: Company1 has an integration with Company2. Most of the time an integration happens between a platform and a service. Case examples: Company1 has developed a Machine learning model. To make it more usable, they have developed an Azure Cloud integration. With this, the customers of the model can start using it more quickly, which is good for Company1. It's generally the service's development team that takes on the task of creating this integration. This can also be a positive signal for the platform (Company2). One could calculate the adoption of the Company2 platform and use this as a signal for growth.
`string` Constant: `"investor"` Read as: Company1 is an investor in Company2. The investor category identifies relationships between companies making investments (Company1) and companies receiving investments (Company2). The more investors the company has, the better. One could also track what companies/sectors competitors are investing in.
`string` Constant: `"parent"` Read as: Company1 is a parent company of Company2. Parent category defines a parent-subsidiary relationship between websites. In some cases such websites are only localized versions for specific markets. Case examples: "activisionblizzard.com" is a parent to "blizzard.com", and in turn "blizzard.com" is a parent to "blizzard.de". "coca-cola.com" is a parent to a vast array of websites, such as "coca-cola.fr", "coca-cola.de", "coca-cola.es", "coca-cola.tn", "coca-cola.se", etc. NOTE: Often it makes sense to not only check current hierarchy level e.g. "blizzard.de" but also check their parent connections e.g. "blizzard.com" and "activisionblizzard.com". Since sometimes company connections (customers, investors…) are also available at higher company hierarchical levels.
`string` Constant: `"rebranding"` Read as: Company1 is a rebranding of Company2. Company1 being a rebranding of Company2 suggests that Company2 has undergone a process to change its brand identity. We detect rebranding based on domain change and similarities between the old and the new website. Case examples: Top-level-domain (TLD) change: airmeet.co -> airmeet.com. airmeet.com is a rebranding of airmeet.co. TLD changed to higher value .com. Change to a shorter domain: lamborghini.com is a rebranding of lamborghini-madrid.com. Name change: hausarztpraxis-leinetal.de is a rebranding of praxis-schuenemann.de.
`string` Constant: `"published_in"` Read as: Company1 is published in Company2. The `published_in` category is usually found on early stage startup websites with fewer accomplishments on the market, but positive press coverage. You can see such connections under titles such as "As seen in", "Featured in", "Talking about us", etc. A `published_in` connection is a positive signal, but after some months or years, we would expect to see them removed and replaced with other content proving the legitimacy of the company.
`string` Constant: `"other"` Read as: Company1 is connected to Company2. This is the most general category. If we detected a relationship between companies, but we were unsure which category it belonged to, or it didn't belong to any of our categories, then we would categorize it as `other`. Outgoing `other` category connections are a slightly positive signal, while incoming ones are quite more so. Thus a connection Company1 -> other -> Company2 is more positive for Company2, than for Company1. As Company2 was featured on Company1 website. Sometimes the `other` category can have additional information via the source_category attribute depending on where it was found. An example of such a source_category would be `cookie_section`, which is explained further below. Such connections could be evaluated differently.
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about company connections with other companies",
 "description": "Company Connections describe relationships between companies.\n \nIt is sourced from Case Study pages, Testimonials pages, Logo images and other resources.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `Connection` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `Connection` object.",
 "const": "connection"
 },
 "attributes": {
 "description": "Attributes of `Connection` object.",
 "type": "object",
 "required": [
 "category",
 "source_category",
 "source_url",
 "individual_source_url",
 "context",
 "first_seen_at",
 "last_seen_at"
 ],
 "properties": {
 "category": {
 "description": "`Connection` category.",
 "type": "string",
 "oneOf": [
 {
 "const": "partner",
 "description": "**Read as**: Company1 is a partner of Company2.\n \nA partner relationship signals a collaboration between companies that goes both in two directions.\nYou will find such connections using titles as \"We work with\", \"Our partners\", \"The company we keep\",\nand other titles similar in meaning. The implications of this category\ncan be quite wide in their meaning, but in general all partnerships are a positive signal.\n \n**NOTE**: Until February 2024 the `partner` category did not always signal a true partnership\nbetween two companies, but it also included a tighter knit relationship compared to the `other`\ncategory, which are not always as strong as the partner keyword suggests.\nThe meaning is now correctly followed for all new cases or cases that have been last seen since\nand still have the `partner` category.\n"
 },
 {
 "const": "vendor",
 "description": "**Read as**: Company1 is a vendor to Company2.\n \nThe vendor category is much simpler in its meaning. It simply means that company1 is a supplier\nfor company2 in some way. All vendor relationships are positive, although some are more positive\nthan others. On a webpage, such connections can be seen in lists such as \"Our customers\",\n\"Trusted by\", \"Enabling businesses to\", etc.\n \nFor example, to be a vendor to Microsoft, the company has to pass certain requirements as to\ncompany size, product reliability, safety, etc. This can be seen as a vetting process of some sort\nand increases the company's trustworthiness.\n \nThe vendor category can also be used to determine the supply chain of a certain company and evaluate\nsupply chain risks.\n"
 },
 {
 "const": "integration",
 "description": "**Read as**: Company1 has an integration with Company2.\n \nMost of the time an integration happens between a platform and a service.\n \nCase examples:\n<ul>\n <li>\n Company1 has developed a Machine learning model. To make it more usable, they have\n developed an Azure Cloud integration. With this, the customers of the model can start using it\n more quickly, which is good for Company1. It's generally the service's development team that takes\n on the task of creating this integration. This can also be a positive signal for the platform\n (Company2). One could calculate the adoption of the Company2 platform and use this as a signal\n for growth.\n </li>\n</ul>\n"
 },
 {
 "const": "investor",
 "description": "**Read as**: Company1 is an investor in Company2.\n \nThe investor category identifies relationships between companies making investments (Company1)\nand companies receiving investments (Company2).\n \nThe more investors the company has, the better.\nOne could also track what companies/sectors competitors are investing in.\n"
 },
 {
 "const": "parent",
 "description": "**Read as**: Company1 is a parent company of Company2.\n \nParent category defines a parent-subsidiary relationship between websites.\nIn some cases such websites are only localized versions for specific markets.\n \nCase examples:\n<ul>\n <li>\n \"activisionblizzard.com\" is a parent to \"blizzard.com\", and in turn \"blizzard.com\" is a parent to\n \"blizzard.de\".\n </li>\n <li>\n \"coca-cola.com\" is a parent to a vast array of websites, such as \"coca-cola.fr\", \"coca-cola.de\",\n \"coca-cola.es\", \"coca-cola.tn\", \"coca-cola.se\", etc.\n </li>\n</ul>\n \n\n**NOTE**: Often it makes sense to not only check current hierarchy level e.g. \"blizzard.de\"\nbut also check their parent connections e.g. \"blizzard.com\" and \"activisionblizzard.com\".\nSince sometimes company connections (customers, investors…) are also available at higher company\nhierarchical levels.\n"
 },
 {
 "const": "rebranding",
 "description": "**Read as**: Company1 is a rebranding of Company2.\n \nCompany1 being a rebranding of Company2 suggests that Company2 has undergone a process to change\nits brand identity. We detect rebranding based on domain change and similarities between the old\nand the new website.\n \nCase examples:\n<ul>\n <li>\n Top-level-domain (TLD) change: airmeet.co -> airmeet.com. airmeet.com is a rebranding of airmeet.co.\n TLD changed to higher value .com.\n </li>\n <li>\n Change to a shorter domain: lamborghini.com is a rebranding of lamborghini-madrid.com.\n </li>\n <li>\n Name change: hausarztpraxis-leinetal.de is a rebranding of praxis-schuenemann.de.\n </li>\n</ul>\n"
 },
 {
 "const": "published_in",
 "description": "**Read as**: Company1 is published in Company2.\n \nThe `published_in` category is usually found on early stage startup websites with fewer\naccomplishments on the market, but positive press coverage. You can see such connections under\ntitles such as \"As seen in\", \"Featured in\", \"Talking about us\", etc.\n \nA `published_in` connection is a positive signal, but after some months or years, we would\nexpect to see them removed and replaced with other content proving the legitimacy of the company.\n"
 },
 {
 "const": "other",
 "description": "**Read as**: Company1 is connected to Company2.\n \nThis is the most general category. If we detected a relationship between companies, but we were\nunsure which category it belonged to, or it didn't belong to any of our categories, then we would\ncategorize it as `other`.\n \nOutgoing `other` category connections are a slightly positive signal, while incoming ones are\nquite more so. Thus a connection Company1 -> other -> Company2 is more positive for Company2, than\nfor Company1. As Company2 was featured on Company1 website.\n \nSometimes the `other` category can have additional information via the source_category attribute\ndepending on where it was found. An example of such a source_category would be `cookie_section`,\nwhich is explained further below. Such connections could be evaluated differently.\n"
 }
 ]
 },
 "source_category": {
 "description": "Describes source where the `Connection` category was found.",
 "externalDocs": {
 "description": "Read more about source categories...",
 "url": "/v3/guide/connections_dataset/source_categories"
 },
 "enum": [
 "undefined",
 "partner_page",
 "vendor_page",
 "integration_page",
 "investor_page",
 "sponsor_page",
 "parent_page",
 "case_study_page",
 "testimonial_page",
 "social_page",
 "manual_input",
 "domain_redirect",
 "same_subpage",
 "partner_section",
 "vendor_section",
 "integration_section",
 "investor_section",
 "sponsor_section",
 "parent_section",
 "case_study_section",
 "testimonial_section",
 "social_section",
 "published_in_section",
 "vendor_inverse_section",
 "investor_inverse_section",
 "parent_inverse_section",
 "footer",
 "header",
 "vendor_inverse_page",
 "cookie_section"
 ]
 },
 "source_url": {
 "description": "URL where `Connection` information was found.",
 "type": [
 "null",
 "string"
 ],
 "format": "uri"
 },
 "individual_source_url": {
 "description": "URL where Connection` additional information was found.",
 "type": [
 "null",
 "string"
 ],
 "format": "uri"
 },
 "context": {
 "description": "Text found near the connection. Often contains additional relationship information between the two companies.",
 "type": [
 "null",
 "string"
 ]
 },
 "first_seen_at": {
 "description": "Date & time (ISO 8601) of when the `Connection` was first seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "description": "Date & time (ISO 8601) of when the `Connection` was last seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`. Order of companies is guaranteed and necessary to preserve the meaning of the\n`category`. For example: Company1 is a `vendor` to Company2.\n",
 "type": "object",
 "required": [
 "company1",
 "company2"
 ],
 "properties": {
 "company1": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "company2": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `ConnectionsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "a5ea93a2-fc89-49da-b6ee-0d75bbad2357",
 "type": "connection",
 "attributes": {
 "category": "vendor",
 "source_category": "case_study_page",
 "source_url": "https://www.aaaza.com/work",
 "individual_source_url": null,
 "context": null,
 "first_seen_at": "2024-09-23T14:21:55Z",
 "last_seen_at": "2024-11-14T15:43:41Z"
 },
 "relationships": {
 "company1": {
 "data": {
 "id": "98ed3c42-4bc1-5d7c-9f1b-eee0b3bed0cd",
 "type": "company"
 }
 },
 "company2": {
 "data": {
 "id": "6a20c55b-f4b1-56c7-a4a8-966a000759f0",
 "type": "company"
 }
 }
 }
 }
 ],
 "included": [
 {
 "id": "98ed3c42-4bc1-5d7c-9f1b-eee0b3bed0cd",
 "type": "company",
 "attributes": {
 "domain": "aaaza.com",
 "company_name": "Aaaza Inc",
 "ticker": null
 }
 },
 {
 "id": "6a20c55b-f4b1-56c7-a4a8-966a000759f0",
 "type": "company",
 "attributes": {
 "domain": "ford.com",
 "company_name": "Ford",
 "ticker": "NYSE:F"
 }
 }
 ],
 "meta": {
 "schema_version": "3.0",
 "record_state": "active"
 }
 }
}

3.8.
Technologies Dataset

Technologies Dataset API Endpoints

Retrieve Technologies

GET
/technologies

Discover Technologies

GET
/discover/technologies

Retrieve a single Technology

GET
/technologies/{id}

3.8.1.
Retrieve Technologies

Returns a list of Technologies ordered by creation date ascending.


GET

https://predictleads.com/api/v3/technologies

Query Parameters
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about technologies",
 "description": "Technologies are detected on websites and jobs related posts.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `TechnologyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `TechnologyLite` object.",
 "const": "technology"
 },
 "attributes": {
 "description": "Attributes of `TechnologyLite` object.",
 "type": "object",
 "required": [
 "name",
 "description",
 "categories",
 "parent_categories",
 "domain",
 "url",
 "pricing_data",
 "created_at"
 ],
 "properties": {
 "name": {
 "type": "string"
 },
 "description": {
 "type": [
 "null",
 "string"
 ]
 },
 "categories": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "parent_categories": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "domain": {
 "type": [
 "null",
 "string"
 ]
 },
 "url": {
 "type": [
 "null",
 "string"
 ],
 "format": "uri"
 },
 "pricing_data": {
 "type": "object",
 "required": [
 "interval",
 "max_usd",
 "min_usd",
 "tags"
 ],
 "properties": {
 "min_usd": {
 "type": [
 "null",
 "number"
 ]
 },
 "max_usd": {
 "type": [
 "null",
 "number"
 ]
 },
 "interval": {
 "type": [
 "null",
 "string"
 ]
 },
 "tags": {
 "type": "array",
 "items": {
 "type": "string"
 }
 }
 }
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `TechnologiesDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "70392f20-b531-53cc-afa6-26416c0d582d",
 "type": "technology",
 "attributes": {
 "name": "Salesforce",
 "description": "Salesforce is a cloud computing service software (SaaS) that specializes in customer relationship management (CRM).",
 "categories": [
 "customer_relationship_management"
 ],
 "parent_categories": [
 "sales"
 ],
 "domain": "salesforce.com",
 "url": "https://www.salesforce.com",
 "pricing_data": {
 "min_usd": 300.0,
 "max_usd": 1000000.0,
 "interval": "yearly",
 "tags": [
 "low",
 "mid",
 "high",
 "enterprise",
 "saas"
 ]
 },
 "created_at": "2017-08-24T22:36:09Z"
 },
 "relationships": {
 "company": {
 "data": {
 "id": "9b638313-3fe3-5f5e-a19d-42e122cf06f9",
 "type": "company"
 }
 }
 }
 }
 ],
 "included": [
 {
 "id": "9b638313-3fe3-5f5e-a19d-42e122cf06f9",
 "type": "company",
 "attributes": {
 "domain": "salesforce.com",
 "company_name": "Salesforce, Inc.",
 "ticker": "NYSE:CRM"
 }
 }
 ],
 "meta": {
 "schema_version": "3.1",
 "record_state": "active"
 }
 }
}

3.8.2.
Discover Technologies

Returns a list of Technologies ordered by creation date descending.


GET

https://predictleads.com/api/v3/discover/technologies

Query Parameters
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about technologies",
 "description": "Technologies are detected on websites and jobs related posts.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `TechnologyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `TechnologyLite` object.",
 "const": "technology"
 },
 "attributes": {
 "description": "Attributes of `TechnologyLite` object.",
 "type": "object",
 "required": [
 "name",
 "description",
 "categories",
 "parent_categories",
 "domain",
 "url",
 "pricing_data",
 "created_at"
 ],
 "properties": {
 "name": {
 "type": "string"
 },
 "description": {
 "type": [
 "null",
 "string"
 ]
 },
 "categories": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "parent_categories": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "domain": {
 "type": [
 "null",
 "string"
 ]
 },
 "url": {
 "type": [
 "null",
 "string"
 ],
 "format": "uri"
 },
 "pricing_data": {
 "type": "object",
 "required": [
 "interval",
 "max_usd",
 "min_usd",
 "tags"
 ],
 "properties": {
 "min_usd": {
 "type": [
 "null",
 "number"
 ]
 },
 "max_usd": {
 "type": [
 "null",
 "number"
 ]
 },
 "interval": {
 "type": [
 "null",
 "string"
 ]
 },
 "tags": {
 "type": "array",
 "items": {
 "type": "string"
 }
 }
 }
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `TechnologiesDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "70392f20-b531-53cc-afa6-26416c0d582d",
 "type": "technology",
 "attributes": {
 "name": "Salesforce",
 "description": "Salesforce is a cloud computing service software (SaaS) that specializes in customer relationship management (CRM).",
 "categories": [
 "customer_relationship_management"
 ],
 "parent_categories": [
 "sales"
 ],
 "domain": "salesforce.com",
 "url": "https://www.salesforce.com",
 "pricing_data": {
 "min_usd": 300.0,
 "max_usd": 1000000.0,
 "interval": "yearly",
 "tags": [
 "low",
 "mid",
 "high",
 "enterprise",
 "saas"
 ]
 },
 "created_at": "2017-08-24T22:36:09Z"
 },
 "relationships": {
 "company": {
 "data": {
 "id": "9b638313-3fe3-5f5e-a19d-42e122cf06f9",
 "type": "company"
 }
 }
 }
 }
 ],
 "included": [
 {
 "id": "9b638313-3fe3-5f5e-a19d-42e122cf06f9",
 "type": "company",
 "attributes": {
 "domain": "salesforce.com",
 "company_name": "Salesforce, Inc.",
 "ticker": "NYSE:CRM"
 }
 }
 ],
 "meta": {
 "schema_version": "3.1",
 "record_state": "active"
 }
 }
}

3.8.3.
Retrieve a single Technology

Returns a single Technology.


GET

https://predictleads.com/api/v3/technologies/{id}

Path Parameters
`id` `string` Format: `uuid` Technology's ID.

Request Examples

Response Examples

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about technologies",
 "description": "Technologies are detected on websites and jobs related posts.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `TechnologyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `TechnologyLite` object.",
 "const": "technology"
 },
 "attributes": {
 "description": "Attributes of `TechnologyLite` object.",
 "type": "object",
 "required": [
 "name",
 "description",
 "categories",
 "parent_categories",
 "domain",
 "url",
 "pricing_data",
 "created_at"
 ],
 "properties": {
 "name": {
 "type": "string"
 },
 "description": {
 "type": [
 "null",
 "string"
 ]
 },
 "categories": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "parent_categories": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "domain": {
 "type": [
 "null",
 "string"
 ]
 },
 "url": {
 "type": [
 "null",
 "string"
 ],
 "format": "uri"
 },
 "pricing_data": {
 "type": "object",
 "required": [
 "interval",
 "max_usd",
 "min_usd",
 "tags"
 ],
 "properties": {
 "min_usd": {
 "type": [
 "null",
 "number"
 ]
 },
 "max_usd": {
 "type": [
 "null",
 "number"
 ]
 },
 "interval": {
 "type": [
 "null",
 "string"
 ]
 },
 "tags": {
 "type": "array",
 "items": {
 "type": "string"
 }
 }
 }
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `TechnologiesDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "70392f20-b531-53cc-afa6-26416c0d582d",
 "type": "technology",
 "attributes": {
 "name": "Salesforce",
 "description": "Salesforce is a cloud computing service software (SaaS) that specializes in customer relationship management (CRM).",
 "categories": [
 "customer_relationship_management"
 ],
 "parent_categories": [
 "sales"
 ],
 "domain": "salesforce.com",
 "url": "https://www.salesforce.com",
 "pricing_data": {
 "min_usd": 300.0,
 "max_usd": 1000000.0,
 "interval": "yearly",
 "tags": [
 "low",
 "mid",
 "high",
 "enterprise",
 "saas"
 ]
 },
 "created_at": "2017-08-24T22:36:09Z"
 },
 "relationships": {
 "company": {
 "data": {
 "id": "9b638313-3fe3-5f5e-a19d-42e122cf06f9",
 "type": "company"
 }
 }
 }
 }
 ],
 "included": [
 {
 "id": "9b638313-3fe3-5f5e-a19d-42e122cf06f9",
 "type": "company",
 "attributes": {
 "domain": "salesforce.com",
 "company_name": "Salesforce, Inc.",
 "ticker": "NYSE:CRM"
 }
 }
 ],
 "meta": {
 "schema_version": "3.1",
 "record_state": "active"
 }
 }
}

3.9.
Technology Detections Dataset

Technology Detections Dataset API Endpoints

Retrieve company's Technology Detections

GET
/companies/{domain}/technology_detections

Retrieve a single Technology Detection

GET
/technology_detections/{id}

Discover Technology Detections for a given Technology ID

GET
/discover/technologies/{id}/technology_detections

3.9.1.
Retrieve company's Technology Detections

Returns a list of company's Technology Detections.


GET

https://predictleads.com/api/v3/companies/{domain}/technology_detections

Path Parameters
`domain` `string` Company's domain.
Query Parameters
`first_seen_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `TechnologyDetections` first seen after given date (ISO 8601).
`first_seen_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `TechnologyDetections` first seen before given date (ISO 8601).
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Request was successfully processed.

{
  "data": [
    {
      "id": "344f5e7c-4dae-4814-8f45-ded70b2baa6a",
      "type": "technology_detection",
      "attributes": {
        "first_seen_at": "2022-12-08T10:40:41Z",
        "last_seen_at": "2024-11-11T15:31:54Z",
        "behind_firewall": false,
        "score": 0.75
      },
      "relationships": {
        "company": {
          "data": {
            "id": "9e0bf4ad-0792-58ba-94a0-cb12a5a853a2",
            "type": "company"
          }
        },
        "seen_on_job_openings": {
          "data": [

]
        },
        "seen_on_subpages": {
          "data": [
            {
              "id": "0635626f-de95-4c06-ae84-b96123929607",
              "type": "detection_on_subpage"
            },
            {
              "id": "fc8ca4d4-2a57-4588-9dcd-84fe46ae2578",
              "type": "detection_on_subpage"
            }
          ]
        },
        "technology": {
          "data": {
            "id": "aa139d7c-b2fd-5b76-8dac-97c9ba844c73",
            "type": "technology"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "0635626f-de95-4c06-ae84-b96123929607",
      "type": "detection_on_subpage",
      "attributes": {
        "first_seen_at": "2024-06-03T01:57:52Z",
        "last_seen_at": "2024-10-03T08:10:01Z",
        "subpage_url": "https://support.madkudu.com/hc/en-us"
      }
    },
    {
      "id": "fc8ca4d4-2a57-4588-9dcd-84fe46ae2578",
      "type": "detection_on_subpage",
      "attributes": {
        "first_seen_at": "2022-12-08T10:40:47Z",
        "last_seen_at": "2024-11-11T15:31:54Z",
        "subpage_url": "https://www.madkudu.com"
      }
    },
    {
      "id": "aa139d7c-b2fd-5b76-8dac-97c9ba844c73",
      "type": "technology",
      "attributes": {
        "name": "Google Hosted Libraries"
      }
    },
    {
      "id": "9e0bf4ad-0792-58ba-94a0-cb12a5a853a2",
      "type": "company",
      "attributes": {
        "domain": "madkudu.com",
        "company_name": "MadKudu Inc.",
        "ticker": null
      }
    }
  ],
  "meta": {
    "schema_version": "3.0",
    "record_state": "active"
  }
}

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about technologies used by companies",
 "description": "Technology detections provide insight into tech stacks of companies.\n \nDetections are sourced from company websites and from job opening descriptions.\n \nEach detection is also enriched with company and technology information which includes technology\ndescription, technology category, pricing and more.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `TechnologyDetection` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `TechnologyDetection` object.",
 "const": "technology_detection"
 },
 "attributes": {
 "description": "Attributes of `TechnologyDetection` object.",
 "type": "object",
 "required": [
 "first_seen_at",
 "last_seen_at",
 "behind_firewall",
 "score"
 ],
 "properties": {
 "first_seen_at": {
 "description": "Date & time (ISO 8601) of when the `TechnologyDetection` was first seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "description": "Date & time (ISO 8601) of when the `TechnologyDetection` was last seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "behind_firewall": {
 "type": "boolean"
 },
 "score": {
 "type": "number"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company",
 "seen_on_job_openings",
 "seen_on_subpages",
 "technology"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "seen_on_job_openings": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `JobOpeningLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `JobOpeningLite` object.",
 "const": "job_opening"
 }
 }
 }
 }
 }
 },
 "seen_on_subpages": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `DetectionOnSubpage` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `DetectionOnSubpage` object.",
 "const": "detection_on_subpage"
 }
 }
 }
 }
 }
 },
 "technology": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `TechnologyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `TechnologyLite` object.",
 "const": "technology"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "oneOf": [
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 },
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `TechnologyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `TechnologyLite` object.",
 "const": "technology"
 },
 "attributes": {
 "description": "Attributes of `TechnologyLite` object.",
 "type": "object",
 "required": [
 "name"
 ],
 "properties": {
 "name": {
 "type": "string"
 }
 }
 }
 }
 },
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `DetectionOnSubpage` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `DetectionOnSubpage` object.",
 "const": "detection_on_subpage"
 },
 "attributes": {
 "description": "Attributes of `DetectionOnSubpage` object.",
 "type": "object",
 "required": [
 "first_seen_at",
 "last_seen_at",
 "subpage_url"
 ],
 "properties": {
 "first_seen_at": {
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "subpage_url": {
 "type": "string",
 "format": "uri"
 }
 }
 }
 }
 },
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `JobOpeningLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `JobOpeningLite` object.",
 "const": "job_opening"
 },
 "attributes": {
 "description": "Attributes of `JobOpeningLite` object.",
 "type": "object",
 "required": [
 "first_seen_at",
 "last_seen_at",
 "url"
 ],
 "properties": {
 "first_seen_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpeningLite` was first seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpeningLite` was last seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "url": {
 "description": "URL of the web page where the data was found.",
 "type": "string",
 "format": "uri"
 }
 }
 }
 }
 }
 ],
 "discriminator": {
 "propertyName": "type"
 }
 }
 },
 "meta": {
 "description": "Meta information about `TechnologyDetectionsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "344f5e7c-4dae-4814-8f45-ded70b2baa6a",
 "type": "technology_detection",
 "attributes": {
 "first_seen_at": "2022-12-08T10:40:41Z",
 "last_seen_at": "2024-11-11T15:31:54Z",
 "behind_firewall": false,
 "score": 0.75
 },
 "relationships": {
 "company": {
 "data": {
 "id": "9e0bf4ad-0792-58ba-94a0-cb12a5a853a2",
 "type": "company"
 }
 },
 "seen_on_job_openings": {
 "data": [

]
          },
          "seen_on_subpages": {
            "data": [
              {
                "id": "0635626f-de95-4c06-ae84-b96123929607",
                "type": "detection_on_subpage"
              },
              {
                "id": "fc8ca4d4-2a57-4588-9dcd-84fe46ae2578",
                "type": "detection_on_subpage"
              }
            ]
          },
          "technology": {
            "data": {
              "id": "aa139d7c-b2fd-5b76-8dac-97c9ba844c73",
              "type": "technology"
            }
          }
        }
      }
    ],
    "included": [
      {
        "id": "0635626f-de95-4c06-ae84-b96123929607",
        "type": "detection_on_subpage",
        "attributes": {
          "first_seen_at": "2024-06-03T01:57:52Z",
          "last_seen_at": "2024-10-03T08:10:01Z",
          "subpage_url": "https://support.madkudu.com/hc/en-us"
        }
      },
      {
        "id": "fc8ca4d4-2a57-4588-9dcd-84fe46ae2578",
        "type": "detection_on_subpage",
        "attributes": {
          "first_seen_at": "2022-12-08T10:40:47Z",
          "last_seen_at": "2024-11-11T15:31:54Z",
          "subpage_url": "https://www.madkudu.com"
        }
      },
      {
        "id": "aa139d7c-b2fd-5b76-8dac-97c9ba844c73",
        "type": "technology",
        "attributes": {
          "name": "Google Hosted Libraries"
        }
      },
      {
        "id": "9e0bf4ad-0792-58ba-94a0-cb12a5a853a2",
        "type": "company",
        "attributes": {
          "domain": "madkudu.com",
          "company_name": "MadKudu Inc.",
          "ticker": null
        }
      }
    ],
    "meta": {
      "schema_version": "3.0",
      "record_state": "active"
    }
  }
}

3.9.2.
Retrieve a single Technology Detection

Returns a single Technology Detection.


GET

https://predictleads.com/api/v3/technology_detections/{id}

Path Parameters
`id` `string` Format: `uuid` TechnologyDetection's ID.

Request Examples

Response Examples

Request was successfully processed.

{
  "data": [
    {
      "id": "344f5e7c-4dae-4814-8f45-ded70b2baa6a",
      "type": "technology_detection",
      "attributes": {
        "first_seen_at": "2022-12-08T10:40:41Z",
        "last_seen_at": "2024-11-11T15:31:54Z",
        "behind_firewall": false,
        "score": 0.75
      },
      "relationships": {
        "company": {
          "data": {
            "id": "9e0bf4ad-0792-58ba-94a0-cb12a5a853a2",
            "type": "company"
          }
        },
        "seen_on_job_openings": {
          "data": [

]
        },
        "seen_on_subpages": {
          "data": [
            {
              "id": "0635626f-de95-4c06-ae84-b96123929607",
              "type": "detection_on_subpage"
            },
            {
              "id": "fc8ca4d4-2a57-4588-9dcd-84fe46ae2578",
              "type": "detection_on_subpage"
            }
          ]
        },
        "technology": {
          "data": {
            "id": "aa139d7c-b2fd-5b76-8dac-97c9ba844c73",
            "type": "technology"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "0635626f-de95-4c06-ae84-b96123929607",
      "type": "detection_on_subpage",
      "attributes": {
        "first_seen_at": "2024-06-03T01:57:52Z",
        "last_seen_at": "2024-10-03T08:10:01Z",
        "subpage_url": "https://support.madkudu.com/hc/en-us"
      }
    },
    {
      "id": "fc8ca4d4-2a57-4588-9dcd-84fe46ae2578",
      "type": "detection_on_subpage",
      "attributes": {
        "first_seen_at": "2022-12-08T10:40:47Z",
        "last_seen_at": "2024-11-11T15:31:54Z",
        "subpage_url": "https://www.madkudu.com"
      }
    },
    {
      "id": "aa139d7c-b2fd-5b76-8dac-97c9ba844c73",
      "type": "technology",
      "attributes": {
        "name": "Google Hosted Libraries"
      }
    },
    {
      "id": "9e0bf4ad-0792-58ba-94a0-cb12a5a853a2",
      "type": "company",
      "attributes": {
        "domain": "madkudu.com",
        "company_name": "MadKudu Inc.",
        "ticker": null
      }
    }
  ],
  "meta": {
    "schema_version": "3.0",
    "record_state": "active"
  }
}

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about technologies used by companies",
 "description": "Technology detections provide insight into tech stacks of companies.\n \nDetections are sourced from company websites and from job opening descriptions.\n \nEach detection is also enriched with company and technology information which includes technology\ndescription, technology category, pricing and more.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `TechnologyDetection` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `TechnologyDetection` object.",
 "const": "technology_detection"
 },
 "attributes": {
 "description": "Attributes of `TechnologyDetection` object.",
 "type": "object",
 "required": [
 "first_seen_at",
 "last_seen_at",
 "behind_firewall",
 "score"
 ],
 "properties": {
 "first_seen_at": {
 "description": "Date & time (ISO 8601) of when the `TechnologyDetection` was first seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "description": "Date & time (ISO 8601) of when the `TechnologyDetection` was last seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "behind_firewall": {
 "type": "boolean"
 },
 "score": {
 "type": "number"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company",
 "seen_on_job_openings",
 "seen_on_subpages",
 "technology"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "seen_on_job_openings": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `JobOpeningLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `JobOpeningLite` object.",
 "const": "job_opening"
 }
 }
 }
 }
 }
 },
 "seen_on_subpages": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `DetectionOnSubpage` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `DetectionOnSubpage` object.",
 "const": "detection_on_subpage"
 }
 }
 }
 }
 }
 },
 "technology": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `TechnologyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `TechnologyLite` object.",
 "const": "technology"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "oneOf": [
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 },
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `TechnologyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `TechnologyLite` object.",
 "const": "technology"
 },
 "attributes": {
 "description": "Attributes of `TechnologyLite` object.",
 "type": "object",
 "required": [
 "name"
 ],
 "properties": {
 "name": {
 "type": "string"
 }
 }
 }
 }
 },
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `DetectionOnSubpage` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `DetectionOnSubpage` object.",
 "const": "detection_on_subpage"
 },
 "attributes": {
 "description": "Attributes of `DetectionOnSubpage` object.",
 "type": "object",
 "required": [
 "first_seen_at",
 "last_seen_at",
 "subpage_url"
 ],
 "properties": {
 "first_seen_at": {
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "subpage_url": {
 "type": "string",
 "format": "uri"
 }
 }
 }
 }
 },
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `JobOpeningLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `JobOpeningLite` object.",
 "const": "job_opening"
 },
 "attributes": {
 "description": "Attributes of `JobOpeningLite` object.",
 "type": "object",
 "required": [
 "first_seen_at",
 "last_seen_at",
 "url"
 ],
 "properties": {
 "first_seen_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpeningLite` was first seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "description": "Date & time (ISO 8601) of when the `JobOpeningLite` was last seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "url": {
 "description": "URL of the web page where the data was found.",
 "type": "string",
 "format": "uri"
 }
 }
 }
 }
 }
 ],
 "discriminator": {
 "propertyName": "type"
 }
 }
 },
 "meta": {
 "description": "Meta information about `TechnologyDetectionsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "344f5e7c-4dae-4814-8f45-ded70b2baa6a",
 "type": "technology_detection",
 "attributes": {
 "first_seen_at": "2022-12-08T10:40:41Z",
 "last_seen_at": "2024-11-11T15:31:54Z",
 "behind_firewall": false,
 "score": 0.75
 },
 "relationships": {
 "company": {
 "data": {
 "id": "9e0bf4ad-0792-58ba-94a0-cb12a5a853a2",
 "type": "company"
 }
 },
 "seen_on_job_openings": {
 "data": [

]
          },
          "seen_on_subpages": {
            "data": [
              {
                "id": "0635626f-de95-4c06-ae84-b96123929607",
                "type": "detection_on_subpage"
              },
              {
                "id": "fc8ca4d4-2a57-4588-9dcd-84fe46ae2578",
                "type": "detection_on_subpage"
              }
            ]
          },
          "technology": {
            "data": {
              "id": "aa139d7c-b2fd-5b76-8dac-97c9ba844c73",
              "type": "technology"
            }
          }
        }
      }
    ],
    "included": [
      {
        "id": "0635626f-de95-4c06-ae84-b96123929607",
        "type": "detection_on_subpage",
        "attributes": {
          "first_seen_at": "2024-06-03T01:57:52Z",
          "last_seen_at": "2024-10-03T08:10:01Z",
          "subpage_url": "https://support.madkudu.com/hc/en-us"
        }
      },
      {
        "id": "fc8ca4d4-2a57-4588-9dcd-84fe46ae2578",
        "type": "detection_on_subpage",
        "attributes": {
          "first_seen_at": "2022-12-08T10:40:47Z",
          "last_seen_at": "2024-11-11T15:31:54Z",
          "subpage_url": "https://www.madkudu.com"
        }
      },
      {
        "id": "aa139d7c-b2fd-5b76-8dac-97c9ba844c73",
        "type": "technology",
        "attributes": {
          "name": "Google Hosted Libraries"
        }
      },
      {
        "id": "9e0bf4ad-0792-58ba-94a0-cb12a5a853a2",
        "type": "company",
        "attributes": {
          "domain": "madkudu.com",
          "company_name": "MadKudu Inc.",
          "ticker": null
        }
      }
    ],
    "meta": {
      "schema_version": "3.0",
      "record_state": "active"
    }
  }
}

3.9.3.
Discover Technology Detections for a given Technology ID

Returns a list of Technology Detections for a given Technology ID, ordered by date found, descending.


GET

https://predictleads.com/api/v3/discover/technologies/{id}/technology_detections

Path Parameters
`id` `string` Format: `uuid` Technology's ID.
Query Parameters
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about technologies",
 "description": "Technologies are detected on websites and jobs related posts.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `TechnologyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `TechnologyLite` object.",
 "const": "technology"
 },
 "attributes": {
 "description": "Attributes of `TechnologyLite` object.",
 "type": "object",
 "required": [
 "name",
 "description",
 "categories",
 "parent_categories",
 "domain",
 "url",
 "pricing_data",
 "created_at"
 ],
 "properties": {
 "name": {
 "type": "string"
 },
 "description": {
 "type": [
 "null",
 "string"
 ]
 },
 "categories": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "parent_categories": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "domain": {
 "type": [
 "null",
 "string"
 ]
 },
 "url": {
 "type": [
 "null",
 "string"
 ],
 "format": "uri"
 },
 "pricing_data": {
 "type": "object",
 "required": [
 "interval",
 "max_usd",
 "min_usd",
 "tags"
 ],
 "properties": {
 "min_usd": {
 "type": [
 "null",
 "number"
 ]
 },
 "max_usd": {
 "type": [
 "null",
 "number"
 ]
 },
 "interval": {
 "type": [
 "null",
 "string"
 ]
 },
 "tags": {
 "type": "array",
 "items": {
 "type": "string"
 }
 }
 }
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `TechnologiesDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "70392f20-b531-53cc-afa6-26416c0d582d",
 "type": "technology",
 "attributes": {
 "name": "Salesforce",
 "description": "Salesforce is a cloud computing service software (SaaS) that specializes in customer relationship management (CRM).",
 "categories": [
 "customer_relationship_management"
 ],
 "parent_categories": [
 "sales"
 ],
 "domain": "salesforce.com",
 "url": "https://www.salesforce.com",
 "pricing_data": {
 "min_usd": 300.0,
 "max_usd": 1000000.0,
 "interval": "yearly",
 "tags": [
 "low",
 "mid",
 "high",
 "enterprise",
 "saas"
 ]
 },
 "created_at": "2017-08-24T22:36:09Z"
 },
 "relationships": {
 "company": {
 "data": {
 "id": "9b638313-3fe3-5f5e-a19d-42e122cf06f9",
 "type": "company"
 }
 }
 }
 }
 ],
 "included": [
 {
 "id": "9b638313-3fe3-5f5e-a19d-42e122cf06f9",
 "type": "company",
 "attributes": {
 "domain": "salesforce.com",
 "company_name": "Salesforce, Inc.",
 "ticker": "NYSE:CRM"
 }
 }
 ],
 "meta": {
 "schema_version": "3.1",
 "record_state": "active"
 }
 }
}

3.10.
Website Evolution Dataset

Website Evolution Dataset API Endpoints

Retrieve company's Website Evolution

GET
/companies/{domain}/website_evolution

3.10.1.
Retrieve company's Website Evolution

Returns a list of company's Website Evolution.


GET

https://predictleads.com/api/v3/companies/{domain}/website_evolution

Path Parameters
`domain` `string` Company's domain.
Query Parameters
`first_seen_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `Subpages` first seen after given date (ISO 8601).
`first_seen_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `Subpages` first seen before given date (ISO 8601).
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Request was successfully processed.

{
  "data": [
    {
      "id": "fc4f22ed-975e-4826-9e21-31ec98da19a3",
      "type": "subpage",
      "attributes": {
        "category": "solutions",
        "url": "https://nonamesecurity.com/platform/security-testing",
        "text_content": "Leave no API untested and Shift Left with API security testing. Add security into your CI/CD pipeline without sacrificing speed and ensure that APIs aren't implemented with security vulnerabilities.\nNoname Security Active Testing is a purpose-built API security testing solution that understands your unique business logic and provides comprehensive coverage of API-specific vulnerabilities. Active Testing helps you shift left and bake API security testing into every phase of development.\nReduce the risk of successful attacks without any changes to production infrastructure.\nAccelerate remediation and lower remediation costs by up to 100x by finding and fixing issues earlier.\nImprove compliance and avoid regulatory fines and reputational damage from incidents.\nImprove security without sacrificing velocity. Deliver secure code without having to become a security expert.\nReduce redundant pentesting and other third-party security testing costs with a proven solution.\nIncrease your organization's confidence in APIs with continuous testing throughout the SDLC.\nA holistic API Security strategy should account for both pre- and post-production. Testing during the API development process allows developers to catch vulnerabilities and flaws early.\nWow. We've worked with a lot of partners, but the speed Noname is moving at has been impressive. Active Testing is huge for any company that cares about their APIs. They continue to push the envelope and we're proud to partner with them.\nBy implementing Active Testing by Noname Security, we are able to provide developers with the tools they need to bridge the gap and secure APIs before production, and without having to become security experts.\nEmpower developers with best-in-class usability such as simple setup & automation, in-line test results, and contextual guidance for request failure mitigation.\nLeave no API untested with a unique ability to find and test every API based on an understanding of the application's business logic.\nActive Testing fully integrates with your existing continuous integration/continuous delivery (CI/CD) pipelines and tools, such as Jenkins and Postman, as well as all your ticketing and workflow tools such as ServiceNow, Slack, and Jira.\nTeams get dynamic API visibility across multiple states and environments throughout the CI/CD process. Import APIs from a wide range of sources with dynamic updates. Compare Swagger files to assess conformance, based on real implementation results.\nStreamline testing with role-based access controls so only the right teams can access APIs for testing.\nWhat is API security testing?\nAPI security testing is an important part of ensuring the safety and reliability of your web applications. It involves testing application programming interfaces (APIs) during development to identify vulnerabilities and potential threats. The goal is to ensure that APIs are protected from malicious attacks, data breaches, and other security incidents. Through API security testing, organizations can make sure that their APIs are secure and compliant with data privacy regulations.\nHow does API security testing protect me from attacks?\nAPI security testing can identify vulnerabilities in your APIs before they're exploited by attackers, helping you prevent data breaches. APIs are often used to access sensitive data, and by testing the APIs regularly, your organization can ensure that your environment is secure and protected from potential threats.\nWhat is Shift-Left security testing?\nShift Left is an approach of moving a variety of tasks earlier in the development process. This means that tasks that are traditionally done at a later stage of the operations should instead be performed at earlier stages-particularly those related to API security and software testing.\nShift-Left vs Shift-Right security testing?\nShift-left security approach moves testing to the left on the timeline, so the team performs tests earlier and more often in the life cycle. In contrast, a shift-right approach considers testing in production with real users to be more useful.\nShould we use Active Testing with other Noname products?\nYes, Active Testing should be used in parallel with the other modules from the Noname API Security platform. Active Testing is a tool to help uncover vulnerabilities with APIs pre-production, whereas our API Discovery, Posture Management, and Runtime Protection modules are for protecting APIs in production.\nIs Active Testing right for my needs?\nThe earlier you catch security vulnerabilities, the better. From both a cost perspective and remediation angle, it is much easier to correct issues during the development process of the API than after it has been released into production and is being actively used. Active Testing allows organizations to more confidently and efficiently deliver applications to the business and remain competitive securely.\nOrganizations now have an average of 15,000 APIs to secure, and this number is growing rapidly as thousands of new applications hit the market...\nAs the number and complexity of APIs continue to grow, companies face increasing challenges when securing their APIs.\nFocus on finding and remediating API security vulnerabilities during the development phase.\nExperience the speed, scale, and security that only Noname can provide. You'll never look at APIs the same way again.",
        "first_seen_at": "2023-08-20T01:06:12Z",
        "last_seen_at": "2024-09-08T08:08:45Z"
      },
      "relationships": {
        "company": {
          "data": {
            "id": "47d3f4f2-e119-50cb-93f8-49a5fac024e2",
            "type": "company"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "47d3f4f2-e119-50cb-93f8-49a5fac024e2",
      "type": "company",
      "attributes": {
        "domain": "nonamesecurity.com",
        "company_name": "Noname Security Group",
        "ticker": null
      }
    }
  ],
  "meta": {
    "schema_version": "3.0",
    "record_state": "active"
  }
}

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about how websites of companies have been evolving",
 "description": "Provides information on how a given website has been evolving.\n \nThis dataset tracks when certain subpages like \"about us\", \"blog\", \"careers\", \"api docs\",\n\"customer support\"... pages have been added. The more subpages a given company adds in a shorter time\nframe, normally the faster its progress. One could also segment companies based on the categories of\nsubpages they have.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `Subpage` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `Subpage` object.",
 "const": "subpage"
 },
 "attributes": {
 "description": "Attributes of `Subpage` object.",
 "type": "object",
 "required": [
 "url",
 "first_seen_at",
 "last_seen_at",
 "category",
 "text_content"
 ],
 "properties": {
 "url": {
 "description": "Subpage URL.",
 "type": "string",
 "format": "uri"
 },
 "first_seen_at": {
 "description": "Date & time (ISO 8601) of when the `Subpage` was first seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "last_seen_at": {
 "description": "Date & time (ISO 8601) of when the `Subpage` was last seen.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 },
 "category": {
 "description": "Subpage category.",
 "type": "string"
 },
 "text_content": {
 "description": "Text content from the subpage. Sentences are contextually separated with new lines (\\n).",
 "type": [
 "null",
 "string"
 ]
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `WebsiteEvolutionDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "fc4f22ed-975e-4826-9e21-31ec98da19a3",
 "type": "subpage",
 "attributes": {
 "category": "solutions",
 "url": "https://nonamesecurity.com/platform/security-testing",
 "text_content": "Leave no API untested and Shift Left with API security testing. Add security into your CI/CD pipeline without sacrificing speed and ensure that APIs aren't implemented with security vulnerabilities.\nNoname Security Active Testing is a purpose-built API security testing solution that understands your unique business logic and provides comprehensive coverage of API-specific vulnerabilities. Active Testing helps you shift left and bake API security testing into every phase of development.\nReduce the risk of successful attacks without any changes to production infrastructure.\nAccelerate remediation and lower remediation costs by up to 100x by finding and fixing issues earlier.\nImprove compliance and avoid regulatory fines and reputational damage from incidents.\nImprove security without sacrificing velocity. Deliver secure code without having to become a security expert.\nReduce redundant pentesting and other third-party security testing costs with a proven solution.\nIncrease your organization's confidence in APIs with continuous testing throughout the SDLC.\nA holistic API Security strategy should account for both pre- and post-production. Testing during the API development process allows developers to catch vulnerabilities and flaws early.\nWow. We've worked with a lot of partners, but the speed Noname is moving at has been impressive. Active Testing is huge for any company that cares about their APIs. They continue to push the envelope and we're proud to partner with them.\nBy implementing Active Testing by Noname Security, we are able to provide developers with the tools they need to bridge the gap and secure APIs before production, and without having to become security experts.\nEmpower developers with best-in-class usability such as simple setup & automation, in-line test results, and contextual guidance for request failure mitigation.\nLeave no API untested with a unique ability to find and test every API based on an understanding of the application's business logic.\nActive Testing fully integrates with your existing continuous integration/continuous delivery (CI/CD) pipelines and tools, such as Jenkins and Postman, as well as all your ticketing and workflow tools such as ServiceNow, Slack, and Jira.\nTeams get dynamic API visibility across multiple states and environments throughout the CI/CD process. Import APIs from a wide range of sources with dynamic updates. Compare Swagger files to assess conformance, based on real implementation results.\nStreamline testing with role-based access controls so only the right teams can access APIs for testing.\nWhat is API security testing?\nAPI security testing is an important part of ensuring the safety and reliability of your web applications. It involves testing application programming interfaces (APIs) during development to identify vulnerabilities and potential threats. The goal is to ensure that APIs are protected from malicious attacks, data breaches, and other security incidents. Through API security testing, organizations can make sure that their APIs are secure and compliant with data privacy regulations.\nHow does API security testing protect me from attacks?\nAPI security testing can identify vulnerabilities in your APIs before they're exploited by attackers, helping you prevent data breaches. APIs are often used to access sensitive data, and by testing the APIs regularly, your organization can ensure that your environment is secure and protected from potential threats.\nWhat is Shift-Left security testing?\nShift Left is an approach of moving a variety of tasks earlier in the development process. This means that tasks that are traditionally done at a later stage of the operations should instead be performed at earlier stages-particularly those related to API security and software testing.\nShift-Left vs Shift-Right security testing?\nShift-left security approach moves testing to the left on the timeline, so the team performs tests earlier and more often in the life cycle. In contrast, a shift-right approach considers testing in production with real users to be more useful.\nShould we use Active Testing with other Noname products?\nYes, Active Testing should be used in parallel with the other modules from the Noname API Security platform. Active Testing is a tool to help uncover vulnerabilities with APIs pre-production, whereas our API Discovery, Posture Management, and Runtime Protection modules are for protecting APIs in production.\nIs Active Testing right for my needs?\nThe earlier you catch security vulnerabilities, the better. From both a cost perspective and remediation angle, it is much easier to correct issues during the development process of the API than after it has been released into production and is being actively used. Active Testing allows organizations to more confidently and efficiently deliver applications to the business and remain competitive securely.\nOrganizations now have an average of 15,000 APIs to secure, and this number is growing rapidly as thousands of new applications hit the market...\nAs the number and complexity of APIs continue to grow, companies face increasing challenges when securing their APIs.\nFocus on finding and remediating API security vulnerabilities during the development phase.\nExperience the speed, scale, and security that only Noname can provide. You'll never look at APIs the same way again.",
 "first_seen_at": "2023-08-20T01:06:12Z",
 "last_seen_at": "2024-09-08T08:08:45Z"
 },
 "relationships": {
 "company": {
 "data": {
 "id": "47d3f4f2-e119-50cb-93f8-49a5fac024e2",
 "type": "company"
 }
 }
 }
 }
 ],
 "included": [
 {
 "id": "47d3f4f2-e119-50cb-93f8-49a5fac024e2",
 "type": "company",
 "attributes": {
 "domain": "nonamesecurity.com",
 "company_name": "Noname Security Group",
 "ticker": null
 }
 }
 ],
 "meta": {
 "schema_version": "3.0",
 "record_state": "active"
 }
 }
}

3.11.
Github Repositories Dataset

Github Repositories Dataset API Endpoints

Retrieve company's Github Repositories

GET
/companies/{domain}/github_repositories

3.11.1.
Retrieve company's Github Repositories

Returns a list of company's Github Repositories.


GET

https://predictleads.com/api/v3/companies/{domain}/github_repositories

Path Parameters
`domain` `string` Company's domain.
Query Parameters
`first_seen_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `GithubRepositories` first seen after given date (ISO 8601).
`first_seen_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `GithubRepositories` first seen before given date (ISO 8601).
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Request was successfully processed.

{
  "data": [
    {
      "id": "1c2f062f-2a98-4094-b5f9-873da16f9466",
      "type": "github_repository",
      "attributes": {
        "url": "https://github.com/openmeterio/openmeter",
        "description": "Cloud Metering for AI, Billing and FinOps. Collect and aggregate millions of usage events in real-time.",
        "first_seen_at": "2023-06-21T05:28:35Z"
      },
      "relationships": {
        "company": {
          "data": {
            "id": "774930e8-6a14-5e6d-bac7-5df186711c52",
            "type": "company"
          }
        },
        "timeseries_datapoints": {
          "data": [
            {
              "id": "7e1b166f-5c76-43b0-bd05-5a339bbc6d67",
              "type": "timeseries_datapoint"
            },
            {
              "id": "78794042-40a9-424a-a049-0827d918791e",
              "type": "timeseries_datapoint"
            },
            {
              "id": "0598d12b-1526-48e8-8624-233a79acf842",
              "type": "timeseries_datapoint"
            },
            {
              "id": "315b14ba-c57a-43a0-ba1c-63d76daddd8d",
              "type": "timeseries_datapoint"
            },
            {
              "id": "da544be0-fd1a-4a6f-8d7e-c666f16b975a",
              "type": "timeseries_datapoint"
            },
            {
              "id": "0e1b5148-a022-4ed3-96f8-c9404980727a",
              "type": "timeseries_datapoint"
            },
            {
              "id": "424989d7-fb0c-4574-b0dc-b9b4389f3afe",
              "type": "timeseries_datapoint"
            },
            {
              "id": "5cf98ec1-b775-4a69-a74f-796c93a40603",
              "type": "timeseries_datapoint"
            },
            {
              "id": "8f38e1b3-5488-4fc9-a5be-28ca28a61de4",
              "type": "timeseries_datapoint"
            },
            {
              "id": "a471c2fb-19cd-451e-8d83-d01cccb906eb",
              "type": "timeseries_datapoint"
            },
            {
              "id": "534b84a5-e272-46c5-bd4e-bc26359ebf91",
              "type": "timeseries_datapoint"
            },
            {
              "id": "d1bad782-8532-402c-8f91-33560c66551b",
              "type": "timeseries_datapoint"
            },
            {
              "id": "c30ce065-ab4f-4076-b309-5b2e112c1bd7",
              "type": "timeseries_datapoint"
            },
            {
              "id": "69509321-ab79-4bf6-a997-ca64d6c9c987",
              "type": "timeseries_datapoint"
            },
            {
              "id": "72c7c725-6d69-4865-ad8f-6ae32d1aee58",
              "type": "timeseries_datapoint"
            },
            {
              "id": "4e521932-cbc7-41b5-b40e-f3cc54a40543",
              "type": "timeseries_datapoint"
            },
            {
              "id": "0dc772bf-ac85-4903-be41-fd5ac41c3f98",
              "type": "timeseries_datapoint"
            },
            {
              "id": "6340ad72-e92e-4405-bba5-710d91ffce29",
              "type": "timeseries_datapoint"
            },
            {
              "id": "651d12f9-e254-401b-a74a-0d5aa1d771ef",
              "type": "timeseries_datapoint"
            },
            {
              "id": "9f596991-e1dd-4b9b-89f4-dbdfba78e19a",
              "type": "timeseries_datapoint"
            },
            {
              "id": "3d18c7cc-373a-4200-9340-021d22526bbb",
              "type": "timeseries_datapoint"
            },
            {
              "id": "0176990c-3179-49fe-a554-3dba4e8753cf",
              "type": "timeseries_datapoint"
            },
            {
              "id": "51f78008-db13-42ee-a388-bde4d4bb90c0",
              "type": "timeseries_datapoint"
            },
            {
              "id": "6a9f5003-83f3-4f9f-b388-4eb06bdb2d77",
              "type": "timeseries_datapoint"
            },
            {
              "id": "150c58b8-e691-44cd-876f-a773cd8b75a1",
              "type": "timeseries_datapoint"
            },
            {
              "id": "cf8079bc-b8ed-45d7-9987-3bbce3a3b35f",
              "type": "timeseries_datapoint"
            },
            {
              "id": "9a93794c-3772-4396-9e88-e5e40a1f1c4f",
              "type": "timeseries_datapoint"
            },
            {
              "id": "36986e70-c55b-426a-be7d-1d5dcbccbb2b",
              "type": "timeseries_datapoint"
            },
            {
              "id": "0fdc8de1-d7d0-4020-92b2-f7723da86c3b",
              "type": "timeseries_datapoint"
            },
            {
              "id": "4f2c0926-e8f8-411c-b440-e23dcfb05c4f",
              "type": "timeseries_datapoint"
            },
            {
              "id": "406f1fb4-f840-4479-bf92-24024a3b7f2f",
              "type": "timeseries_datapoint"
            },
            {
              "id": "2710523b-4521-4eea-96d0-1ac0a590409e",
              "type": "timeseries_datapoint"
            },
            {
              "id": "b4c10c51-58a5-4a1f-9620-7c3450ce7c1f",
              "type": "timeseries_datapoint"
            },
            {
              "id": "3ef2c3f7-6e78-4b3e-b494-80b86f31fc0e",
              "type": "timeseries_datapoint"
            },
            {
              "id": "81b2ea0e-98c8-44ba-8c36-d705e5c632ec",
              "type": "timeseries_datapoint"
            },
            {
              "id": "bf1b4a1c-37fe-402b-a35e-045a18c007e9",
              "type": "timeseries_datapoint"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "7e1b166f-5c76-43b0-bd05-5a339bbc6d67",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-06-21T07:28:35.759+02:00",
        "data": {
          "forks": 5,
          "stars": 86,
          "watches": 3,
          "last_update_at": "2023-06-20T11:17:04Z"
        }
      }
    },
    {
      "id": "78794042-40a9-424a-a049-0827d918791e",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-06-21T07:28:35.759+02:00",
        "data": {
          "forks": 5,
          "stars": 86,
          "watches": 3,
          "last_update_at": "2023-06-20T11:17:04Z"
        }
      }
    },
    {
      "id": "0598d12b-1526-48e8-8624-233a79acf842",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-07-05T07:35:43.732+02:00",
        "data": {
          "forks": 12,
          "stars": 415,
          "watches": 6,
          "last_update_at": "2023-07-03T12:57:21Z"
        }
      }
    },
    {
      "id": "315b14ba-c57a-43a0-ba1c-63d76daddd8d",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-07-19T07:43:29.377+02:00",
        "data": {
          "forks": 15,
          "stars": 435,
          "watches": 6,
          "last_update_at": "2023-07-18T15:20:17Z"
        }
      }
    },
    {
      "id": "da544be0-fd1a-4a6f-8d7e-c666f16b975a",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-08-02T07:50:04.024+02:00",
        "data": {
          "forks": 15,
          "stars": 457,
          "watches": 6,
          "last_update_at": "2023-08-01T16:30:51Z"
        }
      }
    },
    {
      "id": "0e1b5148-a022-4ed3-96f8-c9404980727a",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-08-16T07:50:51.230+02:00",
        "data": {
          "forks": 16,
          "stars": 473,
          "watches": 6,
          "last_update_at": "2023-08-15T12:09:35Z"
        }
      }
    },
    {
      "id": "424989d7-fb0c-4574-b0dc-b9b4389f3afe",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-08-30T07:56:38.090+02:00",
        "data": {
          "forks": 16,
          "stars": 488,
          "watches": 6,
          "last_update_at": "2023-08-29T15:43:33Z"
        }
      }
    },
    {
      "id": "5cf98ec1-b775-4a69-a74f-796c93a40603",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-09-13T08:08:59.041+02:00",
        "data": {
          "forks": 19,
          "stars": 518,
          "watches": 6,
          "last_update_at": "2023-09-12T19:48:49Z"
        }
      }
    },
    {
      "id": "8f38e1b3-5488-4fc9-a5be-28ca28a61de4",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-09-27T08:15:02.452+02:00",
        "data": {
          "forks": 19,
          "stars": 552,
          "watches": 6,
          "last_update_at": "2023-09-26T23:33:33Z"
        }
      }
    },
    {
      "id": "a471c2fb-19cd-451e-8d83-d01cccb906eb",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-10-11T21:03:27.472+02:00",
        "data": {
          "forks": 20,
          "stars": 572,
          "watches": 7,
          "last_update_at": "2023-10-10T15:32:26Z"
        }
      }
    },
    {
      "id": "534b84a5-e272-46c5-bd4e-bc26359ebf91",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-10-26T04:40:09.324+02:00",
        "data": {
          "forks": 22,
          "stars": 589,
          "watches": 7,
          "last_update_at": "2023-10-21T09:35:39Z"
        }
      }
    },
    {
      "id": "d1bad782-8532-402c-8f91-33560c66551b",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-11-09T04:45:31.780+01:00",
        "data": {
          "forks": 23,
          "stars": 598,
          "watches": 7,
          "last_update_at": "2023-11-08T12:06:24Z"
        }
      }
    },
    {
      "id": "c30ce065-ab4f-4076-b309-5b2e112c1bd7",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-11-23T04:49:25.792+01:00",
        "data": {
          "forks": 24,
          "stars": 636,
          "watches": 7,
          "last_update_at": "2023-11-23T03:48:00Z"
        }
      }
    },
    {
      "id": "69509321-ab79-4bf6-a997-ca64d6c9c987",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-12-08T02:09:18.412+01:00",
        "data": {
          "forks": 25,
          "stars": 662,
          "watches": 7,
          "last_update_at": "2023-12-06T20:56:28Z"
        }
      }
    },
    {
      "id": "72c7c725-6d69-4865-ad8f-6ae32d1aee58",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2023-12-23T10:46:51.326+01:00",
        "data": {
          "forks": 26,
          "stars": 681,
          "watches": 8,
          "last_update_at": "2023-12-22T16:32:49Z"
        }
      }
    },
    {
      "id": "4e521932-cbc7-41b5-b40e-f3cc54a40543",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-01-07T03:54:34.442+01:00",
        "data": {
          "forks": 26,
          "stars": 708,
          "watches": 8,
          "last_update_at": "2024-01-06T14:38:59Z"
        }
      }
    },
    {
      "id": "0dc772bf-ac85-4903-be41-fd5ac41c3f98",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-01-21T08:22:54.207+01:00",
        "data": {
          "forks": 30,
          "stars": 722,
          "watches": 8,
          "last_update_at": "2024-01-19T10:55:47Z"
        }
      }
    },
    {
      "id": "6340ad72-e92e-4405-bba5-710d91ffce29",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-02-05T07:07:35.819+01:00",
        "data": {
          "forks": 31,
          "stars": 747,
          "watches": 8,
          "last_update_at": "2024-02-04T13:11:28Z"
        }
      }
    },
    {
      "id": "651d12f9-e254-401b-a74a-0d5aa1d771ef",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-02-19T10:41:17.782+01:00",
        "data": {
          "forks": 33,
          "stars": 767,
          "watches": 8,
          "last_update_at": "2024-02-18T09:54:41Z"
        }
      }
    },
    {
      "id": "9f596991-e1dd-4b9b-89f4-dbdfba78e19a",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-03-17T09:19:58.332+01:00",
        "data": {
          "forks": 37,
          "stars": 829,
          "watches": 8,
          "last_update_at": "2024-03-16T21:21:43Z"
        }
      }
    },
    {
      "id": "3d18c7cc-373a-4200-9340-021d22526bbb",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-03-22T11:13:22.255+01:00",
        "data": {
          "forks": 38,
          "stars": 834,
          "watches": 8,
          "last_update_at": "2024-03-21T18:15:37Z"
        }
      }
    },
    {
      "id": "0176990c-3179-49fe-a554-3dba4e8753cf",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-04-07T23:20:03.439+02:00",
        "data": {
          "forks": 41,
          "stars": 855,
          "watches": 8,
          "last_update_at": "2024-04-07T17:37:28Z"
        }
      }
    },
    {
      "id": "51f78008-db13-42ee-a388-bde4d4bb90c0",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-04-22T17:39:12.153+02:00",
        "data": {
          "forks": 41,
          "stars": 872,
          "watches": 8,
          "last_update_at": "2024-04-22T14:39:26Z"
        }
      }
    },
    {
      "id": "6a9f5003-83f3-4f9f-b388-4eb06bdb2d77",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-05-09T00:55:56.580+02:00",
        "data": {
          "forks": 45,
          "stars": 897,
          "watches": 8,
          "last_update_at": "2024-05-08T14:50:01Z"
        }
      }
    },
    {
      "id": "150c58b8-e691-44cd-876f-a773cd8b75a1",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-05-23T08:08:12.902+02:00",
        "data": {
          "forks": 47,
          "stars": 916,
          "watches": 9,
          "last_update_at": "2024-05-21T12:58:03Z"
        }
      }
    },
    {
      "id": "cf8079bc-b8ed-45d7-9987-3bbce3a3b35f",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-06-16T08:59:53.866+02:00",
        "data": {
          "forks": 50,
          "stars": 948,
          "watches": 10,
          "last_update_at": "2024-06-16T06:25:43Z"
        }
      }
    },
    {
      "id": "9a93794c-3772-4396-9e88-e5e40a1f1c4f",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-06-30T09:07:57.368+02:00",
        "data": {
          "forks": 51,
          "stars": 968,
          "watches": 10,
          "last_update_at": "2024-06-30T05:24:25Z"
        }
      }
    },
    {
      "id": "36986e70-c55b-426a-be7d-1d5dcbccbb2b",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-07-14T09:14:36.201+02:00",
        "data": {
          "forks": 55,
          "stars": 1013,
          "watches": 11,
          "last_update_at": "2024-07-13T19:57:41Z"
        }
      }
    },
    {
      "id": "0fdc8de1-d7d0-4020-92b2-f7723da86c3b",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-07-28T09:23:22.638+02:00",
        "data": {
          "forks": 56,
          "stars": 1027,
          "watches": 12,
          "last_update_at": "2024-07-26T12:47:28Z"
        }
      }
    },
    {
      "id": "4f2c0926-e8f8-411c-b440-e23dcfb05c4f",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-08-15T00:38:24.982+02:00",
        "data": {
          "forks": 57,
          "stars": 1041,
          "watches": 11,
          "last_update_at": "2024-08-14T19:02:47Z"
        }
      }
    },
    {
      "id": "406f1fb4-f840-4479-bf92-24024a3b7f2f",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-09-01T23:34:44.301+02:00",
        "data": {
          "forks": 59,
          "stars": 1063,
          "watches": 11,
          "last_update_at": "2024-08-31T09:00:01Z"
        }
      }
    },
    {
      "id": "2710523b-4521-4eea-96d0-1ac0a590409e",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-09-15T23:43:46.401+02:00",
        "data": {
          "forks": 60,
          "stars": 1075,
          "watches": 11,
          "last_update_at": "2024-09-14T10:18:37Z"
        }
      }
    },
    {
      "id": "b4c10c51-58a5-4a1f-9620-7c3450ce7c1f",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-09-29T23:49:51.571+02:00",
        "data": {
          "forks": 61,
          "stars": 1086,
          "watches": 11,
          "last_update_at": "2024-09-28T11:06:07Z"
        }
      }
    },
    {
      "id": "3ef2c3f7-6e78-4b3e-b494-80b86f31fc0e",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-10-14T21:19:24.183+02:00",
        "data": {
          "forks": 64,
          "stars": 1095,
          "watches": 11,
          "last_update_at": "2024-10-14T17:18:21Z"
        }
      }
    },
    {
      "id": "81b2ea0e-98c8-44ba-8c36-d705e5c632ec",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-10-28T21:26:41.636+01:00",
        "data": {
          "forks": 68,
          "stars": 1104,
          "watches": 11,
          "last_update_at": "2024-10-28T07:21:01Z"
        }
      }
    },
    {
      "id": "bf1b4a1c-37fe-402b-a35e-045a18c007e9",
      "type": "timeseries_datapoint",
      "attributes": {
        "timestamp": "2024-11-11T21:30:01.040+01:00",
        "data": {
          "forks": 68,
          "stars": 1114,
          "watches": 10,
          "last_update_at": "2024-11-11T19:49:24Z"
        }
      }
    },
    {
      "id": "774930e8-6a14-5e6d-bac7-5df186711c52",
      "type": "company",
      "attributes": {
        "domain": "openmeter.io",
        "company_name": "Openmeter",
        "ticker": null
      }
    }
  ],
  "meta": {
    "schema_version": "3.0",
    "record_state": "active"
  }
}

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about public GitHub repositories of companies",
 "description": "GitHub repositories gives insight into how frequently a website is contributing to its public GitHub\nrepository.\n",
 "type": "object",
 "required": [
 "data",
 "included"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes",
 "relationships"
 ],
 "properties": {
 "id": {
 "description": "ID of the `GithubRepository` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `GithubRepository` object.",
 "const": "github_repository"
 },
 "attributes": {
 "description": "Attributes of `GithubRepository` object.",
 "type": "object",
 "required": [
 "url",
 "description",
 "first_seen_at"
 ],
 "properties": {
 "url": {
 "description": "Url to GitHub repository.",
 "type": "string",
 "format": "uri"
 },
 "description": {
 "description": "Description of GitHub repository.",
 "type": [
 "string",
 "null"
 ]
 },
 "first_seen_at": {
 "description": "Date & time (ISO 8601) when the GitHub repository was discovered.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 }
 }
 },
 "relationships": {
 "description": "Contains references to related objects listed in property `included`.",
 "type": "object",
 "required": [
 "company",
 "timeseries_datapoints"
 ],
 "properties": {
 "company": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `CompanyLite` object.",
 "const": "company"
 }
 }
 }
 }
 },
 "timeseries_datapoints": {
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type"
 ],
 "properties": {
 "id": {
 "description": "ID of the included `TimeseriesDatapointGithubRepository` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the included `TimeseriesDatapointGithubRepository` object.",
 "const": "timeseries_datapoint"
 }
 }
 }
 }
 }
 }
 }
 }
 }
 }
 },
 "included": {
 "description": "Contains objects referenced in property `relationships`.",
 "type": "array",
 "items": {
 "oneOf": [
 {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `CompanyLite` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `CompanyLite` object.",
 "const": "company"
 },
 "attributes": {
 "description": "Attributes of `CompanyLite` object.",
 "type": "object",
 "required": [
 "domain",
 "ticker",
 "company_name"
 ],
 "properties": {
 "domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "ticker": {
 "description": "Company stock symbol (ticker) if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 }
 }
 }
 }
 },
 {
 "properties": {
 "attributes": {
 "properties": {
 "data": {
 "type": "object",
 "required": [
 "forks",
 "stars",
 "watches",
 "last_update_at"
 ],
 "properties": {
 "forks": {
 "description": "Number of times this repository was forked at the creation of this datapoint.",
 "type": "integer"
 },
 "stars": {
 "description": "Number of times this repository was starred at the creation of this datapoint.",
 "type": "integer"
 },
 "watches": {
 "description": "Number of GitHub profiles that were watching this repository at the creation of this datapoint.",
 "type": "integer"
 },
 "last_update_at": {
 "description": "Date & time (ISO 8601) of the last update to the repository at the creation of this datapoint.",
 "type": "string",
 "format": "date-time",
 "example": "2024-09-25T16:09:53+00:00"
 }
 }
 }
 }
 }
 }
 }
 ],
 "discriminator": {
 "propertyName": "type"
 }
 }
 },
 "meta": {
 "description": "Meta information about `GithubRepositoriesDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "1c2f062f-2a98-4094-b5f9-873da16f9466",
 "type": "github_repository",
 "attributes": {
 "url": "https://github.com/openmeterio/openmeter",
 "description": "Cloud Metering for AI, Billing and FinOps. Collect and aggregate millions of usage events in real-time.",
 "first_seen_at": "2023-06-21T05:28:35Z"
 },
 "relationships": {
 "company": {
 "data": {
 "id": "774930e8-6a14-5e6d-bac7-5df186711c52",
 "type": "company"
 }
 },
 "timeseries_datapoints": {
 "data": [
 {
 "id": "7e1b166f-5c76-43b0-bd05-5a339bbc6d67",
 "type": "timeseries_datapoint"
 },
 {
 "id": "78794042-40a9-424a-a049-0827d918791e",
 "type": "timeseries_datapoint"
 },
 {
 "id": "0598d12b-1526-48e8-8624-233a79acf842",
 "type": "timeseries_datapoint"
 },
 {
 "id": "315b14ba-c57a-43a0-ba1c-63d76daddd8d",
 "type": "timeseries_datapoint"
 },
 {
 "id": "da544be0-fd1a-4a6f-8d7e-c666f16b975a",
 "type": "timeseries_datapoint"
 },
 {
 "id": "0e1b5148-a022-4ed3-96f8-c9404980727a",
 "type": "timeseries_datapoint"
 },
 {
 "id": "424989d7-fb0c-4574-b0dc-b9b4389f3afe",
 "type": "timeseries_datapoint"
 },
 {
 "id": "5cf98ec1-b775-4a69-a74f-796c93a40603",
 "type": "timeseries_datapoint"
 },
 {
 "id": "8f38e1b3-5488-4fc9-a5be-28ca28a61de4",
 "type": "timeseries_datapoint"
 },
 {
 "id": "a471c2fb-19cd-451e-8d83-d01cccb906eb",
 "type": "timeseries_datapoint"
 },
 {
 "id": "534b84a5-e272-46c5-bd4e-bc26359ebf91",
 "type": "timeseries_datapoint"
 },
 {
 "id": "d1bad782-8532-402c-8f91-33560c66551b",
 "type": "timeseries_datapoint"
 },
 {
 "id": "c30ce065-ab4f-4076-b309-5b2e112c1bd7",
 "type": "timeseries_datapoint"
 },
 {
 "id": "69509321-ab79-4bf6-a997-ca64d6c9c987",
 "type": "timeseries_datapoint"
 },
 {
 "id": "72c7c725-6d69-4865-ad8f-6ae32d1aee58",
 "type": "timeseries_datapoint"
 },
 {
 "id": "4e521932-cbc7-41b5-b40e-f3cc54a40543",
 "type": "timeseries_datapoint"
 },
 {
 "id": "0dc772bf-ac85-4903-be41-fd5ac41c3f98",
 "type": "timeseries_datapoint"
 },
 {
 "id": "6340ad72-e92e-4405-bba5-710d91ffce29",
 "type": "timeseries_datapoint"
 },
 {
 "id": "651d12f9-e254-401b-a74a-0d5aa1d771ef",
 "type": "timeseries_datapoint"
 },
 {
 "id": "9f596991-e1dd-4b9b-89f4-dbdfba78e19a",
 "type": "timeseries_datapoint"
 },
 {
 "id": "3d18c7cc-373a-4200-9340-021d22526bbb",
 "type": "timeseries_datapoint"
 },
 {
 "id": "0176990c-3179-49fe-a554-3dba4e8753cf",
 "type": "timeseries_datapoint"
 },
 {
 "id": "51f78008-db13-42ee-a388-bde4d4bb90c0",
 "type": "timeseries_datapoint"
 },
 {
 "id": "6a9f5003-83f3-4f9f-b388-4eb06bdb2d77",
 "type": "timeseries_datapoint"
 },
 {
 "id": "150c58b8-e691-44cd-876f-a773cd8b75a1",
 "type": "timeseries_datapoint"
 },
 {
 "id": "cf8079bc-b8ed-45d7-9987-3bbce3a3b35f",
 "type": "timeseries_datapoint"
 },
 {
 "id": "9a93794c-3772-4396-9e88-e5e40a1f1c4f",
 "type": "timeseries_datapoint"
 },
 {
 "id": "36986e70-c55b-426a-be7d-1d5dcbccbb2b",
 "type": "timeseries_datapoint"
 },
 {
 "id": "0fdc8de1-d7d0-4020-92b2-f7723da86c3b",
 "type": "timeseries_datapoint"
 },
 {
 "id": "4f2c0926-e8f8-411c-b440-e23dcfb05c4f",
 "type": "timeseries_datapoint"
 },
 {
 "id": "406f1fb4-f840-4479-bf92-24024a3b7f2f",
 "type": "timeseries_datapoint"
 },
 {
 "id": "2710523b-4521-4eea-96d0-1ac0a590409e",
 "type": "timeseries_datapoint"
 },
 {
 "id": "b4c10c51-58a5-4a1f-9620-7c3450ce7c1f",
 "type": "timeseries_datapoint"
 },
 {
 "id": "3ef2c3f7-6e78-4b3e-b494-80b86f31fc0e",
 "type": "timeseries_datapoint"
 },
 {
 "id": "81b2ea0e-98c8-44ba-8c36-d705e5c632ec",
 "type": "timeseries_datapoint"
 },
 {
 "id": "bf1b4a1c-37fe-402b-a35e-045a18c007e9",
 "type": "timeseries_datapoint"
 }
 ]
 }
 }
 }
 ],
 "included": [
 {
 "id": "7e1b166f-5c76-43b0-bd05-5a339bbc6d67",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-06-21T07:28:35.759+02:00",
 "data": {
 "forks": 5,
 "stars": 86,
 "watches": 3,
 "last_update_at": "2023-06-20T11:17:04Z"
 }
 }
 },
 {
 "id": "78794042-40a9-424a-a049-0827d918791e",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-06-21T07:28:35.759+02:00",
 "data": {
 "forks": 5,
 "stars": 86,
 "watches": 3,
 "last_update_at": "2023-06-20T11:17:04Z"
 }
 }
 },
 {
 "id": "0598d12b-1526-48e8-8624-233a79acf842",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-07-05T07:35:43.732+02:00",
 "data": {
 "forks": 12,
 "stars": 415,
 "watches": 6,
 "last_update_at": "2023-07-03T12:57:21Z"
 }
 }
 },
 {
 "id": "315b14ba-c57a-43a0-ba1c-63d76daddd8d",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-07-19T07:43:29.377+02:00",
 "data": {
 "forks": 15,
 "stars": 435,
 "watches": 6,
 "last_update_at": "2023-07-18T15:20:17Z"
 }
 }
 },
 {
 "id": "da544be0-fd1a-4a6f-8d7e-c666f16b975a",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-08-02T07:50:04.024+02:00",
 "data": {
 "forks": 15,
 "stars": 457,
 "watches": 6,
 "last_update_at": "2023-08-01T16:30:51Z"
 }
 }
 },
 {
 "id": "0e1b5148-a022-4ed3-96f8-c9404980727a",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-08-16T07:50:51.230+02:00",
 "data": {
 "forks": 16,
 "stars": 473,
 "watches": 6,
 "last_update_at": "2023-08-15T12:09:35Z"
 }
 }
 },
 {
 "id": "424989d7-fb0c-4574-b0dc-b9b4389f3afe",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-08-30T07:56:38.090+02:00",
 "data": {
 "forks": 16,
 "stars": 488,
 "watches": 6,
 "last_update_at": "2023-08-29T15:43:33Z"
 }
 }
 },
 {
 "id": "5cf98ec1-b775-4a69-a74f-796c93a40603",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-09-13T08:08:59.041+02:00",
 "data": {
 "forks": 19,
 "stars": 518,
 "watches": 6,
 "last_update_at": "2023-09-12T19:48:49Z"
 }
 }
 },
 {
 "id": "8f38e1b3-5488-4fc9-a5be-28ca28a61de4",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-09-27T08:15:02.452+02:00",
 "data": {
 "forks": 19,
 "stars": 552,
 "watches": 6,
 "last_update_at": "2023-09-26T23:33:33Z"
 }
 }
 },
 {
 "id": "a471c2fb-19cd-451e-8d83-d01cccb906eb",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-10-11T21:03:27.472+02:00",
 "data": {
 "forks": 20,
 "stars": 572,
 "watches": 7,
 "last_update_at": "2023-10-10T15:32:26Z"
 }
 }
 },
 {
 "id": "534b84a5-e272-46c5-bd4e-bc26359ebf91",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-10-26T04:40:09.324+02:00",
 "data": {
 "forks": 22,
 "stars": 589,
 "watches": 7,
 "last_update_at": "2023-10-21T09:35:39Z"
 }
 }
 },
 {
 "id": "d1bad782-8532-402c-8f91-33560c66551b",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-11-09T04:45:31.780+01:00",
 "data": {
 "forks": 23,
 "stars": 598,
 "watches": 7,
 "last_update_at": "2023-11-08T12:06:24Z"
 }
 }
 },
 {
 "id": "c30ce065-ab4f-4076-b309-5b2e112c1bd7",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-11-23T04:49:25.792+01:00",
 "data": {
 "forks": 24,
 "stars": 636,
 "watches": 7,
 "last_update_at": "2023-11-23T03:48:00Z"
 }
 }
 },
 {
 "id": "69509321-ab79-4bf6-a997-ca64d6c9c987",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-12-08T02:09:18.412+01:00",
 "data": {
 "forks": 25,
 "stars": 662,
 "watches": 7,
 "last_update_at": "2023-12-06T20:56:28Z"
 }
 }
 },
 {
 "id": "72c7c725-6d69-4865-ad8f-6ae32d1aee58",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2023-12-23T10:46:51.326+01:00",
 "data": {
 "forks": 26,
 "stars": 681,
 "watches": 8,
 "last_update_at": "2023-12-22T16:32:49Z"
 }
 }
 },
 {
 "id": "4e521932-cbc7-41b5-b40e-f3cc54a40543",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-01-07T03:54:34.442+01:00",
 "data": {
 "forks": 26,
 "stars": 708,
 "watches": 8,
 "last_update_at": "2024-01-06T14:38:59Z"
 }
 }
 },
 {
 "id": "0dc772bf-ac85-4903-be41-fd5ac41c3f98",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-01-21T08:22:54.207+01:00",
 "data": {
 "forks": 30,
 "stars": 722,
 "watches": 8,
 "last_update_at": "2024-01-19T10:55:47Z"
 }
 }
 },
 {
 "id": "6340ad72-e92e-4405-bba5-710d91ffce29",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-02-05T07:07:35.819+01:00",
 "data": {
 "forks": 31,
 "stars": 747,
 "watches": 8,
 "last_update_at": "2024-02-04T13:11:28Z"
 }
 }
 },
 {
 "id": "651d12f9-e254-401b-a74a-0d5aa1d771ef",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-02-19T10:41:17.782+01:00",
 "data": {
 "forks": 33,
 "stars": 767,
 "watches": 8,
 "last_update_at": "2024-02-18T09:54:41Z"
 }
 }
 },
 {
 "id": "9f596991-e1dd-4b9b-89f4-dbdfba78e19a",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-03-17T09:19:58.332+01:00",
 "data": {
 "forks": 37,
 "stars": 829,
 "watches": 8,
 "last_update_at": "2024-03-16T21:21:43Z"
 }
 }
 },
 {
 "id": "3d18c7cc-373a-4200-9340-021d22526bbb",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-03-22T11:13:22.255+01:00",
 "data": {
 "forks": 38,
 "stars": 834,
 "watches": 8,
 "last_update_at": "2024-03-21T18:15:37Z"
 }
 }
 },
 {
 "id": "0176990c-3179-49fe-a554-3dba4e8753cf",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-04-07T23:20:03.439+02:00",
 "data": {
 "forks": 41,
 "stars": 855,
 "watches": 8,
 "last_update_at": "2024-04-07T17:37:28Z"
 }
 }
 },
 {
 "id": "51f78008-db13-42ee-a388-bde4d4bb90c0",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-04-22T17:39:12.153+02:00",
 "data": {
 "forks": 41,
 "stars": 872,
 "watches": 8,
 "last_update_at": "2024-04-22T14:39:26Z"
 }
 }
 },
 {
 "id": "6a9f5003-83f3-4f9f-b388-4eb06bdb2d77",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-05-09T00:55:56.580+02:00",
 "data": {
 "forks": 45,
 "stars": 897,
 "watches": 8,
 "last_update_at": "2024-05-08T14:50:01Z"
 }
 }
 },
 {
 "id": "150c58b8-e691-44cd-876f-a773cd8b75a1",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-05-23T08:08:12.902+02:00",
 "data": {
 "forks": 47,
 "stars": 916,
 "watches": 9,
 "last_update_at": "2024-05-21T12:58:03Z"
 }
 }
 },
 {
 "id": "cf8079bc-b8ed-45d7-9987-3bbce3a3b35f",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-06-16T08:59:53.866+02:00",
 "data": {
 "forks": 50,
 "stars": 948,
 "watches": 10,
 "last_update_at": "2024-06-16T06:25:43Z"
 }
 }
 },
 {
 "id": "9a93794c-3772-4396-9e88-e5e40a1f1c4f",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-06-30T09:07:57.368+02:00",
 "data": {
 "forks": 51,
 "stars": 968,
 "watches": 10,
 "last_update_at": "2024-06-30T05:24:25Z"
 }
 }
 },
 {
 "id": "36986e70-c55b-426a-be7d-1d5dcbccbb2b",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-07-14T09:14:36.201+02:00",
 "data": {
 "forks": 55,
 "stars": 1013,
 "watches": 11,
 "last_update_at": "2024-07-13T19:57:41Z"
 }
 }
 },
 {
 "id": "0fdc8de1-d7d0-4020-92b2-f7723da86c3b",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-07-28T09:23:22.638+02:00",
 "data": {
 "forks": 56,
 "stars": 1027,
 "watches": 12,
 "last_update_at": "2024-07-26T12:47:28Z"
 }
 }
 },
 {
 "id": "4f2c0926-e8f8-411c-b440-e23dcfb05c4f",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-08-15T00:38:24.982+02:00",
 "data": {
 "forks": 57,
 "stars": 1041,
 "watches": 11,
 "last_update_at": "2024-08-14T19:02:47Z"
 }
 }
 },
 {
 "id": "406f1fb4-f840-4479-bf92-24024a3b7f2f",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-09-01T23:34:44.301+02:00",
 "data": {
 "forks": 59,
 "stars": 1063,
 "watches": 11,
 "last_update_at": "2024-08-31T09:00:01Z"
 }
 }
 },
 {
 "id": "2710523b-4521-4eea-96d0-1ac0a590409e",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-09-15T23:43:46.401+02:00",
 "data": {
 "forks": 60,
 "stars": 1075,
 "watches": 11,
 "last_update_at": "2024-09-14T10:18:37Z"
 }
 }
 },
 {
 "id": "b4c10c51-58a5-4a1f-9620-7c3450ce7c1f",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-09-29T23:49:51.571+02:00",
 "data": {
 "forks": 61,
 "stars": 1086,
 "watches": 11,
 "last_update_at": "2024-09-28T11:06:07Z"
 }
 }
 },
 {
 "id": "3ef2c3f7-6e78-4b3e-b494-80b86f31fc0e",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-10-14T21:19:24.183+02:00",
 "data": {
 "forks": 64,
 "stars": 1095,
 "watches": 11,
 "last_update_at": "2024-10-14T17:18:21Z"
 }
 }
 },
 {
 "id": "81b2ea0e-98c8-44ba-8c36-d705e5c632ec",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-10-28T21:26:41.636+01:00",
 "data": {
 "forks": 68,
 "stars": 1104,
 "watches": 11,
 "last_update_at": "2024-10-28T07:21:01Z"
 }
 }
 },
 {
 "id": "bf1b4a1c-37fe-402b-a35e-045a18c007e9",
 "type": "timeseries_datapoint",
 "attributes": {
 "timestamp": "2024-11-11T21:30:01.040+01:00",
 "data": {
 "forks": 68,
 "stars": 1114,
 "watches": 10,
 "last_update_at": "2024-11-11T19:49:24Z"
 }
 }
 },
 {
 "id": "774930e8-6a14-5e6d-bac7-5df186711c52",
 "type": "company",
 "attributes": {
 "domain": "openmeter.io",
 "company_name": "Openmeter",
 "ticker": null
 }
 }
 ],
 "meta": {
 "schema_version": "3.0",
 "record_state": "active"
 }
 }
}

3.12.
Startup Platform Posts Dataset

Startup Platform Posts Dataset API Endpoints

Retrieve latest posts

GET
/discover/startup_platform_posts

3.12.1.
Retrieve latest posts

Returns a list of latest posts on popular startup platforms by companies that are hiring or launching new products.


GET

https://predictleads.com/api/v3/discover/startup_platform_posts

Query Parameters
`published_at_from` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `StartupPlatformPosts` published after given date (ISO 8601).
`published_at_until` [optional] `string` Format: `date` Example: `"2024-09-25"` Only return `StartupPlatformPosts` published before given date (ISO 8601).
`post_types` [optional] `array` Comma-separated (,) `StartupPlatformPost` post types.
Items
One of
`string` Constant: `"show_hn"` Post on startup platform Hacker News - Show page.
`string` Constant: `"job_hn"` Post on startup platform Hacker News - Job page.
`page` [optional] `integer` Default: 1 Minimum: 1 Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.
`limit` [optional] `integer` Default: 100 Maximum: 1000 Limit the number of shown items per page.

Request Examples

Response Examples

Response Schemas

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "summary": "Information about posts on popular startup platforms",
 "description": "Provides information about posts on popular startup platforms by companies that are hiring or\nlaunching new products.\n",
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `StartupPlatformPost` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `StartupPlatformPost` object.",
 "const": "startup_platform_post"
 },
 "attributes": {
 "description": "Attributes of `StartupPlatformPost` object.",
 "type": "object",
 "required": [
 "published_at",
 "post_type",
 "post_url",
 "company_domain",
 "company_name",
 "fuzzy_match"
 ],
 "properties": {
 "published_at": {
 "description": "Date & time (ISO 8601) when the `StartupPlatformPost` was published.",
 "type": "string",
 "format": "date-time"
 },
 "post_type": {
 "description": "Indicates on what startup platform post was found.",
 "type": "string",
 "oneOf": [
 {
 "description": "Post on startup platform Hacker News - Show page.",
 "const": "show_hn"
 },
 {
 "description": "Post on startup platform Hacker News - Job page.",
 "const": "job_hn"
 }
 ]
 },
 "post_url": {
 "description": "Url to post.",
 "type": "string",
 "format": "uri"
 },
 "company_domain": {
 "description": "Company domain name.",
 "type": "string"
 },
 "company_name": {
 "description": "Company name if available.",
 "type": [
 "string",
 "null"
 ]
 },
 "fuzzy_match": {
 "description": "When true we might not have extracted the product name cleanly. When false exact product name should be extracted well.",
 "type": [
 "boolean"
 ]
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `StartupPlatformPostsDataset` object.\n",
 "type": "object",
 "required": [
 "schema_version",
 "record_state"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 },
 "record_state": {
 "description": "Represents record state of objects.\n",
 "type": "string",
 "const": "active"
 },
 "count": {
 "description": "Total number of results.\n \n**NOTE**: Only shown in API responses. For performance reasons it will be omitted from response\nif `page` request parameter is not provided.\n",
 "type": "integer",
 "example": 344
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "941340",
 "type": "startup_platform_post",
 "attributes": {
 "published_at": "2024-11-02T19:28:31.000+01:00",
 "post_type": "show_hn",
 "post_url": "https://news.ycombinator.com/item?id=42028186",
 "company_domain": "incrediboxmustard.cc",
 "company_name": "Incredibox Mustard",
 "fuzzy_match": false
 }
 }
 ],
 "meta": {
 "schema_version": "3.0",
 "record_state": "active"
 }
 }
}

3.13.
Subscriptions

Subscriptions API Endpoints

Retrieve API subscription information

GET
/api_subscription

3.13.1.
Retrieve API subscription information

Provides the current subscription's status and usage limits


GET

https://predictleads.com/api/v3/api_subscription

Request Examples

Response Examples

Response Schemas

{
 "description": "Provides the current subscription's status and API usage limits.\n \nThis endpoint returns the current subscription's status, the maximum number of API requests allowed per month,\nand the number of API requests made so far during the current month.\n",
 "type": "object",
 "required": [
 "data"
 ],
 "properties": {
 "data": {
 "type": "array",
 "items": {
 "type": "object",
 "required": [
 "id",
 "type",
 "attributes"
 ],
 "properties": {
 "id": {
 "description": "ID of the `ApiSubscription` object.",
 "type": "string",
 "format": "uuid"
 },
 "type": {
 "description": "Type of the `ApiSubscription` object.",
 "const": "api_subscription"
 },
 "attributes": {
 "type": "object",
 "required": [
 "status",
 "max_monthly_api_requests",
 "monthly_api_request_count"
 ],
 "properties": {
 "status": {
 "description": "Current subscription status.",
 "enum": [
 "disabled",
 "active",
 "disabled_due_to_error"
 ]
 },
 "max_monthly_api_requests": {
 "description": "Amount of available monthly requests with the current subscription.",
 "type": "integer"
 },
 "monthly_api_request_count": {
 "description": "Current amount of used API requests.",
 "type": "integer"
 }
 }
 }
 }
 }
 },
 "meta": {
 "description": "Meta information about `ApiSubscription` object.\n",
 "type": "object",
 "required": [
 "schema_version"
 ],
 "properties": {
 "schema_version": {
 "description": "Represents schema version of objects.\n",
 "type": "string"
 }
 }
 }
 },
 "example": {
 "data": [
 {
 "id": "fd1348c5-df03-4b94-a970-17057f108858",
 "type": "api_subscription",
 "attributes": {
 "status": "active",
 "max_monthly_api_requests": 1000000,
 "monthly_api_request_count": 10
 }
 }
 ],
 "meta": {
 "schema_version": "3.0"
 }
 }
}