Skip to content
Product Documentation

List canonical players.

GET
/v1/players
curl --request GET \
  --url 'https://api.betflux.ai/v1/players?league=MLB' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
league
string
Allowed values: MLB NBA NHL NFL NCAAM
limit
integer
>= 1 <= 10000
cursor
string
team_id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Players.

Media typeapplication/json
object
data
required
Array<object>
object
id
required

Canonical player UUID (matches closing-lines *_player_ids and the player_id filter).

string
league
required

League code the player belongs to.

string
first_name
required

First name.

string
last_name
required

Last name.

string
position
required

Position code, e.g. PG, QB; null when unknown.

string | null
jersey_number
required

Current jersey number; null when unknown.

integer | null
current_team_id
required

UUID of the player’s current team; null for free agents.

string | null
is_active
required

False once the player is out of the league.

boolean
next_cursor
required
string | null
Examplegenerated
{
  "data": [
    {
      "id": "example",
      "league": "example",
      "first_name": "example",
      "last_name": "example",
      "position": "example",
      "jersey_number": 1,
      "current_team_id": "example",
      "is_active": true
    }
  ],
  "next_cursor": "example"
}

400

Section titled “400”

Validation failed — unknown or invalid query parameter, or a malformed range (problem type validation-error).

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

401

Section titled “401”

Missing, malformed, or unrecognized API key (problem type invalid-key).

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

402

Section titled “402”

The key has no entitled tier — subscription lapsed or absent (problem type subscription-required; the body carries an upgrade_url).

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

403

Section titled “403”

API key revoked or suspended (problem type key-disabled), or the requested range exceeds the tier’s history window (history-restricted).

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

429

Section titled “429”

Rate limit, monthly row quota, or ops throttle — the problem type distinguishes rate-limited, quota-exhausted, and throttled.

Media typeapplication/problem+json

RFC 9457 problem details. Dispatch on the stable type URI (https://api.betflux.ai/problems/*), never on the English title.

object
type
required

Stable problem type URI.

string
title
required

Short human-readable summary.

string
status
required

HTTP status code.

integer
detail

Explanation specific to this occurrence.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}