About Index Trending news
Lists
Pricing

About Index

Index Integrations

Index API Documentation

Obtaining an API key

Head to https://index.co/integrations/api for more info.

Authentication and security

Authentication is perform with HTTP Basic authentication, simply provide a user and password (your API token) with the request: curl https://$USER:$TOKEN@index.co/api/v1

All calls MUST be made over HTTPS.

Rate limiting

You can make 60 request per minute, get in touch if you need a higher rate limit.

A HTTP/1.1 429 Too Many Requests will be served if the rate limit is exceeded. You can inspect the X-RateLimit-Limit,X-RateLimit-Remaining and Retry-After headers to see how you are doing. The time frame is 1 minute, the retry time is in seconds.

Call quota

Depending on your API plan, there is a maximum number of calls you can make each month. Check your API dashboard for details, and keep an eye out for HTTP 402: Payment Required messages.

API specifics

  • Many entities return a web_url and api_url, you can follow those to get more details.
  • The id field of entities is immutable. The web_url can incidentally change, so do not rely on it.
  • Some lists of entities are returned as a whole, others are paginated. Check the resource docs below for details. Return type array means all the data is there, Page means the data is paginated, and will tell you how to traverse the whole list.
  • Datetime format is 2012-06-27 17:30:10, UTC time. Date format is 2012-06-27.
  • Nested data is returned for your convenience. E.g. all funding events including their investors and coverage is returned on a simple company call. Nested data may be paginated, in that case the first page is returned.

Resource docs:

Acquisition

Stability: prototype

Acquisition details

Attributes

Name Type Description Example
acquiree Company party being acquired {"id":4,"name":"SmallCorp","...":"..."}
acquirer Company party making the acquisition {"id":3,"name":"BigCorp","...":"..."}
amount integer acquisition price in local currency 100000000
amount_USD integer acquisition price in USD 120000000
coverage array[Article] coverage on this investment [{"url":"http://news.co/153","title":"...","excerpt":"..."},"..."]
currency string acquisition price currency "EUR"
date date date of the funding event "2012-04-03"
id integer unique identifier of the acquisition 42
updated_at datetime when acquisition was updated "2012-07-28 15:00:12"
verified boolean verified by Index content team true

Article

Stability: prototype

news articles on an event

Attributes

Name Type Description Example
excerpt string excerpt "You can now access all Index data via a read only API, get started at https://index.co/integrations/api"
localization string ISO2 code of source's country, if the article is not in English "NL"
title string article title "Index.co launches their official API"
url string full url "https://updates.index.co/2016/05/index-launches-api"

City

Stability: prototype

City details

Attributes

Name Type Description Example
companies Page companies headquartered in this city (paginated) {"total":120,"per_page":50,"...":"...","data":[{"id":12,"name":"Amazon","...":"..."},"..."]}
country Country country in which this city is located {"id":30,"name":"The Netherlands"}
id integer unique identifier of the city 42
name string city name "Amsterdam"

City Info

Info for existing company.

GET /city/{city_id}

Curl Example

$ curl -n https://$USER:$TOKEN@index.co/api/v1/city/$CITY_ID

Response Example

HTTP/1.1 200 OK
{
  "id": 42,
  "name": "Amsterdam",
  "country": {
    "id": 30,
    "name": "The Netherlands"
  },
  "companies": {
    "total": 120,
    "per_page": 50,
    "...": "...",
    "data": [
      {
        "id": 12,
        "name": "Amazon",
        "...": "..."
      },
      "..."
    ]
  }
}

City List

List existing companies.

GET /cities

Curl Example

$ curl -n https://$USER:$TOKEN@index.co/api/v1/cities

Response Example

HTTP/1.1 200 OK
[
  {
    "id": 42,
    "name": "Amsterdam",
    "country": {
      "id": 30,
      "name": "The Netherlands"
    },
    "companies": {
      "total": 120,
      "per_page": 50,
      "...": "...",
      "data": [
        {
          "id": 12,
          "name": "Amazon",
          "...": "..."
        },
        "..."
      ]
    }
  }
]

Company

Stability: prototype

Company details

Attributes

Name Type Description Example
acquirees Page acquisitions of this company
acquirers array[Acquisition] acquisitions this company was target of
avatar string profile image of the company "https://index.tnwcdn.com/images/dbb2d3373006a3612.png"
canonical_url string domain of the company "thenextweb.com"
city City city the company is headquartered in {"id":30,"name":"Amsterdam"}
country Country country the company is headquartered in {"id":30,"name":"The Netherlands"}
funding array[Investment] funding received
id integer unique identifier of the company 42
investments Page investments made by this company
linkedin_user string LinkedIn username of the company, https://linkedin.com/organization/username "indexdotco"
markets array[Market] list of markets [{"id":21,"name":"Music"},"..."]
name string name of the company "The Next Web"
tagline string tagline of the company "News, conference, data and curated workspaces"
twitter_user string @twitter username "indexdotco"
updated_at datetime when company was updated "2012-07-28 15:00:12"

Company Info

Info for existing company.

GET /companies/{company_id}

Curl Example

$ curl -n https://$USER:$TOKEN@index.co/api/v1/companies/$COMPANY_ID

Response Example

HTTP/1.1 200 OK
{
  "id": 42,
  "updated_at": "2012-07-28 15:00:12",
  "name": "The Next Web",
  "canonical_url": "thenextweb.com",
  "tagline": "News, conference, data and curated workspaces",
  "avatar": "https://index.tnwcdn.com/images/dbb2d3373006a3612.png",
  "twitter_user": "indexdotco",
  "linkedin_user": "indexdotco",
  "funding": null,
  "investments": null,
  "acquirers": null,
  "acquirees": null,
  "markets": [
    {
      "id": 21,
      "name": "Music"
    },
    "..."
  ],
  "country": {
    "id": 30,
    "name": "The Netherlands"
  },
  "city": {
    "id": 30,
    "name": "Amsterdam"
  }
}

Country

Stability: prototype

Country details

Attributes

Name Type Description Example
cities array[City] all Indexed cities in this country
companies Page companies headquartered in this country (paginated) {"total":120,"per_page":50,"...":"...","data":[{"id":12,"name":"Amazon","...":"..."},"..."]}
full_name string full name "United States of America"
id integer unique identifier of the country 42
name string name "United States"
region string continent of land mass "Americas"
subregion string continent or subcontinent "Northern America"

Country Info

Info for existing company.

GET /country/{country_id}

Curl Example

$ curl -n https://$USER:$TOKEN@index.co/api/v1/country/$COUNTRY_ID

Response Example

HTTP/1.1 200 OK
{
  "id": 42,
  "name": "United States",
  "full_name": "United States of America",
  "region": "Americas",
  "subregion": "Northern America",
  "cities": null,
  "companies": {
    "total": 120,
    "per_page": 50,
    "...": "...",
    "data": [
      {
        "id": 12,
        "name": "Amazon",
        "...": "..."
      },
      "..."
    ]
  }
}

Country List

List existing companies.

GET /countries

Curl Example

$ curl -n https://$USER:$TOKEN@index.co/api/v1/countries

Response Example

HTTP/1.1 200 OK
[
  {
    "id": 42,
    "name": "United States",
    "full_name": "United States of America",
    "region": "Americas",
    "subregion": "Northern America",
    "cities": null,
    "companies": {
      "total": 120,
      "per_page": 50,
      "...": "...",
      "data": [
        {
          "id": 12,
          "name": "Amazon",
          "...": "..."
        },
        "..."
      ]
    }
  }
]

Investment

Stability: prototype

Investment details

Attributes

Name Type Description Example
amount integer investment in local currency 100000000
amount_USD integer investment size in USD 120000000
company Company company receiving the investment {"id":3,"name":"SmallCorp","...":"..."}
coverage array[Article] coverage on this investment [{"url":"http://news.co/153","title":"...","excerpt":"..."},"..."]
currency string investment currency "EUR"
date date date of the funding event "2012-04-03"
id integer unique identifier of the investment 42
investors array[Company/name] investors involved, either a Company, or a name-only entry [{"id":12,"name":"VC⚡DC","...":"..."},{"name":"Investors Anonymous"},"..."]
updated_at datetime when investment was updated "2012-07-28 15:00:12"
verified boolean verified by Index content team true

Market

Stability: prototype

Markets on Index form a directed, acyclic graph. That means every market can have multiple parent and children, but there will never be a cyclic reference

Attributes

Name Type Description Example
child_ids array ids of this market's children [13,46]
companies Page companies headquartered in this market (paginated) {"total":120,"per_page":50,"...":"...","data":[{"id":12,"name":"Amazon","...":"..."},"..."]}
hierachy_name string hierarchical name "Finance > Payments > Cryptocurrencies"
id integer unique identifier of the market 42
name string market name "Cryptocurrencies"
parent_ids arrayj ids of this market's parents [12,45]

Market Info

Info for existing company.

GET /market/{market_id}

Curl Example

$ curl -n https://$USER:$TOKEN@index.co/api/v1/market/$MARKET_ID

Response Example

HTTP/1.1 200 OK
{
  "id": 42,
  "name": "Cryptocurrencies",
  "hierachy_name": "Finance > Payments > Cryptocurrencies",
  "parent_ids": [
    12,
    45
  ],
  "child_ids": [
    13,
    46
  ],
  "companies": {
    "total": 120,
    "per_page": 50,
    "...": "...",
    "data": [
      {
        "id": 12,
        "name": "Amazon",
        "...": "..."
      },
      "..."
    ]
  }
}

Market List

List existing companies.

GET /markets

Curl Example

$ curl -n https://$USER:$TOKEN@index.co/api/v1/markets

Response Example

HTTP/1.1 200 OK
[
  {
    "id": 42,
    "name": "Cryptocurrencies",
    "hierachy_name": "Finance > Payments > Cryptocurrencies",
    "parent_ids": [
      12,
      45
    ],
    "child_ids": [
      13,
      46
    ],
    "companies": {
      "total": 120,
      "per_page": 50,
      "...": "...",
      "data": [
        {
          "id": 12,
          "name": "Amazon",
          "...": "..."
        },
        "..."
      ]
    }
  }
]

Paginated data

Stability: prototype

In order to efficiently deliver large quantities of data, some result sets are paginated. You can browse them with the 'page' parameter.

Attributes

Name Type Description Example
current_page integer current page 2
data array the actual data
from integer index of the first item on this page 50
last_page integer last page 5
next_page_url nullable string path to next page "https://index.co/api/v1/cities?page=3"
per_page integer items per page 50
prev_page_url nullable string path to previous page "https://index.co/api/v1/cities?page=1"
to integer index of the last item on this page 99
total integer total number of items 210

Search

Stability: prototype

Search companies, markets, countries and cities

Attributes

Name Type Description Example
avatar nullable string image corresponding to object found "https://index.tnwcdn.com/images/80x80/451947c6cedab32a6166d3efe82a0d0265c43ffc.jpg"
name string name of object found "Index"
object_id integer id of object found 210
object_type string Company, Market, City, Country "Company"
short_desc nullable string extra info on the object found "joinunitedcapital.com, Consulting, Investment Management"

Search Index

Search. The type parameter is optional . The first 25 results are returned

GET /search

Required Parameters

Name Type Description Example
q string search term, can be a (part of) a name, slug or url "index.co"

Optional Parameters

Name Type Description Example
type string filter results by type (Company, Market, City, Country) "Market"

Curl Example

$ curl -n https://$USER:$TOKEN@index.co/api/v1/search
 -G \
  -d q=index.co \
  -d type=Market

Response Example

HTTP/1.1 200 OK
{
  "object_id": 210,
  "object_type": "Company",
  "name": "Index",
  "avatar": "https://index.tnwcdn.com/images/80x80/451947c6cedab32a6166d3efe82a0d0265c43ffc.jpg",
  "short_desc": "joinunitedcapital.com, Consulting, Investment Management"
}