Documentation

-

Quick Start

  1. Create a test or production APP in the API explorer.
  2. Get your token or API key for authentification
  3. (authentification, see code snippets).
  4. Simulate a query if needed, or check the data request you are looking for via the attribute section
  5. (requests, see code snippets).

You are set to go!


Authentification

Access to Invyo's APIs is restricted by a token-based authentication. In other words, your account is associated with a unique api key and api secret that is required to connect to the API endpoints. You can find your API token on the API Explorer.

In order to identify you, we will require you to send your token with every HTTP request you make. This can be achieved in two different ways.

You can either :

  • set it in the authenticationKey and authenticationSecret in request header
    (ex. authenticationKey: YOUR_KEY;authenticationSecret: YOUR_SECRET)
  • or you can include it directly in the body parameter with the same name

This token is private, be careful not to use it in client-side applications.

All API request must be performed via HTTPS. Requests will fail otherwise.


Errors

Invyo's APIs uses the Status-Line part of every HTTP responses' message to inform you of your request’s overarching result.

code description
200 OK
404 Not Found
429 Too Many Requests
981 Error in request (custom)

Attributes

Here are all the data you can get from our API. The following tables introduce the data using the same structure.

  • attribute: the attribute's name used to get the targeted data
  • type: the attribute's type with, in some cases, the data structure. The most common types are object, array, string, integer and float
  • example: the answer you get from a live request
  • description: more information about the attribute, its definition or its use

Attributes are distributed in 5 categories:

node endpoint
Company /company
Sector /sector
Country /country
Topic /topic
People /people

Each category is sturctured between 4 to 5 subnodes or data groups:

subnode description
Profile General information about the selected category
Market Sentiment Sentiment related to the selected category
Media Intell Noise made by the targeted category
Network Relationships between the selected category and companies, people, etc.
Funding Funding related to the selected category

AttributesCompany

Attributes > CompanyProfile

attributes type example description
id integer 1202 Company ID
name string "Revolut" Current company name
other_name array[strings] [] Other company name(s)
previous_name array[strings] [] Past company name(s)
logo string "https://****/img/n26.png" Company logo URL
type object{} {} Company type. Object includes type name and ID
typeid integer 1 Company type ID
typename string "start-up" Compay type name
total_companySameType integer 1299 Total company same type
sector object{} {} Company sector. Object includes sector name and ID
sectorid integer 4 Company sector ID
sectorname string "neobank" Company sector name
total_companySameSector integer 219 Total company same sector
region object{} {} Region where company is headquartered. Object includes region name and ID
regionid integer 15 Company region ID
regionname string "europe" Company region name
total_companySameRegion integer 3523 Total company same region
country object{} {} Country where company is headquartered. Object includes country name and ID.
countryid integer 15 Company country ID
countryname string "United Kingdom" Company country name
total_companySameCountry integer 411 Total company same country
associated_tags array[objects{}] [{}] Tags associated to company
associated_tagsid integer 12 Associated tag id
associated_tagsname string "neobank" Associated tag name
founders array[objects{}] [{}] Object includes ID et key people names
foundersid integer 1 Company key people ID
foundersname string "Nikolay Storonsky" Company key people name
creation_date integer 2016 Company launch date
description string "A world beyond banking - a secure, mobile-based (...)" Company description
status string "active" Current company status
website_url string "https://www.revolut.com/" Company website URL
employees integer 1500 Total company employees
same_size integer 56 Total company same size
contact_mail string "hello@revolut.com" Company contact mail
twitter object{} {} Object includes name and Twitter account URL
twittername string "RevolutApp" Company Twitter account name
twitterurl string "https://twitter.com/revolutapp" Company Twitter account URL
facebook object{} {} Object includes name and Facebook account URL
facebookname array[strings] ["Revolut", "revolutapp", "@revolutapp"] Company Facebook account name
facebookurl string "https://www.facebook.com/revolutapp" Company Facebook account URL
linkedin object{} {} Object includes name and LinkedIn account URL
linkedinname string "revolut" Company Linkedin account name
linkedinurl string "https://www.linkedin.com/company/revolut/" Company Linkedin account link
{
    "id": 1,
    "name": "Revolut",
    "other_name": [],
    "previous_name": [],
    "logo": "https://****/img/n26.png",
    "type": {
        "id": 1,
        "name": "start-up"
    },
    "total_companySameType": 1299,
    "sector": {
        "id": 4,
        "name": "Neobank"
    },
    "total_companySameSector": 219,
    "country": {
        "id": 15,
        "name": "United Kingdom"
    },
    "total_companySameRegion": 3523,
    "region": {
        "id": 1,
        "name": "europe"
    },
    "total_companySameCountry": 411,
    "associated_tags": [
        {
            "id": 12,
            "name": "neobank"
        },
        {
            "id": 16,
            "name": "payment"
        }
    ],
    "founders": [
        {
            "id": 1,
            "name": "Nikolay Storonsky"
        },
        {
            "id": 2,
            "name": "Vlad Yatsenko"
            
        }
    ],
    "creation_date": 2016,
    "description": "A world beyond banking - a secure, mobile-based current account that allows you to hold, exchange and transfer without fees in 25 different currencies.",
    "status": "active",
    "website_url": "https://www.revolut.com/",
    "employees": 1500,
    "same_size": 56,
    "contact_mail": "hello@revolut.com",
    "twitter": {
        "name": "RevolutApp",
        "url": "https://twitter.com/revolutapp"
    },
    "facebook": {
        "name": [
            "Revolut",
            "revolutapp",
            "@revolutapp"
        ],
        "url": "https://www.facebook.com/revolutapp"
    },
    "linkedin": {
        "name": "revolut",
        "url": "https://www.linkedin.com/company/revolut/"
    }
}
                                    

AttributesMarket Sentiment

attributes type example description
sentiment_current object{} {} Object includes current sentiment index and sentiment
sentiment_currentindex string "1.72" Company current sentiment index
sentiment_currentqual string "positive" Company current sentiment
sentiment_year array[objects{}] [{}] Company sentiment per year. Object includes year, index and sentiment
sentiment_yeardate integer 2019 Selected year
sentiment_yearindex string "0.005670823564287275" Company index at selected year
sentiment_yearqual string "positive" Company sentiment at selected year
sentiment_period array[objects{}] [{}] Company sentiment per day. Object includes YYYY-MM-DD, index and sentiment
sentiment_perioddate string "2019-01-02" Selected day
sentiment_periodindex string "0.005670823564287275" Company index at selected day
sentiment_periodqual string "positive" Company sentiment at selected day
{
    "sentiment_current": {
        "index": "1.72",
        "qual": "positive"
    },
    "sentiment_year": [
        {
            "date": 2019,
            "index": "0.065846581555155484"
            "qual": "positive"
        },
        {
            "date": 2018,
            "index": "0.065846581555155484"
            "qual": "positive"
        }
    ],
    "sentiment_period": [
        {
            "date": "2019-01-02",
            "index": "0.006459482652625398",
            "qual": "positive"
        },
        {
            "date": "2019-01-01",
            "index": "0.065846581555155484",
            "qual": "positive"
        }
    ]
}                                   
                                    

AttributesMedia Intelligence

def "bruit" Adipisicing quis minim aliqua aliqua labore cillum fugiat. Magna excepteur nulla ea velit laborum anim do. Elit incididunt dolor ad laboris in. Nostrud ullamco duis nulla veniam consectetur adipisicing pariatur nulla aliqua Lorem consectetur cillum labore duis.

attributes type example description
noise_total_news integer 1569 Total company news coverage
noise_fromLastWeek object{} {} Object includes company news coverage index and evolution from last week
noise_fromLastWeekindex string "-72.53" Company news coverage index from last week
noise_fromLastWeekqual string "down" Company news coverage evolution from last week
noise_year array[objects{}] [{}] Company total post per year. Object includes year YYYY and total post, descending
noise_yeardate integer 2019 Selected year
noise_yeartotal integer 255 Company total post at selected year
noise_period array[objects{}] [{}] Company total post per day. Object includes date YYYY-MM-DD and total post, descending
noise_perioddate string "2019-01-02" Selected day
noise_periodtotal integer 19 Company total post at selected day
{
    "noise_total_news": 1569,

    "noise_fromLastWeek": {
        "index": "-72.53,"
        "qual": "down"
    } 
    "noise_year": [
        {
            "date": 2019,
            "total": 255
        },
        {
            "date": 2018,
            "total": 2423
        }
    ]
    "noise_period": [
        {
            "date": "2019-01-02",
            "total": 19
        },
        {
            "date": "2019-01-01",
            "total": 15
        }
    ]
}  
                                    

AttributesNetwork

attributes type example description
company_relationship array[objects{}] [{}] Object includes company relation ID, company relation name, relation type name, relation type ID and relation weight
company_relationshipid integer 2871 Related company ID
company_relationshipname string "Starling Bank" Related company name
company_relationshiptype_id integer 1 Relation type ID
company_relationshiptype string "competitor" Relation type name
company_relationshipstrength string "162.00" Relation weight
{
    "company_relationship" [
        {
            "id": 1166,
            "name": "N26",
            "type_id": 1,
            "type": "competitor",
            "strength": "162.00"
        },
        {
            "id": 2871,
            "name": "Starling Bank",
            "type_id": 1,
            "type": "competitor",
            "strength": "1.23"
        }
    ]
}
                                    

AttributesFunding

attributes type example description
funding_total object{} {} Object includes total amount raised, total number of funding rounds, total number of investors and investors name
funding_totalamount string "336900000.00" Total amount raised by company
funding_totalcount integer 13 Total number of funding rounds by company
funding_totalinvestors_count integer 28 Total number of investors
funding_totalinvestors array[strings] ["Sprints Capital", "Socii Capital"] Investors name
funding_item array[objects{}] [{}] Object includes funding single ID, date, amount, type, news, total number of investors, investors name and total number of news
funding_itemid integer 237 Funding single ID
funding_itemdate string "2018-04-26" Funding single date
funding_itemamount string "250000000.00" Funding single amount
funding_itemtype string "Series C" Funding single type
funding_itemdescription string "Digital-Banking Startup Revolut Is Worth $1.7 Billion With New Funding" Funding single news
funding_iteminvestors_count integer 9 Total number of investors
funding_iteminvestors ["Sprints Capital", "Socii Capital"] ["Sprints Capital", "Socii Capital"] Array of investors name
funding_itemtotal_news integer 43 Total number of news
 {
    "funding_total": {
        "amount": "336900000.00",
        "count": 13,
        "investors_count": 28,
        "investors": [
            "DST Global", 
            "Ribbit Capital"
        ]
    },

    "funding_item": [
        {
            "id": 237,
            "date": "2018-04-26",
            "amount: "250000000.00",
            "type": "Series C",
            "description": "Digital-Banking Startup Revolut Is Worth $1.7 Billion With New Funding",
            "investors_count": 9,
            "investors": [
                "Sprints Capital", 
                "Socii Capital"
            ],
            "total_news": 43
        },
        {
            "id": 195,
            "date": 2017-07-11,
            "amount: "66000000.00",
            "type": Series B,
            "description": "UK fintech start-up Revolut raises $66 million, adds bitcoin",
            "investors_count": 4,
            "investors": [
                "Index Ventures", 
                "Ribbit Capital"
            ],
            "total_news": 21
        }
    ]   
 }                    
                                    

AttributesSector

Attributes > SectorProfile

attributes type example description
id integer 1 Sector ID
name string "Alternative funding" Current Sector name
total_companySameSector integer 740 Total company same sector
associated_tags array[objects{}] [{}] Tags associated to sector
associated_tagsid integer 12 Associated tag id
associated_tagsname string "neobank" Associated tag name
description string "Alternative funding includes all types of (...)" Company description
{
    "id": 1,
    "name": "Alternative funding",
    "total_companySameSector": 740,
    "associated_tags": [
        {
            "id": 12,
            "name": "neobank"
        },
        {
            "id": 16,
            "name": "payment"
        }
    ],
    "description": "Alternative funding includes all types of marketpalces and softwares dedicated to the financing of SMEs or private individuals such as crowdfunding, crowdlending, consumer lending, factoring or micro credit."
}
                                    

Attributes > SectorMarket Sentiment

attributes type example description
sentiment_current object{} {} Object includes current sentiment index and sentiment
sentiment_currentindex string "1.72" Sector current sentiment index
sentiment_currentqual string "positive" Sector current sentiment
sentiment_year array[objects{}] [{}] Sector sentiment per year. Object includes year, index and sentiment
sentiment_yeardate integer 2019 Selected year
sentiment_yearindex string "0.005670823564287275" Sector index at selected year
sentiment_yearqual string "positive" Sector sentiment at selected year
sentiment_period array[objects{}] [{}] Sector sentiment per day. Object includes YYYY-MM-DD, index and sentiment
sentiment_perioddate string "2019-01-02" Selected day
sentiment_periodindex string "0.005670823564287275" Sector index at selected day
sentiment_periodqual string "positive" Sector sentiment at selected day
{
    "sentiment_current": {
        "index": "1.72",
        "qual": "positive"
    },
    "sentiment_year": [
        {
            "date": 2019,
            "index": "0.065846581555155484"
            "qual": "positive"
        },
        {
            "date": 2018,
            "index": "0.065846581555155484"
            "qual": "positive"
        }
    ],
    "sentiment_period": [
        {
            "date": "2019-01-02",
            "index": "0.006459482652625398",
            "qual": "positive"
        },
        {
            "date": "2019-01-01",
            "index": "0.065846581555155484",
            "qual": "positive"
        }
    ]
}                                   
                                    

Attributes > SectorMedia Intelligence

attributes type example description
noise_total_news integer 1569 Total sector news coverage
noise_fromLastWeek object{} {} Object includes sector news coverage index and evolution from last week
noise_fromLastWeekindex string "-72.53" Sector news coverage index from last week
noise_fromLastWeekqual string "down" Sector news coverage evolution from last week
noise_year array[objects{}] [{}] Sector total post per year. Object includes year YYYY and total post, descending
noise_yeardate integer 2019 Selected year
noise_yeartotal integer 255 Sector total post at selected year
noise_period array[objects{}] [{}] Sector total post per day. Object includes date YYYY-MM-DD and total post, descending
noise_perioddate string "2019-01-02" Selected day
noise_periodtotal integer 19 Sector total post at selected day
{
    "noise_total_news": 1569,
    "noise_fromLastWeek": {
        "index": "-72.53,"
        "qual": "down"
    } 
    "noise_year": [
        {
            "date": 2019,
            "total": 255
        },
        {
            "date": 2018,
            "total": 2423
        }
    ]
    "noise_period": [
        {
            "date": "2019-01-02",
            "total": 19
        },
        {
            "date": "2019-01-01",
            "total": 15
        }
    ]
}  
                                    

Attributes > SectorNetwork

attributes type example description
company_relationship array[objects{}] [{}] Object includes company relation ID, company relation name, relation type name, relation type ID and relation weight
company_relationshipid integer 2871 Related company ID
company_relationshipname string "Starling Bank" Related company name
company_relationshiptype_id integer 1 Relation type ID
company_relationshiptype string "competitor" Relation type name
company_relationshipstrength string "162.00" Relation weight
{
    "company_relationship" [
        {
            "id": 1166,
            "name": "N26",
            "type_id": 1,
            "type": "competitor",
            "strength": "162.00"
        },
        {
            "id": 2871,
            "name": "Starling Bank",
            "type_id": 1,
            "type": "competitor",
            "strength": "1.23"
        }
    ]
}
                                    

Attributes > SectorFunding

attributes type example description
funding_total object{} {} Object includes total amount raised, total number of funding rounds, total number of investors and investors name
funding_totalamount string "336900000.00" Total amount raised
funding_totalcount integer 13 Total number of funding rounds
funding_totalinvestors_count integer 28 Total number of investors
funding_totalinvestors array[strings] ["Sprints Capital", "Socii Capital"] Array of investors name
funding_item array[objects{}] [{}] Object includes funding single ID, date, amount, type, news, total number of investors, investors name and total number of news
funding_itemid integer 237 Funding single ID
funding_itemdate string "2018-04-26" Funding single date
funding_itemamount string "250000000.00" Funding single amount
funding_itemtype string "Series C" Funding single type
funding_itemdescription string "Digital-Banking Startup Revolut Is Worth $1.7 Billion With New Funding" Funding single news
funding_iteminvestors_count integer 9 Total number of investors
funding_iteminvestors array[strings] ["Sprints Capital", "Socii Capital"] Array of investors name
funding_itemtotal_news integer 43 Total number of news
 {
    "funding_total": {
        "amount": "336900000.00",
        "count": 13,
        "investors_count": 28,
        "investors": [
            "DST Global", 
            "Ribbit Capital"
        ]
    },
    "funding_item": [
        {
            "id": 237,
            "date": "2018-04-26",
            "amount: "250000000.00",
            "type": "Series C",
            "description": "Digital-Banking Startup Revolut Is Worth $1.7 Billion With New Funding",
            "investors_count": 9,
            "investors": [
                "Sprints Capital", 
                "Socii Capital"
            ],
            "total_news": 43
        },
        {
            "id": 195,
            "date": 2017-07-11,
            "amount: "66000000.00",
            "type": Series B,
            "description": "UK fintech start-up Revolut raises $66 million, adds bitcoin",
            "investors_count": 4,
            "investors": [
                "Index Ventures", 
                "Ribbit Capital"
            ],
            "total_news": 21
        }
    ]   
 }                    
                                    

AttributesCountry

Attributes > CountryProfile

attributes type example description
id integer 1 Country ID
name string "France" Current country name
total_companySameCountry integer 566 Total company same country
related_sector array[objects{}] [{}] Sector related to country, ordered by strength, descending
related_sectorid integer 11 Related sector id
related_sectorname string "alternative founding" Related sector name
associated_tags array[objects{}] [{}] Tags associated to topic
associated_tagsid integer 12 Associated tag id
associated_tagsname string "neobank" Associated tag name
description string "France is among leading FinTech hubs in (...)" Country description
{
    "id": 1,
    "name": "France",
    "total_companySameSector": 566,
    "related_sector": [    
        {
            "id": 11,
            "name": "alternative founding"
        },
        {
            "id": 15,
            "name": "neobank"
        }
    ],
    "associated_tags": [
        {
            "id": 12,
            "name": "neobank"
        },
        {
            "id": 16,
            "name": "payment"
        }
    ],
    "description": "France is among leading FinTech hubs in europe both in number of start-ups headquartered in the country and the amount of VC investment being investment in these new business models. The current french government and regulators are very supportive to the rise of emerging players in the banking and insurance industry."
}
                                    

Attributes > CountryMarket Sentiment

attributes type example description
sentiment_current object{} {} Object includes current sentiment index and sentiment
sentiment_currentindex string "1.72" Country current sentiment index
sentiment_currentqual string "positive" Country current sentiment
sentiment_year array[objects{}] [{}] Country sentiment per year. Object includes year, index and sentiment
sentiment_yeardate integer 2019 Selected year
sentiment_yearindex string "0.005670823564287275" Country index at selected year
sentiment_yearqual string "positive" Country sentiment at selected year
sentiment_period array[objects{}] [{}] Country sentiment per day. Object includes YYYY-MM-DD, index and sentiment
sentiment_perioddate string "2019-01-02" Selected day
sentiment_periodindex string "0.005670823564287275" Country index at selected day
sentiment_periodqual string "positive" Country sentiment at selected day
{
    "sentiment_current": {
        "index": "1.72",
        "qual": "positive"
    },
    "sentiment_year": [
        {
            "date": 2019,
            "index": "0.065846581555155484"
            "qual": "positive"
        },
        {
            "date": 2018,
            "index": "0.065846581555155484"
            "qual": "positive"
        }
    ],
    "sentiment_period": [
        {
            "date": "2019-01-02",
            "index": "0.006459482652625398",
            "qual": "positive"
        },
        {
            "date": "2019-01-01",
            "index": "0.065846581555155484",
            "qual": "positive"
        }
    ]
}                                   
                                    

Attributes > CountryMedia Intelligence

attributes type example description
noise_total_news integer 1569 Total country news coverage
noise_fromLastWeek object{} {} Object includes country news coverage index and evolution from last week
noise_fromLastWeekindex string "-72.53" Country news coverage index from last week
noise_fromLastWeekqual string "down" Country news coverage evolution from last week
noise_year array[objects{}] [{}] Country total post per year. Object includes year YYYY and total post, descending
noise_yeardate integer 2019 Selected year
noise_yeartotal integer 255 Country total post at selected year
noise_period array[objects{}] [{}] Country total post per day. Object includes date YYYY-MM-DD and total post, descending
noise_perioddate string "2019-01-02" Selected day
noise_periodtotal integer 19 Country total post at selected day
{
    "noise_total_news": 1569,
    "noise_fromLastWeek": {
        "index": "-72.53,"
        "qual": "down"
    } 
    "noise_year": [
        {
            "date": 2019,
            "total": 255
        },
        {
            "date": 2018,
            "total": 2423
        }
    ]
    "noise_period": [
        {
            "date": "2019-01-02",
            "total": 19
        },
        {
            "date": "2019-01-01",
            "total": 15
        }
    ]
}  
                                    

Attributes > CountryNetwork

attributes type example description
company_relationship array[objects{}] [{}] Object includes company relation ID, company relation name, relation type name, relation type ID and relation weight
company_relationshipid integer 2871 Related company ID
company_relationshipname string "Starling Bank" Related company name
company_relationshiptype_id integer 1 Relation type ID
company_relationshiptype string "competitor" Relation type name
company_relationshipstrength string "162.00" Relation weight
{
    "company_relationship" [
        {
            "id": 1166,
            "name": "N26",
            "type_id": 1,
            "type": "competitor",
            "strength": "162.00"
        },
        {
            "id": 2871,
            "name": "Starling Bank",
            "type_id": 1,
            "type": "competitor",
            "strength": "1.23"
        }
    ]
}
                                    

Attributes > CountryFunding

attributes type example description
funding_total object{} {} Object includes total amount raised, total number of funding rounds, total number of investors and investors name
funding_totalamount string "336900000.00" Total amount raised
funding_totalcount integer 13 Total number of funding rounds
funding_totalinvestors_count integer 28 Total number of investors
funding_totalinvestors array[strings] ["Sprints Capital", "Socii Capital"] Array of investors name
funding_item array[objects{}] [{}] Object includes funding single ID, date, amount, type, news, total number of investors, investors name and total number of news
funding_itemid integer 237 Funding single ID
funding_itemdate string "2018-04-26" Funding single date
funding_itemamount string "250000000.00" Funding single amount
funding_itemtype string "Series C" Funding single type
funding_itemdescription string "Digital-Banking Startup Revolut Is Worth $1.7 Billion With New Funding" Funding single news
funding_iteminvestors_count integer 9 Total number of investors
funding_iteminvestors array[strings] ["Sprints Capital", "Socii Capital"] Array of investors name
funding_itemtotal_news integer 43 Total number of news
 {
    "funding_total": {
        "amount": "336900000.00",
        "count": 13,
        "investors_count": 28,
        "investors": [
            "DST Global", 
            "Ribbit Capital"
        ]
    },
    "funding_item": [
        {
            "id": 237,
            "date": "2018-04-26",
            "amount: "250000000.00",
            "type": "Series C",
            "description": "Digital-Banking Startup Revolut Is Worth $1.7 Billion With New Funding",
            "investors_count": 9,
            "investors": [
                "Sprints Capital", 
                "Socii Capital"
            ],
            "total_news": 43
        },
        {
            "id": 195,
            "date": 2017-07-11,
            "amount: "66000000.00",
            "type": Series B,
            "description": "UK fintech start-up Revolut raises $66 million, adds bitcoin",
            "investors_count": 4,
            "investors": [
                "Index Ventures", 
                "Ribbit Capital"
            ],
            "total_news": 21
        }
    ]   
 }                    
                                    

AttributesTopic

Attributes > TopicProfile

attributes type example description
id integer 81 Topic ID
name string "software" Current topic name
total_companysametopic integer 3096 Total company same topic
related_sector array[objects{}] [{}] Sector related to country, ordered by strength, descending
related_sectorid integer 11 Related sector id
related_sectorname string "alternative founding" Related sector name
associated_tags array[objects{}] [{}] Tags associated to topic
associated_tagsid integer 12 Associated tag id
associated_tagsname string "neobank" Associated tag name
{
    "id": 81,
    "name": "software",
    "total_companysametopic": 3096,
    "related_sector": [    
        {
            "id": 11,
            "name": "alternative founding"
        },
        {
            "id": 15,
            "name": "neobank"
        }
    ],
    "associated_tags": [
        {
            "id": 12,
            "name": "neobank"
        },
        {
            "id": 16,
            "name": "payment"
        }
    ]
}
                                    

Attributes > TopicMarket Sentiment

attributes type example description
sentiment_current object{} {} Object includes current sentiment index and sentiment
sentiment_currentindex string "1.72" Topic current sentiment index
sentiment_currentqual string "positive" Topic current sentiment
sentiment_year array[objects{}] [{}] Topic sentiment per year. Object includes year, index and sentiment
sentiment_yeardate integer 2019 Selected year
sentiment_yearindex string "0.005670823564287275" Topic index at selected year
sentiment_yearqual string "positive" Topic sentiment at selected year
sentiment_period array[objects{}] [{}] Topic sentiment per day. Object includes YYYY-MM-DD, index and sentiment
sentiment_perioddate string "2019-01-02" Selected day
sentiment_periodindex string "0.005670823564287275" Topic index at selected day
sentiment_periodqual string "positive" Topic sentiment at selected day
{
    "sentiment_current": {
        "index": "1.72",
        "qual": "positive"
    },
    "sentiment_year": [
        {
            "date": 2019,
            "index": "0.065846581555155484"
            "qual": "positive"
        },
        {
            "date": 2018,
            "index": "0.065846581555155484"
            "qual": "positive"
        }
    ],
    "sentiment_period": [
        {
            "date": "2019-01-02",
            "index": "0.006459482652625398",
            "qual": "positive"
        },
        {
            "date": "2019-01-01",
            "index": "0.065846581555155484",
            "qual": "positive"
        }
    ]
}                                   
                                    

Attributes > TopicMedia Intelligence

attributes type example description
noise_total_news integer 1569 Total topic news coverage
noise_fromLastWeek object{} {} Object includes topic news coverage index and evolution from last week
noise_fromLastWeekindex string "-72.53" Topic news coverage index from last week
noise_fromLastWeekqual string "down" Topic news coverage evolution from last week
noise_year array[objects{}] [{}] Topic total post per year. Object includes year YYYY and total post, descending
noise_yeardate integer 2019 Selected year
noise_yeartotal integer 255 Topic total post at selected year
noise_period array[objects{}] [{}] Topic total post per day. Object includes date YYYY-MM-DD and total post, descending
noise_perioddate string "2019-01-02" Selected day
noise_periodtotal integer 19 Topic total post at selected day
{
    "noise_total_news": 1569,
    "noise_fromLastWeek": {
        "index": "-72.53,"
        "qual": "down"
    } 
    "noise_year": [
        {
            "date": 2019,
            "total": 255
        },
        {
            "date": 2018,
            "total": 2423
        }
    ]
    "noise_period": [
        {
            "date": "2019-01-02",
            "total": 19
        },
        {
            "date": "2019-01-01",
            "total": 15
        }
    ]
}  
                                    

Attributes > TopicNetwork

attributes type example description
company_relationship array[objects{}] [{}] Object includes company relation ID, company relation name, relation type name, relation type ID and relation weight
company_relationshipid integer 2871 Related company ID
company_relationshipname string "Starling Bank" Related company name
company_relationshiptype_id integer 1 Relation type ID
company_relationshiptype string "competitor" Relation type name
company_relationshipstrength string "162.00" Relation weight
{
    "company_relationship" [
        {
            "id": 1166,
            "name": "N26",
            "type_id": 1,
            "type": "competitor",
            "strength": "162.00"
        },
        {
            "id": 2871,
            "name": "Starling Bank",
            "type_id": 1,
            "type": "competitor",
            "strength": "1.23"
        }
    ]
}
                                    

Attributes > TopicFunding

attributes type example description
funding_total object{} {} Object includes total amount raised, total number of funding rounds, total number of investors and investors name
funding_totalamount string "336900000.00" Total amount raised
funding_totalcount integer 13 Total number of funding rounds
funding_totalinvestors_count integer 28 Total number of investors
funding_totalinvestors array[strings] ["Sprints Capital", "Socii Capital"] Array of investors name
funding_item array[objects{}] [{}] Object includes funding single ID, date, amount, type, news, total number of investors, investors name and total number of news
funding_itemid integer 237 Funding single ID
funding_itemdate string "2018-04-26" Funding single date
funding_itemamount string "250000000.00" Funding single amount
funding_itemtype string "Series C" Funding single type
funding_itemdescription string "Digital-Banking Startup Revolut Is Worth $1.7 Billion With New Funding" Funding single news
funding_iteminvestors_count integer 9 Total number of investors
funding_iteminvestors array[strings] ["Sprints Capital", "Socii Capital"] Array of investors name
funding_itemtotal_news integer 43 Total number of news
 {
    "funding_total": {
        "amount": "336900000.00",
        "count": 13,
        "investors_count": 28,
        "investors": [
            "DST Global", 
            "Ribbit Capital"
        ]
    },
    "funding_item": [
        {
            "id": 237,
            "date": "2018-04-26",
            "amount: "250000000.00",
            "type": "Series C",
            "description": "Digital-Banking Startup Revolut Is Worth $1.7 Billion With New Funding",
            "investors_count": 9,
            "investors": [
                "Sprints Capital", 
                "Socii Capital"
            ],
            "total_news": 43
        },
        {
            "id": 195,
            "date": 2017-07-11,
            "amount: "66000000.00",
            "type": Series B,
            "description": "UK fintech start-up Revolut raises $66 million, adds bitcoin",
            "investors_count": 4,
            "investors": [
                "Index Ventures", 
                "Ribbit Capital"
            ],
            "total_news": 21
        }
    ]   
 }                    
                                    

AttributesPeople

Attributes > PeopleProfile

attributes type example description
id integer 1 People ID
name string "Nikolay Storonsky" Current people name
photo string "https://****/img/nikolay-storonsky.jpg" People picture URL
type object{} {} People type. Object includes type name and ID
typeid integer 1 People type ID
typename string "founder" People type name
company object{} {} People company. Object includes company id and name
companyid integer 1202 People company Id
companyname string "Revolut" People company name
job string "founder" People job
associated_tags array[objects{}] [{}] Tags associated to people
associated_tagsid integer 12 Associated tag id
associated_tagsname string "neobank" Associated tag name
twitter object{} {} Object includes name and Twitter account URL
twittername string "Nik Storonsky" People Twitter account name
twitterurl string "https://twitter.com/nstoronsky" People Twitter account URL
linkedin object{} {} Object includes name and LinkedIn account URL
linkedinname string "Nik Storonsky" Company Linkedin account name
linkedinurl string "https://www.linkedin.com/nstoronsky/" People Linkedin account link
{
    "id": 1,
    "name": "Nikolay Storonsky",
    "photo": "https://****/img/nikolay-storonsky.jpg"
    "type": {
        "id": "1",
        "name": "founder"
    },
    "company": {
        "id": "1202",
        "name": "Revolut"
    },
    "job": "founder"
    "associated_tags": [
        {
            "id": 12,
            "name": "neobank"
        },
        {
            "id": 16,
            "name": "payment"
        }
    ],

    "twitter": {
        "name": "Nik Storonsky",
        "url": "https://twitter.com/nstoronsky"
    },
    "linkedin": {
        "name": "Nik Storonsky",
        "url": "https://www.linkedin.com/nstoronsky/"
    }
}
                                    

Attributes > PeopleMarket Sentiment

attributes type example description
sentiment_current object{} {} Object includes current sentiment index and sentiment
sentiment_currentindex string "1.72" People current sentiment index
sentiment_currentqual string "positive" People current sentiment
sentiment_year array[objects{}] [{}] People sentiment per year. Object includes year, index and sentiment
sentiment_yeardate integer 2019 Selected year
sentiment_yearindex string "0.005670823564287275" People index at selected year
sentiment_yearqual string "positive" People sentiment at selected year
sentiment_period array[objects{}] [{}] People sentiment per day. Object includes YYYY-MM-DD, index and sentiment
sentiment_perioddate string "2019-01-02" Selected day
sentiment_periodindex string "0.005670823564287275" People index at selected day
sentiment_periodqual string "positive" People sentiment at selected day
{
    "sentiment_current": {
        "index": "1.72",
        "qual": "positive"
    },
    "sentiment_year": [
        {
            "date": 2019,
            "index": "0.065846581555155484"
            "qual": "positive"
        },
        {
            "date": 2018,
            "index": "0.065846581555155484"
            "qual": "positive"
        }
    ],
    "sentiment_period": [
        {
            "date": "2019-01-02",
            "index": "0.006459482652625398",
            "qual": "positive"
        },
        {
            "date": "2019-01-01",
            "index": "0.065846581555155484",
            "qual": "positive"
        }
    ]
}                                   
                                    

Attributes > PeopleMedia Intelligence

attributes type example description
noise_total_news integer 1569 Total people news coverage
noise_fromLastWeek object{} {} Object includes people news coverage index and evolution from last week
noise_fromLastWeekindex string "-72.53" People news coverage index from last week
noise_fromLastWeekqual string "down" People news coverage evolution from last week
noise_year array[objects{}] [{}] People total post per year. Object includes year YYYY and total post, descending
noise_yeardate integer 2019 Selected year
noise_yeartotal integer 255 People total post at selected year
noise_period array[objects{}] [{}] People total post per day. Object includes date YYYY-MM-DD and total post, descending
noise_perioddate string "2019-01-02" Selected day
noise_periodtotal integer 19 People total post at selected day
{
    "noise_total_news": 1569,

    "noise_fromLastWeek": {
        "index": "-72.53,"
        "qual": "down"
    } 
    "noise_year": [
        {
            "date": 2019,
            "total": 255
        },
        {
            "date": 2018,
            "total": 2423
        }
    ]
    "noise_period": [
        {
            "date": "2019-01-02",
            "total": 19
        },
        {
            "date": "2019-01-01",
            "total": 15
        }
    ]
}  
                                    

Attributes > PeopleNetwork

attributes type example description
company_relationship array[objects{}] [{}] Object includes company relation ID, company relation name, relation type name, relation type ID and relation weight
company_relationshipid integer 2871 Related company ID
company_relationshipname string "Starling Bank" Related company name
company_relationshiptype_id integer 1 Relation type ID
company_relationshiptype string "competitor" Relation type name
company_relationshipstrength string 2.23 Relation weight
people_relationship array[objects{}] [{}] La liste d'objet contient l'id de la personnalité en lien, son nom, son type de relation, l'id du type de relation, et la force du lien.
people_relationshipid integer 254 Related company ID
people_relationshipname string "Marco Rodzynek" Related company name
people_relationshiptype_id integer 1 Relation type ID
people_relationshiptype string "investor" Relation type name
people_relationshipstrength string "1.56" Relation weight
{
    "company_relationship" [
        {
            "id": 1166,
            "name": "N26",
            "type_id": 1,
            "type": "competitor",
            "strength": "1.62"
        },
        {
            "id": 2871,
            "name": "Starling Bank",
            "type_id": 1,
            "type": "competitor",
            "strength": "0.65"
        }
    ],
    "people_relationship" [
        {
            "id": 32,
            "name": "Maximilian Tayenthal",
            "type_id": 3,
            "type": "cofounder",
            "strength": "2.23"
        },
        {
            "id": 254,
            "name": "Marco Rodzynek",
            "type_id": 1,
            "type": "investor",
            "strength": "1.56"
        }
    ]
}
                                    

Code snippets

Code snippetsAuthentification


#PYTHON V3
#!/usr/bin/python3

import requests
import json
url = 'https://api.invyo.io/getSectorEntity'
params = {"authenticationKey":KEY,
         "authenticationSecret":SECRET,
         "id":id,
         "d1":d1,
         "d2":d2}
r = requests.post(url, data=params)
print(r.json())
                                            
#Node.js
#PHP

Code snippetsRequests

#PYTHON
                                            
#Node.js
#PHP

Contact Us

We are constantly improving this documentation. If you have any question, please contact us through the chat on the bottom right of your screen or via hello@invyo.io.