Skip to main content
GET
/
v1
/
entities
/
breakout
List Breakout Entities
curl --request GET \
  --url https://api.upriver.ai/v1/entities/breakout \
  --header 'X-API-Key: <api-key>'
{
  "total_count": 123,
  "entities": [
    {
      "entity_id": "<string>",
      "name": "<string>",
      "entity_type": "<string>",
      "score": 123,
      "velocity": 123,
      "trend_direction": "<string>",
      "top_topics": [
        {
          "topic_id": "<string>",
          "name": "<string>",
          "citations": [
            {
              "title": "<string>",
              "url": "<string>",
              "source_type": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Query Parameters

entity_type
string
required

Entity kind to rank: 'player' or 'team'

sort
string
default:blended

Ranking mode: 'rising' (biggest movers vs own baseline), 'top' (highest absolute volume), or 'blended' (default)

vertical
string
default:sports

Vertical; only 'sports'

limit
integer
default:20

Max entities

Required range: 1 <= x <= 100
offset
integer
default:0

Pagination offset

Required range: x >= 0

Response

Successful Response

Ranked breaking entities for a vertical.

total_count
integer
required

Total matching entities before pagination

entities
EntityBreakoutResponse · object[]

Ranked breaking entities