Skip to main content
POST
/
v1
/
search
/
co-mentions
/
entities
Connected Entities
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"
        ]
      },
      "reporting_entities": [
        "228D42"
      ],
      "reporting_periods": [
        {
          "fiscal_year": 2024,
          "fiscal_quarter": 3
        }
      ],
      "topic": {
        "all_of": [],
        "any_of": [
          "business,stock-prices,stock-price-volatility,down,"
        ],
        "none_of": []
      }
    },
    "limit": 10
  }
}'
{
  "results": {
    "places": [
      {
        "id": "13FF12",
        "total_chunks_count": 92468,
        "total_headlines_count": 24049
      }
    ],
    "companies": [
      {
        "id": "275B6C",
        "total_chunks_count": 0,
        "total_headlines_count": 105
      }
    ],
    "organizations": [
      {
        "id": "1BC945",
        "total_chunks_count": 17812,
        "total_headlines_count": 2427
      }
    ],
    "people": [
      {
        "id": "22C3AF",
        "total_chunks_count": 29883,
        "total_headlines_count": 22536
      }
    ],
    "products": [
      {
        "id": "<string>",
        "total_chunks_count": 123,
        "total_headlines_count": 123
      }
    ],
    "concepts": [
      {
        "id": "9DB5BD",
        "total_chunks_count": 106720,
        "total_headlines_count": 44591
      }
    ]
  },
  "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.

⌘I