Skip to main content
POST
/
v1
/
search
/
volume
Search volume
curl --request POST \
  --url https://api.bigdata.com/v1/search/volume \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "query": {
    "text": "Type a theme to get volume stats...."
  }
}
'
{
  "results": {
    "volume": [
      {
        "date": "2025-01-01",
        "documents": 164,
        "chunks": 387,
        "sentiment": -0.15
      }
    ],
    "total": {
      "documents": 3440,
      "chunks": 8196,
      "sentiment": -0.18
    }
  },
  "metadata": {
    "request_id": "473d22ea-7753-41d8-825a-4a4c7696f8cb",
    "timestamp": "2025-12-15T17:34:34.181589+00:00"
  },
  "usage": {
    "api_query_units": 1
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
query
object
required

Response

200 - application/json

Volume search results

results
object
required

Volume statistics aggregated by date and totals.

metadata
object

Request metadata and timing information.

usage
object

API usage information for the request.