---
canonical_url: "https://docs.composio.dev/toolkits/lumify"
markdown_url: "https://docs.composio.dev/toolkits/lumify.md"
product: "platform"
version: null
last_updated: null
---

# Lumify

Lumify provides sports schedules, live scores, odds, statistics, and explainable betting intelligence through a credit-metered API.

- **Category:** lifestyle & entertainment
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `LUMIFY`
- **Version:** 00000000_00

## Tools

### Get Credit Usage

**Slug:** `LUMIFY_GET_CREDIT_USAGE`

Get the Lumify account tier, usage, limits, trial state, and remaining credits. The response body is a pre-call snapshot and this request costs one credit. When Lumify returns X-Credits-Remaining, the result also includes the authoritative post-call balance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event Analysis

**Slug:** `LUMIFY_GET_EVENT_ANALYSIS`

Fetch selected intelligence, odds, odds history, public splits, and/or deterministic stats for one event. Each selected section makes a separate request against Lumify's 20 requests-per-minute limit. Unavailable sections are successful zero-credit results; use Plan Credit Costs before broad calls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_id` | integer | Yes | Event ID from List Events or Get Events. |
| `sections` | array | Yes | One or more unique sections to fetch. Each section makes one request: intelligence, odds, odds_history, splits, or stats. |
| `bookmaker` | string | No | Bookmaker for intelligence, odds, and odds_history. Ignored for splits and stats. |
| `odds_history_limit` | integer | No | Maximum newest-first odds movements to return when odds_history is selected (1-200). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Events

**Slug:** `LUMIFY_GET_EVENTS`

Fetch full details for 1-25 event IDs in one API request, optionally including odds or intelligence. Credits are charged per found event, duplicate IDs are billed once, and missing IDs are returned in not_found as partial success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bookmaker` | string | No | Bookmaker for included odds or intelligence. Lumify also accepts 'all' or a comma-separated bookmaker list where supported. |
| `event_ids` | array | Yes | One to 25 event IDs. Use a single-item array to fetch one event. |
| `include_odds` | boolean | No | Include current odds in each event detail when available. |
| `include_intelligence` | boolean | No | Include betting intelligence in each event detail when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event Score

**Slug:** `LUMIFY_GET_EVENT_SCORE`

Get a compact current score and status snapshot for one Lumify event. A successful available response normally costs 1 credit and consumes 1 of the connected key's 20 requests per minute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_id` | integer | Yes | Event ID from List Events or Get Events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Events

**Slug:** `LUMIFY_LIST_EVENTS`

Find scheduled, live, or historical Lumify events with structured filters and one-page cursor pagination. A successful page normally costs one credit and uses one request from the connected key's rate limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Single UTC date. Cannot be combined with from_date or to_date. |
| `limit` | integer | No | Maximum events in this page (1-100). |
| `sport` | string | No | Sport slug, such as nfl, nba, mlb, or soccer. |
| `league` | string | No | League slug within the selected sport. |
| `status` | string ("scheduled" | "inprogress" | "delayed" | "suspended" | "postponed" | "cancelled" | "final" | "walkover") | No | Event status to return. |
| `team_id` | integer | No | Team identifier returned by Search Teams. |
| `to_date` | string | No | Inclusive UTC range end. Provide with from_date; ranges may span at most 90 days. |
| `from_date` | string | No | Inclusive UTC range start. Provide with to_date and omit date. |
| `season_id` | integer | No | Season identifier returned by List Sports or Seasons. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior call. Omit for the first page. |
| `has_recommend` | boolean | No | Filter by whether Lumify has a recommendation. |
| `include_scores` | boolean | No | Inline participants and scores. Intended for result sets no larger than 200 events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Player Events

**Slug:** `LUMIFY_LIST_PLAYER_EVENTS`

List one Lumify player's schedule and results with date and status filters, returning one cursor-controlled page. A successful page normally costs one credit and uses one request from the connected key's rate limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum events in this page (1-100). |
| `status` | string | No | Event status to return, such as scheduled, inprogress, or final. |
| `to_date` | string | No | Inclusive UTC end date. |
| `from_date` | string | No | Inclusive UTC start date. |
| `player_id` | integer | Yes | Player identifier returned by Search Players. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sports or Seasons

**Slug:** `LUMIFY_LIST_SPORTS_OR_SEASONS`

List Lumify sports and leagues or seasons. Use this reference lookup before filtering events by sport, league, or season identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sport` | string | No | Sport slug to filter seasons, such as nfl, nba, mlb, or soccer. Ignored when listing sports. |
| `resource` | string ("sports" | "seasons") | Yes | Reference resource to list: sports or seasons. |
| `active_only` | boolean | No | When listing sports, return only active sports. Ignored when listing seasons. |
| `current_only` | boolean | No | When listing seasons, return only current seasons. Ignored when listing sports. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Plan Credit Costs

**Slug:** `LUMIFY_PLAN_CREDIT_COSTS`

Discover Lumify estimator tool identifiers or estimate credit ranges for up to 50 planned calls without executing them. Both modes cost zero credits but consume one request from Lumify's rate limit. Omit calls for discovery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `calls` | array | No | One to 50 planned calls to estimate. Omit this field to discover accepted provider tool identifiers and pricing groups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Players

**Slug:** `LUMIFY_SEARCH_PLAYERS`

Search Lumify players by sport, partial name, country, activity, or tennis ranking and return one cursor-controlled page. A successful page normally costs one credit and uses one request from the connected key's rate limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum players in this page (1-100). |
| `query` | string | No | Partial player name. |
| `sport` | string | No | Sport slug to filter players. |
| `active` | boolean | No | Filter by active status. |
| `ranked` | boolean | No | When true, return only players with a tennis ranking. |
| `country` | string | No | ISO alpha-3 country code. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Teams

**Slug:** `LUMIFY_SEARCH_TEAMS`

Search teams by sport, league, conference, division, country, active status, or partial team name and return one cursor-controlled page. A successful page normally costs 1 credit and consumes 1 of 20 requests per minute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum teams in this page (1-100). |
| `query` | string | No | Partial team name. |
| `sport` | string | No | Sport slug to filter teams. |
| `active` | boolean | No | Filter by active status. |
| `league` | string | No | League slug to filter teams. |
| `country` | string | No | Country filter accepted by Lumify. |
| `division` | string | No | Division name. |
| `conference` | string | No | Conference name or abbreviation. |
| `next_cursor` | string | No | Continuation cursor returned by a prior call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |