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>'
import requests

url = "https://api.upriver.ai/v1/entities/breakout"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.upriver.ai/v1/entities/breakout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upriver.ai/v1/entities/breakout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upriver.ai/v1/entities/breakout"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.upriver.ai/v1/entities/breakout")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.upriver.ai/v1/entities/breakout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "total_count": 123,
  "entities": [
    {
      "entity_id": "<string>",
      "name": "<string>",
      "entity_type": "<string>",
      "score": 123,
      "velocity": 123,
      "trend_direction": "<string>",
      "last_activity_at": "2023-11-07T05:31:56Z",
      "top_topics": [
        {
          "topic_id": "<string>",
          "name": "<string>",
          "citations": [
            {
              "source_category": "<string>",
              "source_url": "<string>",
              "title": "<string>",
              "display": ""
            }
          ],
          "source_summary": {},
          "citation_rate": [
            {
              "day": "<string>",
              "count": 123
            }
          ],
          "last_activity_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "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:recommended

Ranking mode: 'recommended' (default, balanced), 'rising' (biggest movers vs own baseline), 'top' (highest absolute volume), or 'newest' (most recently appeared). Legacy aliases (blended, hot, momentum, emerging, importance, recent, new) are accepted.

​
vertical
string
default:sports

Vertical; only 'sports'

​
tag
string | null

Filter to entities carrying this tag (e.g. a sport). Use a tag value from the /entities/breakout/tags endpoint.

​
temporal_status
enum<string> | null

Filter to entities with an event that has this timing relative to now: 'upcoming' (not yet started), 'ongoing' (in progress), or 'past'. Only entities tied to a scheduled event have a timing, so this narrows results to them and to their matching events. Filter a topic by its request-time event temporal status.

Only topics linked to a scheduled event carry a temporal status, so filtering by any of these values implicitly restricts results to event-linked topics.

Available options:
upcoming,
ongoing,
past
​
event
string | null

Filter to entities involved in a specific event, by name (e.g. 'world cup'). An unrecognized event returns no entities.

​
limit
integer
default:20

Max entities

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

Pagination offset

Required range: x >= 0
​
discovered_within_hours
integer | null

Only entities whose most recently appeared topic was first seen within this many hours (the 'brand new' filter). Omit for no limit.

Required range: 1 <= x <= 8760

Response

Successful Response

Ranked breaking entities for a vertical.

​
total_count
integer
required

Total matching entities before pagination

​
entities
EntityBreakoutResponse · object[]

Ranked breaking entities