Skip to main content
POST
/
v1
/
search
/
co-mentions
/
entities
Entities co-mentions
curl --request POST \
  --url https://api.bigdata.com/v1/search/co-mentions/entities \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "query": {
    "text": "Tariffs impact in China",
    "filters": {
      "timestamp": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "document_type": {
        "mode": "INCLUDE",
        "values": [
          "NEWS"
        ]
      },
      "source": {
        "mode": "INCLUDE",
        "values": [
          "ED68DC"
        ]
      },
      "keyword": {
        "all_of": [],
        "any_of": [],
        "none_of": [
          "operating"
        ]
      },
      "entity": {
        "all_of": [],
        "any_of": [
          "228D42"
        ],
        "none_of": []
      },
      "sentiment": {
        "values": [
          "positive",
          "negative",
          "neutral"
        ]
      }
    },
    "limit": 1000
  }
}'
{
  "results": {
    "places": [
      {
        "id": "13FF12",
        "name": "China",
        "description": "The People's Republic of China is a country located in East Asia.",
        "volume": 3095,
        "type": "Country",
        "continent": "Asia",
        "country": "CN",
        "total_chunks_count": 3095,
        "total_titles_count": 775
      }
    ],
    "companies": [
      {
        "id": "275B6C",
        "name": "Build-A-Bear Workshop Inc.",
        "description": "Build-A-Bear Workshop Inc. was founded in the United States in 1997...",
        "type": "PUBLIC",
        "country": "US",
        "sector": "Consumer Goods",
        "industry_group": "Leisure Goods",
        "industry": "Toys",
        "favicon": "http://www.buildabear.com/favicon.ico",
        "webpage": "http://www.buildabear.com",
        "isin_values": [
          "US1200761047"
        ],
        "cusip_values": [
          "120076104"
        ],
        "sedol_values": [
          "B034L50"
        ],
        "listing_values": [
          "XNYS:BBW"
        ],
        "ticker": "BBW",
        "volume": 0,
        "total_chunks_count": 0,
        "total_titles_count": 105
      }
    ],
    "organizations": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "volume": 123,
        "total_chunks_count": 123,
        "total_titles_count": 123
      }
    ],
    "people": [
      {
        "id": "22C3AF",
        "name": "Donald Trump",
        "description": "Donald Trump (born June 14, 1946) is an American business owner and politician...",
        "volume": 730,
        "position": "President",
        "employer": "Government of the United States",
        "nationality": "American",
        "gender": "Male",
        "total_chunks_count": 730,
        "total_titles_count": 386
      }
    ],
    "products": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "volume": 123,
        "total_chunks_count": 123,
        "total_titles_count": 123
      }
    ],
    "concepts": [
      {
        "id": "9DB5BD",
        "name": "Tariff",
        "description": "Tariff is a tax imposed by one country on the goods and services imported from another country.",
        "category": "Concepts",
        "volume": 3604,
        "type_name": "Economics",
        "total_chunks_count": 3604,
        "total_titles_count": 1223
      }
    ]
  },
  "metadata": {
    "request_id": "0f763fb3-4957-430a-acf6-5d4fc6b5109d",
    "timestamp": "2025-10-02T15:25:28.214117+00:00"
  },
  "usage": {
    "api_query_units": 1
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
query
object
required

Response

200 - application/json

Entities co-mentions results

results
object
required

Object containing arrays of different entity types that are co-mentioned with the search query.

metadata
object

Request metadata and timing information.

usage
object

API usage information for the request.